com.sleepycat.je.utilint

Class VLSN

java.lang.Object

com.sleepycat.je.utilint.VLSN

All Implemented Interfaces:

Loggable, Serializable, Comparable<VLSN>

public class VLSN
extends Object
implements Loggable, Comparable<VLSN>, Serializable

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static VLSN	FIRST_VLSN
static int	LOG_SIZE
static VLSN	NULL_VLSN
static int	NULL_VLSN_SEQUENCE
static int	UNINITIALIZED_VLSN_SEQUENCE

Constructor Summary

Constructors

Constructor and Description
VLSN() Constructor for VLSNs that are read from disk.
VLSN(long sequence)

Method Summary

Modifier and Type	Method and Description
int	compareTo(VLSN other) Compares this VLSN's sequence with the specified VLSN's sequence for order.
void	dumpLog(StringBuilder sb, boolean verbose) Write the object into the string buffer for log dumping.
boolean	equals(Object obj)
boolean	equals(VLSN otherVLSN)
boolean	follows(VLSN other) Return true if this VLSN's sequence directly follows the "other" VLSN.
int	getLogSize()
VLSN	getNext() Return a VLSN which would follow this one.
VLSN	getPrev() Return a VLSN which would precede this one.
long	getSequence()
long	getTransactionId()
int	hashCode()
boolean	isNull()
static boolean	isNull(long sequence)
boolean	logicalEquals(Loggable other)
static VLSN	min(VLSN a, VLSN b) Returns the smaller of two VLSNS, ignoring NULL_VLSN values if one value is not NULL_VLSN.
void	readFromLog(ByteBuffer buffer, int entryVersion) Initialize this object from the data in itemBuf.
String	toString()
void	writeToLog(ByteBuffer buffer) Serialize this object into the buffer.

Methods inherited from class java.lang.Object

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

Field Detail

LOG_SIZE

public static final int LOG_SIZE

See Also:

Constant Field Values

NULL_VLSN_SEQUENCE

public static final int NULL_VLSN_SEQUENCE

See Also:

Constant Field Values

NULL_VLSN

public static final VLSN NULL_VLSN

FIRST_VLSN

public static final VLSN FIRST_VLSN

UNINITIALIZED_VLSN_SEQUENCE

public static final int UNINITIALIZED_VLSN_SEQUENCE

See Also:

Constant Field Values

Constructor Detail

VLSN

public VLSN(long sequence)

VLSN

public VLSN()

Constructor for VLSNs that are read from disk.

Method Detail

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equals

public final boolean equals(VLSN otherVLSN)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getSequence

public long getSequence()

isNull

public final boolean isNull()

isNull

public static boolean isNull(long sequence)

getNext

public VLSN getNext()

Return a VLSN which would follow this one.

getPrev

public VLSN getPrev()

Return a VLSN which would precede this one.

follows

public boolean follows(VLSN other)

Return true if this VLSN's sequence directly follows the "other" VLSN. This handles the case where "other" is a NULL_VLSN.

compareTo

public int compareTo(VLSN other)

Compares this VLSN's sequence with the specified VLSN's sequence for order. Returns a negative integer, zero, or a positive integer as this sequence is less than, equal to, or greater than the specified sequence.

Specified by:

compareTo in interface Comparable<VLSN>

min

public static VLSN min(VLSN a,
                       VLSN b)

Returns the smaller of two VLSNS, ignoring NULL_VLSN values if one value is not NULL_VLSN.

Parameters:

a - a VLSN

b - another VLSN

Returns:

the smaller of a and b, ignoring NULL_VLSN unless both are NULL_VLSN

Throws:

IllegalArgumentException - if either argument is null

getLogSize

public int getLogSize()

Specified by:

getLogSize in interface Loggable

Returns:

number of bytes used to store this object.

See Also:

Loggable.getLogSize()

writeToLog

public void writeToLog(ByteBuffer buffer)

Description copied from interface: Loggable

Serialize this object into the buffer.

Specified by:

writeToLog in interface Loggable

Parameters:

buffer - is the destination buffer

See Also:

Loggable.writeToLog(java.nio.ByteBuffer)

readFromLog

public void readFromLog(ByteBuffer buffer,
                        int entryVersion)

Description copied from interface: Loggable

Initialize this object from the data in itemBuf.

Specified by:

readFromLog in interface Loggable

Parameters:

buffer - the source buffer

entryVersion - the log version of the data

See Also:

Loggable.readFromLog(java.nio.ByteBuffer, int)

dumpLog

public void dumpLog(StringBuilder sb,
                    boolean verbose)

Description copied from interface: Loggable

Write the object into the string buffer for log dumping. Each object should be dumped without indentation or new lines and should be valid XML.

Specified by:

dumpLog in interface Loggable

Parameters:

sb - destination string buffer

verbose - if true, dump the full, verbose version

See Also:

Loggable.dumpLog(java.lang.StringBuilder, boolean)

getTransactionId

public long getTransactionId()

Specified by:

getTransactionId in interface Loggable

Returns:

the transaction id embedded within this loggable object. Objects that have no transaction id should return 0.

See Also:

Loggable.getTransactionId()

logicalEquals

public boolean logicalEquals(Loggable other)

Specified by:

logicalEquals in interface Loggable

Returns:

true if these two loggable items are logically the same. Used for replication testing.

See Also:

Loggable.logicalEquals(com.sleepycat.je.log.Loggable)

toString

public String toString()

Overrides:

toString in class Object