com.tangosol.io
Interface WriteBuffer.BufferOutput

All Superinterfaces:

DataOutput, OutputStreaming

All Known Implementing Classes:

AbstractWriteBuffer.AbstractBufferOutput, ByteArrayWriteBuffer.ByteArrayBufferOutput, ByteBufferWriteBuffer.ByteBufferOutput, DelegatingWriteBuffer.DelegatingBufferOutput, MultiBufferWriteBuffer.MultiBufferOutput

Enclosing interface:

WriteBuffer

public static interface WriteBuffer.BufferOutput
extends OutputStreaming, DataOutput

The BufferOutput interface represents a DataOutputStream on top of a WriteBuffer.

Author:

cp 2005.01.18

Method Summary

void	close() Close the OutputStream and release any system resources associated with it.
WriteBuffer	getBuffer() Get the WriteBuffer object that this BufferOutput is writeing to.
int	getOffset() Determine the current offset of this BufferOutput within the underlying WriteBuffer.
void	setOffset(int of) Specify the offset of the next byte to write to the underlying WriteBuffer.
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	writePackedInt(int n) Write an int value using a variable-length storage-format.
void	writePackedLong(long l) Write a long value using a variable-length storage-format.
void	writeSafeUTF(String s) Write a variable-length encoded UTF packed String.
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 interface com.tangosol.io.OutputStreaming

flush, write, write, write

Methods inherited from interface java.io.DataOutput

write, write, write, writeBoolean, writeByte, writeBytes, writeChar, writeChars, writeDouble, writeFloat, writeInt, writeLong, writeShort, writeUTF

Method Detail

close

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 OutputStreaming

Throws:

IOException - if an I/O error occurs

getBuffer

WriteBuffer getBuffer()

Get the WriteBuffer object that this BufferOutput is writeing to.

Returns:

the underlying WriteBuffer object

writeSafeUTF

void writeSafeUTF(String s)
                  throws IOException

Write a variable-length encoded UTF packed String. The major differences between this implementation and DataOutput is that this implementation supports null values and is not limited to 64KB UTF-encoded values.

The binary format for a Safe UTF value is a "packed int" for the binary length followed by the UTF-encoded byte stream. The length is either -1 (indicating a null String) or in the range 0 .. Integer.MAX_VALUE (inclusive). The UTF-encoded portion uses a format identical to DataOutput.

Parameters:

s - a String value to write; may be null

Throws:

IOException - if an I/O error occurs

writePackedInt

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 being encoded.

Parameters:

n - an int value to write

Throws:

IOException - if an I/O error occurs

writePackedLong

void writePackedLong(long l)
                     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 int being encoded.

Parameters:

l - a long value to write

Throws:

IOException - if an I/O error occurs

writeBuffer

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);
 

Parameters:

buf - a ReadBuffer object

Throws:

IOException - if an I/O error occurs

writeBuffer

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);
 

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

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);
 

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

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);
 

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:

EOFException - if the stream is exhausted before the number of bytes indicated could be read

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

getOffset

int getOffset()

Determine the current offset of this BufferOutput within the underlying WriteBuffer.

Returns:

the offset of the next byte to write to the WriteBuffer

setOffset

void setOffset(int of)

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

Parameters:

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

Throws:

IndexOutOfBoundsException - if of < 0 or of > getBuffer().getMaximumCapacity()