org.apache.jackrabbit.oak.segment

Interface SegmentStore

All Known Implementing Classes:

AbstractFileStore, FileStore, MemoryStore, ReadOnlyFileStore

public interface SegmentStore

The backend storage interface used by the segment node store.

Method Summary

Modifier and Type	Method and Description
boolean	containsSegment(SegmentId id) Checks whether the identified segment exists in this store.
SegmentId	newBulkSegmentId() Create a new SegmentId for a segment of type "bulk".
SegmentId	newDataSegmentId() Create a new SegmentId for a segment of type "data".
SegmentId	newSegmentId(long msb, long lsb) Create a SegmentId represented by the given MSB/LSB pair.
Segment	readSegment(SegmentId segmentId) Reads the identified segment from this store.
void	writeSegment(SegmentId id, byte[] bytes, int offset, int length) Writes the given segment to the segment store.

Method Detail

containsSegment

boolean containsSegment(SegmentId id)

Checks whether the identified segment exists in this store.

Parameters:

id - segment identifier

Returns:

true if the segment exists, false otherwise

readSegment

@Nonnull
Segment readSegment(SegmentId segmentId)

Reads the identified segment from this store.

Parameters:

segmentId - segment identifier

Returns:

identified segment, or a SegmentNotFoundException thrown if not found

writeSegment

void writeSegment(SegmentId id,
                  byte[] bytes,
                  int offset,
                  int length)
           throws IOException

Writes the given segment to the segment store.

Parameters:

id - segment identifier

bytes - byte buffer that contains the raw contents of the segment

offset - start offset within the byte buffer

length - length of the segment

Throws:

IOException

newSegmentId

@Nonnull
SegmentId newSegmentId(long msb,
                                long lsb)

Create a SegmentId represented by the given MSB/LSB pair.

Parameters:

msb - The most significant bits of the SegmentId.

lsb - The least significant bits of the SegmentId.

Returns:

A non-null instance of SegmentId.

newBulkSegmentId

@Nonnull
SegmentId newBulkSegmentId()

Create a new SegmentId for a segment of type "bulk".

Returns:

A non-null instance of SegmentId.

newDataSegmentId

@Nonnull
SegmentId newDataSegmentId()

Create a new SegmentId for a segment of type "data".

Returns:

A non-null instance of SegmentId.