Package com.tangosol.io

Class DelegatingWriteBuffer.DelegatingBufferOutput

java.lang.Object

java.io.OutputStream

com.tangosol.io.AbstractWriteBuffer.AbstractBufferOutput

com.tangosol.io.DelegatingWriteBuffer.DelegatingBufferOutput

All Implemented Interfaces:

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

Enclosing class:

DelegatingWriteBuffer

public final class DelegatingWriteBuffer.DelegatingBufferOutput
extends AbstractWriteBuffer.AbstractBufferOutput

A BufferOutput implementation that delegates to a BufferOutput implementation, except that its offset range is shifted and limited.

Author:

cp 2005.03.24

Field Summary

Fields

Modifier and Type	Field	Description
protected WriteBuffer.BufferOutput	m_out	The BufferOutput to delegate to.

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
DelegatingBufferOutput(int of)	Construct an AbstractBufferOutput that will begin writing at the start of the containing WriteBuffer.

Method Summary

Modifier and Type	Method	Description
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 void	moveOffset(int cb)	Move the offset within the stream forward.
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	writeBoolean(boolean f)	Writes the boolean value f.
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	writeByte(int b)	Writes the eight low-order bits of the argument b.
void	writeBytes(String s)	Writes the String s, but only the low-order byte from each character of the String is written.
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	writeChars(String s)	Writes the String s as a sequence of characters.
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	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.
void	writeUTF(String s)	Writes the String s as a sequence of characters, but using UTF-8 encoding for the characters, and including the String length data so that the corresponding DataInput.readUTF() method can reconstitute a String from the written data.

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

calcUTF, close, countNegatives, flush, formatModifiedUTF, formatModifiedUTF, formatModifiedUTF, formatUTF, formatUTF, getBuffer, getCharBuf, getOffset, setOffset, write, writePackedInt, writePackedLong, writeSafeUTF, 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

Field Details

m_out

protected WriteBuffer.BufferOutput m_out

The BufferOutput to delegate to.

Constructor Details

DelegatingBufferOutput

public DelegatingBufferOutput(int of)

Construct an AbstractBufferOutput that will begin writing at the start of the containing WriteBuffer.

Parameters:

of - the offset within the DelegatingWriteBuffer that this BufferOutput will begin writing to

Method Details

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,
 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

writeBoolean

public void writeBoolean(boolean f)
                  throws IOException

Writes the boolean value f.

Specified by:

writeBoolean in interface DataOutput

Specified by:

writeBoolean in interface WriteBuffer.BufferOutput

Overrides:

writeBoolean in class AbstractWriteBuffer.AbstractBufferOutput

Parameters:

f - the boolean to be written

Throws:

IOException - if an I/O error occurs

writeByte

public void writeByte(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:

writeByte in interface DataOutput

Specified by:

writeByte in interface WriteBuffer.BufferOutput

Overrides:

writeByte in class AbstractWriteBuffer.AbstractBufferOutput

Parameters:

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

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

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

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

writeBytes

public void writeBytes(String s)
                throws IOException

Writes the String s, but only the low-order byte from each character of the String is written.

Specified by:

writeBytes in interface DataOutput

Specified by:

writeBytes in interface WriteBuffer.BufferOutput

Overrides:

writeBytes in class AbstractWriteBuffer.AbstractBufferOutput

Parameters:

s - the String to write

Throws:

IOException - if an I/O error occurs

writeChars

public void writeChars(String s)
                throws IOException

Writes the String s as a sequence of characters.

Specified by:

writeChars in interface DataOutput

Specified by:

writeChars in interface WriteBuffer.BufferOutput

Overrides:

writeChars in class AbstractWriteBuffer.AbstractBufferOutput

Parameters:

s - the String to write

Throws:

IOException - if an I/O error occurs

NullPointerException - if s is null

writeUTF

public void writeUTF(String s)
              throws IOException

Writes the String s as a sequence of characters, but using UTF-8 encoding for the characters, and including the String length data so that the corresponding DataInput.readUTF() method can reconstitute a String from the written data.

Specified by:

writeUTF in interface DataOutput

Specified by:

writeUTF in interface WriteBuffer.BufferOutput

Overrides:

writeUTF in class AbstractWriteBuffer.AbstractBufferOutput

Parameters:

s - the String to write

Throws:

IOException - if an I/O error occurs

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

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

moveOffset

protected void moveOffset(int cb)

Move the offset within the stream forward.

Parameters:

cb - the number of bytes to advance the offset