org.apache.jackrabbit.oak.segment

Class SegmentId

java.lang.Object

org.apache.jackrabbit.oak.segment.SegmentId

All Implemented Interfaces:

Comparable<SegmentId>

public class SegmentId
extends Object
implements Comparable<SegmentId>

Segment identifier. There are two types of segments: data segments, and bulk segments. Data segments have a header and may reference other segments; bulk segments do not.

Constructor Summary

Constructors

Constructor and Description
SegmentId(SegmentStore store, long msb, long lsb)

Method Summary

Modifier and Type	Method and Description
UUID	asUUID()
int	compareTo(SegmentId that)
boolean	equals(Object object)
int	estimateMemoryUsage()
long	getCreationTime()
int	getGcGeneration() Get the underlying segment's gc generation.
long	getLeastSignificantBits()
long	getMostSignificantBits()
Segment	getSegment() Get the segment identified by this instance.
int	hashCode()
boolean	isBulkSegmentId() Checks whether this is a bulk segment identifier.
boolean	isDataSegmentId() Checks whether this is a data segment identifier.
static boolean	isDataSegmentId(long lsb) Checks whether this is a data segment identifier.
void	reclaimed(String gcInfo) Notify this id about the reclamation of its segment (e.g.
boolean	sameStore(SegmentStore store) Determine whether this instance belongs to the passed store
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SegmentId

public SegmentId(@Nonnull
                 SegmentStore store,
                 long msb,
                 long lsb)

Method Detail

isDataSegmentId

public static boolean isDataSegmentId(long lsb)

Checks whether this is a data segment identifier.

Returns:

true for a data segment, false otherwise

isDataSegmentId

public boolean isDataSegmentId()

Checks whether this is a data segment identifier.

Returns:

true for a data segment, false otherwise

isBulkSegmentId

public boolean isBulkSegmentId()

Checks whether this is a bulk segment identifier.

Returns:

true for a bulk segment, false otherwise

getMostSignificantBits

public long getMostSignificantBits()

getLeastSignificantBits

public long getLeastSignificantBits()

getSegment

@Nonnull
public Segment getSegment()

Get the segment identified by this instance. The segment is memoised in this instance's segment field.

Returns:

the segment identified by this instance.

See Also:

loaded(Segment), unloaded()

reclaimed

public void reclaimed(@Nonnull
                      String gcInfo)

Notify this id about the reclamation of its segment (e.g. by the garbage collector).

Parameters:

gcInfo - details about the reclamation. This information is logged along with the SegmentNotFoundException when attempting to resolve the segment of this id.

sameStore

public boolean sameStore(@Nonnull
                         SegmentStore store)

Determine whether this instance belongs to the passed store

Parameters:

store -

Returns:

true iff this instance belongs to store

getCreationTime

public long getCreationTime()

asUUID

public UUID asUUID()

Returns:

this segment id as UUID

getGcGeneration

public int getGcGeneration()

Get the underlying segment's gc generation. Might cause the segment to get loaded if the generation info is missing

Returns:

the segment's gc generation

compareTo

public int compareTo(@Nonnull
                     SegmentId that)

Specified by:

compareTo in interface Comparable<SegmentId>

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object object)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

estimateMemoryUsage

public int estimateMemoryUsage()