Package com.tangosol.io

Class MultiBufferWriteBuffer.MultiBufferOutput

java.lang.Object

java.io.OutputStream

com.tangosol.io.AbstractWriteBuffer.AbstractBufferOutput

com.tangosol.io.MultiBufferWriteBuffer.MultiBufferOutput

All Implemented Interfaces:

com.oracle.coherence.common.io.OutputStreaming, OutputStreaming, WriteBuffer.BufferOutput, Closeable, DataOutput, Flushable, AutoCloseable

Enclosing class:

MultiBufferWriteBuffer

public final class MultiBufferWriteBuffer.MultiBufferOutput
extends AbstractWriteBuffer.AbstractBufferOutput

The MultiBufferOutput implementation extends the AbstractBufferOutput to provide "pass through" operations to the underlying buffer if the operation is guaranteed to fit in the underlying buffer; otherwise, it virtualizes the operation onto the MultiBufferWriteBuffer itself so that the over-run of one underlying WriteBuffer will end up being written to the next underlying WriteBuffer.

This implementation is fairly tightly bound to the super-class implementation; changes to AbstractBufferOutput should be carefully evaluated for potential impacts on this class.

Field Summary

Fields inherited from class com.tangosol.io.AbstractWriteBuffer.AbstractBufferOutput

m_ofWrite

Fields inherited from interface com.tangosol.io.WriteBuffer.BufferOutput

MAX_PACKED_INT_SIZE, MAX_PACKED_LONG_SIZE

Constructor Summary

Constructors

Constructor	Description
MultiBufferOutput(int of)	Construct an AbstractBufferOutput that will begin writing at the specified offset within the containing WriteBuffer.

Method Summary

Modifier and Type	Method	Description
protected void	adjust(int cb)	Adjust the offset of this BufferOutput based on a write that by-passed this BufferOutput's own super-class implementation that is responsible for maintaining the offset.
protected void	advance()	Advance past the end of the current underlying BufferOutput by switching to the BufferOutput of the next underlying WriteBuffer, creating one if necessary.
void	close()	Close the OutputStream and release any system resources associated with it.
ByteBuffer	getByteBuffer(int cb)	Ensure that there are at least cb bytes of capacity left in this WriteBuffer.BufferOutput, and return a mutable ByteBuffer of cb bytes, starting at the current offset.
protected WriteBuffer.BufferOutput	getOut()	Obtain the underlying BufferOutput.
protected boolean	hasRemaining(int cb)	Determine if it is possible to write something of a specified length to the underlying buffer.
void	setOffset(int of)	Specify the offset of the next byte to write to the underlying WriteBuffer.
protected void	sync()	After traversing an underlying WriteBuffer boundary, or otherwise changing the offset significantly, sync between this BufferOutput's absolute position and an underlying BufferOutput's relative position.
void	write(byte[] ab)	Writes all the bytes in the array ab.
void	write(byte[] ab, int of, int cb)	Writes cb bytes starting at offset of from the array ab.
void	write(int b)	Writes the eight low-order bits of the argument b.
void	writeBuffer(ReadBuffer buf)	Write all the bytes from the passed ReadBuffer object.
void	writeBuffer(ReadBuffer buf, int of, int cb)	Write cb bytes from the passed ReadBuffer object starting at offset of within the passed ReadBuffer.
void	writeChar(int ch)	Writes a char value, comprised of the 16 low-order bits of the argument ch; the 16 high-order bits of ch are ignored.
void	writeDouble(double dfl)	Writes a double value.
void	writeFloat(float fl)	Writes a float value.
void	writeInt(int n)	Writes an int value.
void	writeLong(long l)	Writes a long value.
void	writePackedInt(int n)	Write an int value using a variable-length storage-format.
void	writePackedLong(long n)	Write a long value using a variable-length storage-format.
void	writeShort(int n)	Writes a short value, comprised of the 16 low-order bits of the argument n; the 16 high-order bits of n are ignored.
void	writeStream(InputStreaming stream)	Write the remaining contents of the specified InputStreaming object.
void	writeStream(InputStreaming stream, int cb)	Write the specified number of bytes of the specified InputStreaming object.

Methods inherited from class com.tangosol.io.AbstractWriteBuffer.AbstractBufferOutput

calcUTF, countNegatives, flush, formatModifiedUTF, formatModifiedUTF, formatModifiedUTF, formatUTF, formatUTF, getBuffer, getCharBuf, getOffset, writeBoolean, writeByte, writeBytes, writeChars, writeSafeUTF, writeUTF, writeUTF

Methods inherited from class java.io.OutputStream

nullOutputStream

Methods inherited from class java.lang.Object

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

Constructor Details

MultiBufferOutput

public MultiBufferOutput(int of)

Construct an AbstractBufferOutput that will begin writing at the specified offset within the containing WriteBuffer.

Parameters:

of - the offset at which to begin writing

Method Details

getByteBuffer

public ByteBuffer getByteBuffer(int cb)

Ensure that there are at least cb bytes of capacity left in this WriteBuffer.BufferOutput, and return a mutable ByteBuffer of cb bytes, starting at the current offset.

Parameters:

cb - the size of the ByteBuffer to return

Returns:

a mutable ByteBuffer of cb bytes, starting at the current offset

write

public void write(int b)
           throws IOException

Writes the eight low-order bits of the argument b. The 24 high-order bits of b are ignored.

Specified by:

write in interface DataOutput

Specified by:

write in interface com.oracle.coherence.common.io.OutputStreaming

Overrides:

write in class AbstractWriteBuffer.AbstractBufferOutput

Parameters:

b - the byte to write (passed as an integer)

Throws:

IOException - if an I/O error occurs

write

public void write(byte[] ab)
           throws IOException

Writes all the bytes in the array ab.

Specified by:

write in interface DataOutput

Specified by:

write in interface com.oracle.coherence.common.io.OutputStreaming

Overrides:

write in class AbstractWriteBuffer.AbstractBufferOutput

Parameters:

ab - the byte array to write

Throws:

IOException - if an I/O error occurs

write

public void write(byte[] ab,
 int of,
 int cb)
           throws IOException

Writes cb bytes starting at offset of from the array ab.

Specified by:

write in interface DataOutput

Specified by:

write in interface com.oracle.coherence.common.io.OutputStreaming

Overrides:

write in class AbstractWriteBuffer.AbstractBufferOutput

Parameters:

ab - the byte array to write from

of - the offset into ab to start writing from

cb - the number of bytes from ab to write

Throws:

IOException - if an I/O error occurs

writeShort

public void writeShort(int n)
                throws IOException

Writes a short value, comprised of the 16 low-order bits of the argument n; the 16 high-order bits of n are ignored.

Specified by:

writeShort in interface DataOutput

Specified by:

writeShort in interface WriteBuffer.BufferOutput

Overrides:

writeShort in class AbstractWriteBuffer.AbstractBufferOutput

Parameters:

n - the short to write (passed as an integer)

Throws:

IOException - if an I/O error occurs

writeChar

public void writeChar(int ch)
               throws IOException

Writes a char value, comprised of the 16 low-order bits of the argument ch; the 16 high-order bits of ch are ignored.

Specified by:

writeChar in interface DataOutput

Specified by:

writeChar in interface WriteBuffer.BufferOutput

Overrides:

writeChar in class AbstractWriteBuffer.AbstractBufferOutput

Parameters:

ch - the char to write (passed as an integer)

Throws:

IOException - if an I/O error occurs

writeInt

public void writeInt(int n)
              throws IOException

Writes an int value.

Specified by:

writeInt in interface DataOutput

Specified by:

writeInt in interface WriteBuffer.BufferOutput

Overrides:

writeInt in class AbstractWriteBuffer.AbstractBufferOutput

Parameters:

n - the int to write

Throws:

IOException - if an I/O error occurs

writePackedInt

public void writePackedInt(int n)
                    throws IOException

Write an int value using a variable-length storage-format.

The format differs from DataOutput in that DataOutput always uses a fixed-length 4-byte Big Endian binary format for int values. The "packed" format includes a sign bit (0x40) and a continuation bit (0x80) in the first byte, followed by the least 6 significant bits of the int value. Subsequent bytes (each appearing only if the previous byte had its continuation bit set) include a continuation bit (0x80) and the next least 7 significant bits of the int value. In this way, a 32-bit value is encoded into 1-5 bytes, depending on the magnitude of the int value being encoded.

Specified by:

writePackedInt in interface WriteBuffer.BufferOutput

Overrides:

writePackedInt in class AbstractWriteBuffer.AbstractBufferOutput

Parameters:

n - an int value to write

Throws:

IOException - if an I/O error occurs

writeLong

public void writeLong(long l)
               throws IOException

Writes a long value.

Specified by:

writeLong in interface DataOutput

Specified by:

writeLong in interface WriteBuffer.BufferOutput

Overrides:

writeLong in class AbstractWriteBuffer.AbstractBufferOutput

Parameters:

l - the long to write

Throws:

IOException - if an I/O error occurs

writePackedLong

public void writePackedLong(long n)
                     throws IOException

Write a long value using a variable-length storage-format.

The format differs from DataOutput in that DataOutput always uses a fixed-length 8-byte Big Endian binary format for long values. The "packed" format includes a sign bit (0x40) and a continuation bit (0x80) in the first byte, followed by the least 6 significant bits of the long value. Subsequent bytes (each appearing only if the previous byte had its continuation bit set) include a continuation bit (0x80) and the next least 7 significant bits of the long value. In this way, a 64-bit value is encoded into 1-10 bytes, depending on the magnitude of the long value being encoded.

Specified by:

writePackedLong in interface WriteBuffer.BufferOutput

Overrides:

writePackedLong in class AbstractWriteBuffer.AbstractBufferOutput

Parameters:

n - a long value to write

Throws:

IOException - if an I/O error occurs

writeFloat

public void writeFloat(float fl)
                throws IOException

Writes a float value.

Specified by:

writeFloat in interface DataOutput

Specified by:

writeFloat in interface WriteBuffer.BufferOutput

Overrides:

writeFloat in class AbstractWriteBuffer.AbstractBufferOutput

Parameters:

fl - the float to write

Throws:

IOException - if an I/O error occurs

writeDouble

public void writeDouble(double dfl)
                 throws IOException

Writes a double value.

Specified by:

writeDouble in interface DataOutput

Specified by:

writeDouble in interface WriteBuffer.BufferOutput

Overrides:

writeDouble in class AbstractWriteBuffer.AbstractBufferOutput

Parameters:

dfl - the double to write

Throws:

IOException - if an I/O error occurs

writeBuffer

public void writeBuffer(ReadBuffer buf)
                 throws IOException

Write all the bytes from the passed ReadBuffer object.

This is functionally equivalent to the following code:

 getBuffer().write(getOffset(), buf);
 

Specified by:

writeBuffer in interface WriteBuffer.BufferOutput

Overrides:

writeBuffer in class AbstractWriteBuffer.AbstractBufferOutput

Parameters:

buf - a ReadBuffer object

Throws:

IOException - if an I/O error occurs

writeBuffer

public void writeBuffer(ReadBuffer buf,
 int of,
 int cb)
                 throws IOException

Write cb bytes from the passed ReadBuffer object starting at offset of within the passed ReadBuffer.

This is functionally equivalent to the following code:

 getBuffer().write(getOffset(), buf, of, cb);
 

Specified by:

writeBuffer in interface WriteBuffer.BufferOutput

Overrides:

writeBuffer in class AbstractWriteBuffer.AbstractBufferOutput

Parameters:

buf - a ReadBuffer object

of - the offset within the ReadBuffer of the first byte to write to this BufferOutput

cb - the number of bytes to write

Throws:

IOException - if an I/O error occurs

writeStream

public void writeStream(InputStreaming stream)
                 throws IOException

Write the remaining contents of the specified InputStreaming object.

This is functionally equivalent to the following code:

 getBuffer().write(getOffset(), stream);
 

Specified by:

writeStream in interface WriteBuffer.BufferOutput

Overrides:

writeStream in class AbstractWriteBuffer.AbstractBufferOutput

Parameters:

stream - the stream of bytes to write to this BufferOutput

Throws:

IOException - if an I/O error occurs, specifically if an IOException occurs reading from the passed stream

writeStream

public void writeStream(InputStreaming stream,
 int cb)
                 throws IOException

Write the specified number of bytes of the specified InputStreaming object.

This is functionally equivalent to the following code:

 getBuffer().write(getOffset(), stream, cb);
 

Specified by:

writeStream in interface WriteBuffer.BufferOutput

Overrides:

writeStream in class AbstractWriteBuffer.AbstractBufferOutput

Parameters:

stream - the stream of bytes to write to this BufferOutput

cb - the exact number of bytes to read from the stream and write to this BufferOutput

Throws:

IOException - if an I/O error occurs, specifically if an IOException occurs reading from the passed stream

setOffset

public void setOffset(int of)

Specify the offset of the next byte to write to the underlying WriteBuffer.

Specified by:

setOffset in interface WriteBuffer.BufferOutput

Overrides:

setOffset in class AbstractWriteBuffer.AbstractBufferOutput

Parameters:

of - the offset of the next byte to write to the WriteBuffer

close

public void close()
           throws IOException

Close the OutputStream and release any system resources associated with it.

BufferOutput implementations do not pass this call down onto an underlying stream, if any.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface com.oracle.coherence.common.io.OutputStreaming

Specified by:

close in interface WriteBuffer.BufferOutput

Overrides:

close in class AbstractWriteBuffer.AbstractBufferOutput

Throws:

IOException - if an I/O error occurs

getOut

protected WriteBuffer.BufferOutput getOut()

Obtain the underlying BufferOutput.

Returns:

the underlying BufferOutput

hasRemaining

protected boolean hasRemaining(int cb)

Determine if it is possible to write something of a specified length to the underlying buffer.

Parameters:

cb - the length to write

Returns:

true if there are at least cb bytes remaining to be written in the underlying buffer; always returns false after the BufferOutput has been closed

adjust

protected void adjust(int cb)

Adjust the offset of this BufferOutput based on a write that by-passed this BufferOutput's own super-class implementation that is responsible for maintaining the offset.

Parameters:

cb - the number of bytes that were just written directly to the underlying BufferOutput

advance

protected void advance()

Advance past the end of the current underlying BufferOutput by switching to the BufferOutput of the next underlying WriteBuffer, creating one if necessary.

sync

protected void sync()

After traversing an underlying WriteBuffer boundary, or otherwise changing the offset significantly, sync between this BufferOutput's absolute position and an underlying BufferOutput's relative position.