com.sleepycat.je.log.entry

Class SingleItemEntry

java.lang.Object

com.sleepycat.je.log.entry.SingleItemEntry

All Implemented Interfaces:

LogEntry, java.lang.Cloneable

Direct Known Subclasses:

BINDeltaLogEntry

public class SingleItemEntry
extends java.lang.Object
implements LogEntry

This class embodies log entries that have a single loggable item. On disk, an entry contains:

     the Loggable item
 

Constructor Summary

Constructors

Constructor and Description
SingleItemEntry(java.lang.Class<?> logClass) Construct a log entry for reading.
SingleItemEntry(LogEntryType entryType, Loggable item) Construct a log entry for writing.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object	clone()
boolean	countAsObsoleteWhenLogged() Returns true if this item should be counted as obsoleted when logged.
java.lang.StringBuffer	dumpEntry(java.lang.StringBuffer sb, boolean verbose) Print out the contents of an entry.
int	getLastLoggedSize() By default, return zero because the last logged size is unknown.
LogEntryType	getLogType()
java.lang.Object	getMainItem()
int	getSize()
long	getTransactionId()
boolean	logicalEquals(LogEntry other)
void	postLogWork(long justLoggedLsn) Do any processing we need to do after logging, while under the logging latch.
void	readEntry(LogEntryHeader header, java.nio.ByteBuffer entryBuffer, boolean readFullItem) Read in a log entry.
void	setLogType(LogEntryType entryType) Inform a BaseEntry instance of its corresponding LogEntryType.
java.lang.String	toString()
void	writeEntry(LogEntryHeader header, java.nio.ByteBuffer destBuffer) Serialize this object into the buffer.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.sleepycat.je.log.entry.LogEntry

countAsObsoleteWhenLogged, getLastLoggedSize, getLogType, postLogWork, setLogType

Constructor Detail

SingleItemEntry

public SingleItemEntry(java.lang.Class<?> logClass)

Construct a log entry for reading.

SingleItemEntry

public SingleItemEntry(LogEntryType entryType,
               Loggable item)

Construct a log entry for writing.

Method Detail

readEntry

public void readEntry(LogEntryHeader header,
             java.nio.ByteBuffer entryBuffer,
             boolean readFullItem)
               throws DatabaseException

Description copied from interface: LogEntry

Read in a log entry.

Specified by:

readEntry in interface LogEntry

Throws:

DatabaseException

See Also:

LogEntry.readEntry(com.sleepycat.je.log.LogEntryHeader, java.nio.ByteBuffer, boolean)

dumpEntry

public java.lang.StringBuffer dumpEntry(java.lang.StringBuffer sb,
                               boolean verbose)

Description copied from interface: LogEntry

Print out the contents of an entry.

Specified by:

dumpEntry in interface LogEntry

See Also:

LogEntry.dumpEntry(java.lang.StringBuffer, boolean)

getMainItem

public java.lang.Object getMainItem()

Specified by:

getMainItem in interface LogEntry

Returns:

the first item of the log entry

See Also:

LogEntry.getMainItem()

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Specified by:

clone in interface LogEntry

Overrides:

clone in class java.lang.Object

Returns:

a shallow clone.

Throws:

java.lang.CloneNotSupportedException

See Also:

LogEntry.clone()

getTransactionId

public long getTransactionId()

Specified by:

getTransactionId in interface LogEntry

Returns:

return the transaction id if this log entry is transactional, 0 otherwise.

See Also:

LogEntry.getTransactionId()

getSize

public int getSize()

Specified by:

getSize in interface LogEntry

Returns:

size of byte buffer needed to store this entry.

writeEntry

public void writeEntry(LogEntryHeader header,
              java.nio.ByteBuffer destBuffer)

Description copied from interface: LogEntry

Serialize this object into the buffer.

Specified by:

writeEntry in interface LogEntry

destBuffer - is the destination buffer

See Also:

LogEntry.writeEntry(com.sleepycat.je.log.LogEntryHeader, java.nio.ByteBuffer)

logicalEquals

public boolean logicalEquals(LogEntry other)

Specified by:

logicalEquals in interface LogEntry

Returns:

true if these two log entries are logically the same. Used for replication.

See Also:

LogEntry.logicalEquals(com.sleepycat.je.log.entry.LogEntry)

setLogType

public void setLogType(LogEntryType entryType)

Inform a BaseEntry instance of its corresponding LogEntryType.

getLogType

public LogEntryType getLogType()

Returns:

the type of log entry

getLastLoggedSize

public int getLastLoggedSize()

By default, return zero because the last logged size is unknown. This method is overridden by LNLogEntry.

countAsObsoleteWhenLogged

public boolean countAsObsoleteWhenLogged()

Returns true if this item should be counted as obsoleted when logged. This currently applies to deleted LNs only.

postLogWork

public void postLogWork(long justLoggedLsn)
                 throws DatabaseException

Do any processing we need to do after logging, while under the logging latch.

Throws:

DatabaseException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object