de.ipcon.db.io

Class CompactObjectOutput

java.lang.Object

de.ipcon.db.io.CompactObjectOutput

All Implemented Interfaces:

BLOBOutputI, ObjectDataOutputI, SecureObjectOutputI, java.io.Closeable, java.io.DataOutput, java.io.Flushable, java.io.ObjectOutput, java.lang.AutoCloseable

Direct Known Subclasses:

CompactObjectOutputWithSideband

public class CompactObjectOutput
extends java.lang.Object
implements java.io.Closeable, java.io.Flushable, java.io.ObjectOutput, ObjectDataOutputI, BLOBOutputI, SecureObjectOutputI

Field Summary

Fields

Modifier and Type	Field and Description
static int	ANNOUNCE_POJO
static int	ANNOUNCE_POJO_END
static org.apache.log4j.Logger	log
static int	SIDEBAND_SIGNAL_RESET

Constructor Summary

Constructors

Constructor and Description
CompactObjectOutput(java.io.OutputStream _out) Creates a CompactObjectOutput that writes to the specified DataOutput.
CompactObjectOutput(java.io.OutputStream _out, SchemaI schema)
CompactObjectOutput(java.io.OutputStream _out, SchemaI schema, java.util.function.Function replaceBoBeforeWrite)
CompactObjectOutput(java.io.OutputStream _out, SchemaI schema, java.util.function.Function replaceBoBeforeWrite, boolean forServer)

Method Summary

Modifier and Type	Method and Description
void	close() Closes this CompactObjectOutput and releases any system resources associated with it.
void	flush() Flushes this CompactObjectOutput by writing any buffered output to the underlying DataOutput.
java.lang.String	getDescription() Returns a description for this CompactObjectOutput.
long	getLastNetworkActivity() Returns the number of milliseconds since January 1, 1970, 00:00:00 GMT regarding the last network activity on this ObjectDataOutputI.
void	reset() Reset will disregard the state of any objects already written to the stream.
CompactObjectOutput	setBlocksize(int b) Sets the blocksize for data-transfer to the passed value in bytes.
void	setDescription(java.lang.String d) Sets a nice description for this CompactObjectOutput.
void	setObjectTransferHandler(ObjectTransferHandlerI _objectTransferHandler) Sets the ObjectTransferHandlerI for this class.
void	write(byte[] v) Writes to our DataOutput all the bytes in array b.
void	write(byte[] v, int off, int len) Writes len bytes from array b, in order, to our DataOutput.
void	write(int v) Writes to our DataOutput the eight low-order bits of the argument b.
void	writeBigDecimal(java.math.BigDecimal v) Writes a BigDecimal object to our DataOutput.
void	writeBLOB(byte[] b) Writes the passed byte-array to our DataOutput.
void	writeBLOB(byte[] b, int offset, int len) Writes the passed byte-array to our DataOutput, using passed offset offset and length len.
void	writeBLOB(java.io.DataInput in, int len) Reads sz bytes from the passed DataInput is and writes them to our DataOutput.
void	writeBLOB(java.io.InputStream in, int len) Reads sz bytes from the passed InputStream is and writes them to our DataOutput.
void	writeBoolean(boolean v) Writes a boolean value to our DataOutput.
void	writeBooleanObject(java.lang.Boolean v) Writes a Boolean object to our DataOutput.
void	writeByte(int v) Writes to our DataOutput the eight low- order bits of the argument v.
void	writeByteObject(java.lang.Byte v) Writes a Byte object to our DataOutput.
void	writeBytes(java.lang.String v) Writes a string to our DataOutput.
void	writeChar(int v) Writes a char value, which is comprised of two bytes, to our DataOutput.
void	writeChars(java.lang.String v) Writes every character in the string s, to our DataOutput, in order, two bytes per character.
void	writeDate(java.util.Date v) Writes the Date to our DataOutput.
void	writeDouble(double v) Writes a double value, which is comprised of eight bytes, to our DataOutput.
void	writeDoubleObject(java.lang.Double v) Writes a Double object to our DataOutput.
void	writeFloat(float v) Writes a float value, which is comprised of four bytes, to our DataOutput.
void	writeFloatObject(java.lang.Float v) Writes a Float object to our DataOutput.
void	writeInt(int v) Writes an int value, which is comprised of four bytes, to our DataOutput.
void	writeIntegerArray(int[] v) Writes the int array to our DataOutput.
void	writeIntegerObject(java.lang.Integer v) Writes a Integer object to our DataOutput.
void	writeLong(long v) Writes a long value, which is comprised of eight bytes, to our DataOutput.
void	writeLongArray(long[] v) Writes the long array to our DataOutput.
void	writeLongObject(java.lang.Long v) Writes a Long object to our DataOutput.
void	writeObject(java.lang.Object o) Write the specified object to the DataOutput.
void	writeObjectArray(java.lang.Object[] v) Writes the Object array to our DataOutput.
void	writeShort(int v) Writes two bytes to our DataOutput to represent the value of the argument.
void	writeShortObject(java.lang.Short v) Writes a Short object to our DataOutput.
void	writeString(java.lang.String v) Writes the UTF-8 String to our DataOutput.
void	writeStringArray(java.lang.String[] v) Writes the String array to our DataOutput.
void	writeUnshared(java.lang.Object o) Writes an "unshared" object to the DataOutput.
void	writeUTF(java.lang.String v) Writes the UTF-8 String to our DataOutput.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

log

public static final org.apache.log4j.Logger log

ANNOUNCE_POJO

public static final int ANNOUNCE_POJO

See Also:

Constant Field Values

ANNOUNCE_POJO_END

public static final int ANNOUNCE_POJO_END

See Also:

Constant Field Values

SIDEBAND_SIGNAL_RESET

public static final int SIDEBAND_SIGNAL_RESET

See Also:

Constant Field Values

Constructor Detail

CompactObjectOutput

public CompactObjectOutput(java.io.OutputStream _out)

Creates a CompactObjectOutput that writes to the specified DataOutput.

CompactObjectOutput

public CompactObjectOutput(java.io.OutputStream _out,
                           SchemaI schema)

CompactObjectOutput

public CompactObjectOutput(java.io.OutputStream _out,
                           SchemaI schema,
                           java.util.function.Function replaceBoBeforeWrite)

CompactObjectOutput

public CompactObjectOutput(java.io.OutputStream _out,
                           SchemaI schema,
                           java.util.function.Function replaceBoBeforeWrite,
                           boolean forServer)

Method Detail

getLastNetworkActivity

public long getLastNetworkActivity()

Description copied from interface: ObjectDataOutputI

Returns the number of milliseconds since January 1, 1970, 00:00:00 GMT regarding the last network activity on this ObjectDataOutputI.

Specified by:

getLastNetworkActivity in interface ObjectDataOutputI

setBlocksize

public CompactObjectOutput setBlocksize(int b)

Sets the blocksize for data-transfer to the passed value in bytes.

setObjectTransferHandler

public void setObjectTransferHandler(ObjectTransferHandlerI _objectTransferHandler)

Sets the ObjectTransferHandlerI for this class.

close

public void close()
           throws java.io.IOException

Closes this CompactObjectOutput and releases any system resources associated with it.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.io.ObjectOutput

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException

write

public void write(byte[] v)
           throws java.io.IOException

Writes to our DataOutput all the bytes in array b.

Specified by:

write in interface java.io.DataOutput

Specified by:

write in interface java.io.ObjectOutput

Throws:

java.io.IOException

write

public void write(byte[] v,
                  int off,
                  int len)
           throws java.io.IOException

Writes len bytes from array b, in order, to our DataOutput.

Specified by:

write in interface java.io.DataOutput

Specified by:

write in interface java.io.ObjectOutput

Throws:

java.io.IOException

write

public void write(int v)
           throws java.io.IOException

Writes to our DataOutput the eight low-order bits of the argument b.

Specified by:

write in interface java.io.DataOutput

Specified by:

write in interface java.io.ObjectOutput

Throws:

java.io.IOException

writeBoolean

public void writeBoolean(boolean v)
                  throws java.io.IOException

Writes a boolean value to our DataOutput.

Specified by:

writeBoolean in interface java.io.DataOutput

Throws:

java.io.IOException

writeByte

public void writeByte(int v)
               throws java.io.IOException

Writes to our DataOutput the eight low- order bits of the argument v.

Specified by:

writeByte in interface java.io.DataOutput

Throws:

java.io.IOException

writeBytes

public void writeBytes(java.lang.String v)
                throws java.io.IOException

Writes a string to our DataOutput.

Specified by:

writeBytes in interface java.io.DataOutput

Throws:

java.io.IOException

writeChar

public void writeChar(int v)
               throws java.io.IOException

Writes a char value, which is comprised of two bytes, to our DataOutput.

Specified by:

writeChar in interface java.io.DataOutput

Throws:

java.io.IOException

writeChars

public void writeChars(java.lang.String v)
                throws java.io.IOException

Writes every character in the string s, to our DataOutput, in order, two bytes per character.

Specified by:

writeChars in interface java.io.DataOutput

Throws:

java.io.IOException

writeDouble

public void writeDouble(double v)
                 throws java.io.IOException

Writes a double value, which is comprised of eight bytes, to our DataOutput.

Specified by:

writeDouble in interface java.io.DataOutput

Throws:

java.io.IOException

writeFloat

public void writeFloat(float v)
                throws java.io.IOException

Writes a float value, which is comprised of four bytes, to our DataOutput.

Specified by:

writeFloat in interface java.io.DataOutput

Throws:

java.io.IOException

writeInt

public void writeInt(int v)
              throws java.io.IOException

Writes an int value, which is comprised of four bytes, to our DataOutput.

Specified by:

writeInt in interface java.io.DataOutput

Throws:

java.io.IOException

writeLong

public void writeLong(long v)
               throws java.io.IOException

Writes a long value, which is comprised of eight bytes, to our DataOutput.

Specified by:

writeLong in interface java.io.DataOutput

Throws:

java.io.IOException

writeShort

public void writeShort(int v)
                throws java.io.IOException

Writes two bytes to our DataOutput to represent the value of the argument.

Specified by:

writeShort in interface java.io.DataOutput

Throws:

java.io.IOException

writeUTF

public void writeUTF(java.lang.String v)
              throws java.io.IOException

Writes the UTF-8 String to our DataOutput.

Specified by:

writeUTF in interface java.io.DataOutput

Throws:

java.io.IOException

writeBooleanObject

public void writeBooleanObject(java.lang.Boolean v)
                        throws java.io.IOException

Description copied from interface: ObjectDataOutputI

Writes a Boolean object to our DataOutput.

Specified by:

writeBooleanObject in interface ObjectDataOutputI

Throws:

java.io.IOException

writeByteObject

public void writeByteObject(java.lang.Byte v)
                     throws java.io.IOException

Description copied from interface: ObjectDataOutputI

Writes a Byte object to our DataOutput.

Specified by:

writeByteObject in interface ObjectDataOutputI

Throws:

java.io.IOException

writeDoubleObject

public void writeDoubleObject(java.lang.Double v)
                       throws java.io.IOException

Description copied from interface: ObjectDataOutputI

Writes a Double object to our DataOutput.

Specified by:

writeDoubleObject in interface ObjectDataOutputI

Throws:

java.io.IOException

writeFloatObject

public void writeFloatObject(java.lang.Float v)
                      throws java.io.IOException

Description copied from interface: ObjectDataOutputI

Writes a Float object to our DataOutput.

Specified by:

writeFloatObject in interface ObjectDataOutputI

Throws:

java.io.IOException

writeIntegerObject

public void writeIntegerObject(java.lang.Integer v)
                        throws java.io.IOException

Description copied from interface: ObjectDataOutputI

Writes a Integer object to our DataOutput.

Specified by:

writeIntegerObject in interface ObjectDataOutputI

Throws:

java.io.IOException

writeLongObject

public void writeLongObject(java.lang.Long v)
                     throws java.io.IOException

Description copied from interface: ObjectDataOutputI

Writes a Long object to our DataOutput.

Specified by:

writeLongObject in interface ObjectDataOutputI

Throws:

java.io.IOException

writeShortObject

public void writeShortObject(java.lang.Short v)
                      throws java.io.IOException

Description copied from interface: ObjectDataOutputI

Writes a Short object to our DataOutput.

Specified by:

writeShortObject in interface ObjectDataOutputI

Throws:

java.io.IOException

writeBigDecimal

public void writeBigDecimal(java.math.BigDecimal v)
                     throws java.io.IOException

Description copied from interface: ObjectDataOutputI

Writes a BigDecimal object to our DataOutput.

Specified by:

writeBigDecimal in interface ObjectDataOutputI

Throws:

java.io.IOException

writeString

public void writeString(java.lang.String v)
                 throws java.io.IOException

Description copied from interface: ObjectDataOutputI

Writes the UTF-8 String to our DataOutput.

Specified by:

writeString in interface ObjectDataOutputI

Throws:

java.io.IOException

writeDate

public void writeDate(java.util.Date v)
               throws java.io.IOException

Description copied from interface: ObjectDataOutputI

Writes the Date to our DataOutput.

Specified by:

writeDate in interface ObjectDataOutputI

Throws:

java.io.IOException

writeStringArray

public void writeStringArray(java.lang.String[] v)
                      throws java.io.IOException

Description copied from interface: ObjectDataOutputI

Writes the String array to our DataOutput.

Specified by:

writeStringArray in interface ObjectDataOutputI

Throws:

java.io.IOException

writeIntegerArray

public void writeIntegerArray(int[] v)
                       throws java.io.IOException

Description copied from interface: ObjectDataOutputI

Writes the int array to our DataOutput.

Specified by:

writeIntegerArray in interface ObjectDataOutputI

Throws:

java.io.IOException

writeLongArray

public void writeLongArray(long[] v)
                    throws java.io.IOException

Description copied from interface: ObjectDataOutputI

Writes the long array to our DataOutput.

Specified by:

writeLongArray in interface ObjectDataOutputI

Throws:

java.io.IOException

writeObjectArray

public void writeObjectArray(java.lang.Object[] v)
                      throws java.io.IOException

Description copied from interface: ObjectDataOutputI

Writes the Object array to our DataOutput.

Specified by:

writeObjectArray in interface ObjectDataOutputI

Throws:

java.io.IOException

writeBLOB

public void writeBLOB(byte[] b)
               throws java.io.IOException

Description copied from interface: BLOBOutputI

Writes the passed byte-array to our DataOutput.

Specified by:

writeBLOB in interface BLOBOutputI

Throws:

java.io.IOException

writeBLOB

public void writeBLOB(byte[] b,
                      int offset,
                      int len)
               throws java.io.IOException

Description copied from interface: BLOBOutputI

Writes the passed byte-array to our DataOutput, using passed offset offset and length len.

Specified by:

writeBLOB in interface BLOBOutputI

Throws:

java.io.IOException

writeBLOB

public void writeBLOB(java.io.DataInput in,
                      int len)
               throws java.io.IOException

Description copied from interface: BLOBOutputI

Reads sz bytes from the passed DataInput is and writes them to our DataOutput.

Specified by:

writeBLOB in interface BLOBOutputI

Throws:

java.io.IOException

writeBLOB

public void writeBLOB(java.io.InputStream in,
                      int len)
               throws java.io.IOException

Description copied from interface: BLOBOutputI

Reads sz bytes from the passed InputStream is and writes them to our DataOutput.

Specified by:

writeBLOB in interface BLOBOutputI

Throws:

java.io.IOException

flush

public void flush()
           throws java.io.IOException

Flushes this CompactObjectOutput by writing any buffered output to the underlying DataOutput.

Specified by:

flush in interface ObjectDataOutputI

Specified by:

flush in interface java.io.Flushable

Specified by:

flush in interface java.io.ObjectOutput

Throws:

java.io.IOException

writeObject

public void writeObject(java.lang.Object o)
                 throws java.io.IOException

Write the specified object to the DataOutput. The class of the object, the signature of the class, and the values of the non-transient and non-static fields of the class and all of its supertypes are written. Default serialization for a class can be overridden using the writeObject and the readObject methods. Objects referenced by this object are written transitively so that a complete equivalent graph of objects can be reconstructed by a CompactObjectInput.

Specified by:

writeObject in interface ObjectDataOutputI

Specified by:

writeObject in interface java.io.ObjectOutput

Throws:

java.io.IOException

writeUnshared

public void writeUnshared(java.lang.Object o)
                   throws java.io.IOException

Writes an "unshared" object to the DataOutput. This method is identical to writeObject, except that it always writes the given object as a new, unique object in the stream (as opposed to a back-reference pointing to a previously serialized instance).

Specified by:

writeUnshared in interface ObjectDataOutputI

Throws:

java.io.IOException

reset

public void reset()
           throws java.io.IOException

Reset will disregard the state of any objects already written to the stream. The state is reset to be the same as a new CompactObjectOutput, regarding POJO-output, upon the next writeObject call. The current point in the stream is marked as reset so the corresponding POJO-InputStream of the corresponding CompactObjectInput will be reset at the same point. Objects previously written to the stream will not be referred to as already being in the stream. They will be written to the stream again.

Specified by:

reset in interface ObjectDataOutputI

Throws:

java.io.IOException

setDescription

public void setDescription(java.lang.String d)

Sets a nice description for this CompactObjectOutput.

Specified by:

setDescription in interface ObjectDataOutputI

getDescription

public java.lang.String getDescription()

Returns a description for this CompactObjectOutput.

Specified by:

getDescription in interface ObjectDataOutputI