com.sleepycat.je.log.entry

Enum DbOperationType

java.lang.Object

java.lang.Enum<DbOperationType>

com.sleepycat.je.log.entry.DbOperationType

All Implemented Interfaces:

Loggable, VersionedWriteLoggable, Serializable, Comparable<DbOperationType>

public enum DbOperationType
extends Enum<DbOperationType>
implements VersionedWriteLoggable

DbOperationType is a persistent enum used in NameLNLogEntries. It supports replication of database operations by documenting the type of api operation which instigated the logging of a NameLN.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CREATE
NONE
REMOVE
RENAME
TRUNCATE
UPDATE_CONFIG

Method Summary

Modifier and Type	Method and Description
void	dumpLog(StringBuilder sb, boolean verbose) Write the object into the string buffer for log dumping.
Collection<VersionedWriteLoggable>	getEmbeddedLoggables()
int	getLastFormatChange() Returns the log version of the most recent format change for this loggable item.
int	getLogSize()
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()
boolean	hasReplicationFormat() Returns whether this format has a variant that is optimized for replication.
boolean	isReplicationFormatWorthwhile(ByteBuffer logBuffer, int srcVersion, int destVersion) Returns whether it is worthwhile to materialize and then re-serialize a log entry in a format optimized for replication.
static boolean	isWriteConfigType(DbOperationType opType) Return true if this database operation type needs to write DatabaseConfig.
boolean	logicalEquals(Loggable other)
void	readFromLog(ByteBuffer itemBuffer, int entryVersion) Initialize this object from the data in itemBuf.
static DbOperationType	readTypeFromLog(ByteBuffer entryBuffer, int entryVersion)
static DbOperationType	valueOf(String name) Returns the enum constant of this type with the specified name.
static DbOperationType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.
void	writeToLog(ByteBuffer logBuffer) Serialize this object into the buffer.
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 java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NONE

public static final DbOperationType NONE

CREATE

public static final DbOperationType CREATE

REMOVE

public static final DbOperationType REMOVE

TRUNCATE

public static final DbOperationType TRUNCATE

RENAME

public static final DbOperationType RENAME

UPDATE_CONFIG

public static final DbOperationType UPDATE_CONFIG

Method Detail

values

public static DbOperationType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (DbOperationType c : DbOperationType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static DbOperationType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

readTypeFromLog

public static DbOperationType readTypeFromLog(ByteBuffer entryBuffer,
                                              int entryVersion)

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()

Specified by:

getLogSize in interface Loggable

Returns:

number of bytes used to store this object.

writeToLog

public void writeToLog(ByteBuffer logBuffer)

Description copied from interface: Loggable

Serialize this object into the buffer.

Specified by:

writeToLog in interface Loggable

Parameters:

logBuffer - is the destination buffer

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

hasReplicationFormat

public boolean hasReplicationFormat()

Description copied from interface: VersionedWriteLoggable

Returns whether this format has a variant that is optimized for replication.

Specified by:

hasReplicationFormat in interface VersionedWriteLoggable

isReplicationFormatWorthwhile

public boolean isReplicationFormatWorthwhile(ByteBuffer logBuffer,
                                             int srcVersion,
                                             int destVersion)

Description copied from interface: VersionedWriteLoggable

Returns whether it is worthwhile to materialize and then re-serialize a log entry in a format optimized for replication. Implementations should attempt to check efficiently, without instantiating the log entry object. Some implementations will simply return false.

WARNING: The logBuffer position must not be changed by this method.

WARNING: The shared LogEntry object is used for calling this method, and this method must not change any of the fields in the object.

Specified by:

isReplicationFormatWorthwhile in interface VersionedWriteLoggable

Parameters:

logBuffer - contains the entry that would be re-serialized.

srcVersion - the log version of entry in logBuffer.

destVersion - the version that would be used for re-serialization.

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.

isWriteConfigType

public static boolean isWriteConfigType(DbOperationType opType)

Return true if this database operation type needs to write DatabaseConfig.