kv-4.0.9.src.com.sleepycat.je.log.Loggable Maven / Gradle / Ivy
Show all versions of oracle-nosql-client Show documentation
/*-
*
* This file is part of Oracle NoSQL Database
* Copyright (C) 2011, 2016 Oracle and/or its affiliates. All rights reserved.
*
* If you have received this file as part of Oracle NoSQL Database the
* following applies to the work as a whole:
*
* Oracle NoSQL Database server software is free software: you can
* redistribute it and/or modify it under the terms of the GNU Affero
* General Public License as published by the Free Software Foundation,
* version 3.
*
* Oracle NoSQL Database is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Affero General Public License for more details.
*
* If you have received this file as part of Oracle NoSQL Database Client or
* distributed separately the following applies:
*
* Oracle NoSQL Database client software is free software: you can
* redistribute it and/or modify it under the terms of the Apache License
* as published by the Apache Software Foundation, version 2.0.
*
* You should have received a copy of the GNU Affero General Public License
* and/or the Apache License in the LICENSE file along with Oracle NoSQL
* Database client or server distribution. If not, see
* .
*
* An active Oracle commercial licensing agreement for this product supersedes
* these licenses and in such case the license notices, but not the copyright
* notice, may be removed by you in connection with your distribution that is
* in accordance with the commercial licensing terms.
*
* For more information please contact:
*
* [email protected]
*
*/
package com.sleepycat.je.log;
import java.nio.ByteBuffer;
/**
* A class that implements Loggable knows how to read and write itself into
* a ByteBuffer in a format suitable for the JE log or JE replication
* messages.
*
* Classes that implement {@code Loggable} and are included in replication
* data should implement {@code VersionedWriteLoggable}.
*/
public interface Loggable {
/*
* Writing to a byte buffer
*/
/**
* @return number of bytes used to store this object.
*/
public int getLogSize();
/**
* Serialize this object into the buffer.
* @param logBuffer is the destination buffer
*/
public void writeToLog(ByteBuffer logBuffer);
/*
* Reading from a byte buffer
*/
/**
* Initialize this object from the data in itemBuf.
* @param itemBuffer the source buffer
* @param entryVersion the log version of the data
*/
public void readFromLog(ByteBuffer itemBuffer, int entryVersion);
/**
* 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.
* @param sb destination string buffer
* @param verbose if true, dump the full, verbose version
*/
public void dumpLog(StringBuilder sb, boolean verbose);
/**
* @return the transaction id embedded within this loggable object. Objects
* that have no transaction id should return 0.
*/
public long getTransactionId();
/**
* @return true if these two loggable items are logically the same.
* Used for replication testing.
*/
public boolean logicalEquals(Loggable other);
}