com.sleepycat.je.dbi

Class DatabaseId

java.lang.Object

com.sleepycat.je.log.BasicVersionedWriteLoggable

com.sleepycat.je.dbi.DatabaseId

All Implemented Interfaces:

Loggable, VersionedWriteLoggable, Comparable<DatabaseId>

public class DatabaseId
extends BasicVersionedWriteLoggable
implements Comparable<DatabaseId>

DatabaseImpl Ids are wrapped in a class so they can be logged.

Constructor Summary

Constructors

Constructor and Description
DatabaseId() Uninitialized database id, for logging.
DatabaseId(long id)

Method Summary

Modifier and Type	Method and Description
int	compareTo(DatabaseId o) see Comparable#compareTo
void	dumpLog(StringBuilder sb, boolean verbose) Write the object into the string buffer for log dumping.
boolean	equals(Object obj) Compare two DatabaseImpl Id's.
byte[]	getBytes()
Collection<VersionedWriteLoggable>	getEmbeddedLoggables()
long	getId()
int	getLastFormatChange() Returns the log version of the most recent format change for this loggable item.
int	getLogSize(int logVersion, boolean forReplication) Returns the number of bytes needed to store this object in the format for the specified log version.
long	getTransactionId()
int	hashCode()
boolean	logicalEquals(Loggable other)
void	readFromLog(ByteBuffer itemBuffer, int entryVersion) Initialize this object from the data in itemBuf.
String	toString()
void	writeToLog(ByteBuffer logBuffer, int logVersion, boolean forReplication) Serializes this object into the specified buffer in the format for the specified log version.

Methods inherited from class com.sleepycat.je.log.BasicVersionedWriteLoggable

getLogSize, hasReplicationFormat, isReplicationFormatWorthwhile, writeToLog

Methods inherited from class java.lang.Object

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

Constructor Detail

DatabaseId

public DatabaseId(long id)

DatabaseId

public DatabaseId()

Uninitialized database id, for logging.

Method Detail

getId

public long getId()

Returns:

id value

getBytes

public byte[] getBytes()
                throws DatabaseException

Returns:

id as bytes, for use as a key

Throws:

DatabaseException

equals

public boolean equals(Object obj)

Compare two DatabaseImpl Id's.

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

compareTo

public int compareTo(DatabaseId o)

see Comparable#compareTo

Specified by:

compareTo in interface Comparable<DatabaseId>

getLastFormatChange

public int getLastFormatChange()

Description copied from interface: VersionedWriteLoggable

Returns the log version of the most recent format change for this loggable item.

Specified by:

getLastFormatChange in interface VersionedWriteLoggable

Returns:

the log version of the most recent format change

See Also:

ReplicableLogEntry.getLastFormatChange()

getEmbeddedLoggables

public Collection<VersionedWriteLoggable> getEmbeddedLoggables()

Specified by:

getEmbeddedLoggables in interface VersionedWriteLoggable

See Also:

ReplicableLogEntry.getEmbeddedLoggables()

getLogSize

public int getLogSize(int logVersion,
                      boolean forReplication)

Description copied from interface: VersionedWriteLoggable

Returns the number of bytes needed to store this object in the format for the specified log version. Earlier log versions only need to be supported for log entries with format changes made in LogEntryType.LOG_VERSION_REPLICATE_OLDER or greater.

Specified by:

getLogSize in interface VersionedWriteLoggable

Parameters:

logVersion - the log version

forReplication - whether the entry will be sent over the wire, and not written to the log.

Returns:

the number of bytes to store this object for the log version

writeToLog

public void writeToLog(ByteBuffer logBuffer,
                       int logVersion,
                       boolean forReplication)

Description copied from interface: VersionedWriteLoggable

Serializes this object into the specified buffer in the format for the specified log version. Earlier log versions only need to be supported for log entries with format changes made in LogEntryType.LOG_VERSION_REPLICATE_OLDER or greater.

Specified by:

writeToLog in interface VersionedWriteLoggable

Parameters:

logBuffer - the destination buffer

logVersion - the log version

forReplication - whether the entry will be sent over the wire, and not written to the log.

readFromLog

public void readFromLog(ByteBuffer itemBuffer,
                        int entryVersion)

Description copied from interface: Loggable

Initialize this object from the data in itemBuf.

Specified by:

readFromLog in interface Loggable

Parameters:

itemBuffer - the source buffer

entryVersion - the log version of the data

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

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.

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.