|
Oracle® Coherence Java API Reference Release 12.1.2.0.3 E26043-02 |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
com.tangosol.util.Base
com.tangosol.io.WrapperBufferOutput
public class WrapperBufferOutput
This is an imitation BufferOutput implementation that provides the BufferOutput interface by delegating to an object that implements the DataOutput interface. Primarily, this is intended as a base class for building specific-purpose DataOutput wrappers.
Field Summary |
---|
Fields inherited from interface com.tangosol.io.WriteBuffer.BufferOutput |
---|
MAX_PACKED_INT_SIZE, MAX_PACKED_LONG_SIZE |
Constructor Summary | |
---|---|
WrapperBufferOutput(java.io.DataOutput out) Construct a WrapperBufferOutput that will write to the specified object implementing the DataOutput interface. |
|
WrapperBufferOutput(java.io.DataOutput out, WriteBuffer wb) Construct a WrapperBufferOutput that will write to the specified object implementing the DataOutput interface and return the optional WriteBuffer as its underlying destination. |
Method Summary | |
---|---|
void |
close() Close the OutputStream and release any system resources associated with it. |
void |
flush() Flushes this OutputStream and forces any buffered output bytes to be written. |
WriteBuffer |
getBuffer() Get the WriteBuffer object that this BufferOutput is writing to. |
java.io.DataOutput |
getDataOutput() Obtain the underlying object providing the DataOutput interface that this object is delegating 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 |
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 |
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(java.lang.String s) Writes the String s, but only the low-order byte from each character of the String is written. |
void |
writeChar(int n) 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(java.lang.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 |
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(java.lang.String s) Write a variable-length encoded UTF packed String. |
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(java.lang.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. |
Constructor Detail |
---|
public WrapperBufferOutput(java.io.DataOutput out)
out
- an object implementing DataOutput to write topublic WrapperBufferOutput(java.io.DataOutput out, WriteBuffer wb)
out
- an object implementing DataOutput to write towb
- an optional object implementing WriteBufferMethod Detail |
---|
public void write(int b) throws java.io.IOException
b
. The 24 high-order bits of b
are ignored.write
in interface OutputStreaming
write
in interface java.io.DataOutput
b
- the byte to write (passed as an integer)java.io.IOException
- if an I/O error occurspublic void write(byte[] ab) throws java.io.IOException
ab
.write
in interface OutputStreaming
write
in interface java.io.DataOutput
ab
- the byte array to writejava.io.IOException
- if an I/O error occurspublic void write(byte[] ab, int of, int cb) throws java.io.IOException
cb
bytes starting at offset of
from the array ab
.write
in interface OutputStreaming
write
in interface java.io.DataOutput
ab
- the byte array to write fromof
- the offset into ab
to start writing fromcb
- the number of bytes from ab
to writejava.io.IOException
- if an I/O error occurspublic void flush() throws java.io.IOException
flush
in interface OutputStreaming
java.io.IOException
- if an I/O error occurspublic void close() throws java.io.IOException
BufferOutput implementations do not pass this call down onto an underlying stream, if any.
close
in interface OutputStreaming
close
in interface WriteBuffer.BufferOutput
java.io.IOException
- if an I/O error occurspublic void writeBoolean(boolean f) throws java.io.IOException
writeBoolean
in interface WriteBuffer.BufferOutput
writeBoolean
in interface java.io.DataOutput
f
- the boolean to be writtenjava.io.IOException
- if an I/O error occurspublic void writeByte(int b) throws java.io.IOException
writeByte
in interface WriteBuffer.BufferOutput
writeByte
in interface java.io.DataOutput
b
- the byte to write (passed as an integer)java.io.IOException
- if an I/O error occurspublic void writeShort(int n) throws java.io.IOException
writeShort
in interface WriteBuffer.BufferOutput
writeShort
in interface java.io.DataOutput
n
- the short to write (passed as an integer)java.io.IOException
- if an I/O error occurspublic void writeChar(int n) throws java.io.IOException
writeChar
in interface WriteBuffer.BufferOutput
writeChar
in interface java.io.DataOutput
n
- the char to write (passed as an integer)java.io.IOException
- if an I/O error occurspublic void writeInt(int n) throws java.io.IOException
writeInt
in interface WriteBuffer.BufferOutput
writeInt
in interface java.io.DataOutput
n
- the int to writejava.io.IOException
- if an I/O error occurspublic void writeLong(long l) throws java.io.IOException
writeLong
in interface WriteBuffer.BufferOutput
writeLong
in interface java.io.DataOutput
l
- the long to writejava.io.IOException
- if an I/O error occurspublic void writeFloat(float fl) throws java.io.IOException
writeFloat
in interface WriteBuffer.BufferOutput
writeFloat
in interface java.io.DataOutput
fl
- the float to writejava.io.IOException
- if an I/O error occurspublic void writeDouble(double dfl) throws java.io.IOException
writeDouble
in interface WriteBuffer.BufferOutput
writeDouble
in interface java.io.DataOutput
dfl
- the double to writejava.io.IOException
- if an I/O error occurspublic void writeBytes(java.lang.String s) throws java.io.IOException
writeBytes
in interface WriteBuffer.BufferOutput
writeBytes
in interface java.io.DataOutput
s
- the String to writejava.io.IOException
- if an I/O error occurspublic void writeChars(java.lang.String s) throws java.io.IOException
writeChars
in interface WriteBuffer.BufferOutput
writeChars
in interface java.io.DataOutput
s
- the String to writejava.io.IOException
- if an I/O error occurspublic void writeUTF(java.lang.String s) throws java.io.IOException
DataInput.readUTF()
method can reconstitute a String from the written data.writeUTF
in interface WriteBuffer.BufferOutput
writeUTF
in interface java.io.DataOutput
s
- the String to writejava.io.IOException
- if an I/O error occurspublic WriteBuffer getBuffer()
getBuffer
in interface WriteBuffer.BufferOutput
public void writeSafeUTF(java.lang.String s) throws java.io.IOException
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.
writeSafeUTF
in interface WriteBuffer.BufferOutput
s
- a String value to write; may be nulljava.io.IOException
- if an I/O error occurspublic void writePackedInt(int n) throws java.io.IOException
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.
writePackedInt
in interface WriteBuffer.BufferOutput
n
- an int value to writejava.io.IOException
- if an I/O error occurspublic void writePackedLong(long l) throws java.io.IOException
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.
writePackedLong
in interface WriteBuffer.BufferOutput
l
- a long value to writejava.io.IOException
- if an I/O error occurspublic void writeBuffer(ReadBuffer buf) throws java.io.IOException
This is functionally equivalent to the following code:
getBuffer().write(getOffset(), buf);
writeBuffer
in interface WriteBuffer.BufferOutput
buf
- a ReadBuffer objectjava.io.IOException
- if an I/O error occurspublic void writeBuffer(ReadBuffer buf, int of, int cb) throws java.io.IOException
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);
writeBuffer
in interface WriteBuffer.BufferOutput
buf
- a ReadBuffer objectof
- the offset within the ReadBuffer of the first byte to write to this BufferOutputcb
- the number of bytes to writejava.io.IOException
- if an I/O error occurspublic void writeStream(InputStreaming stream) throws java.io.IOException
This is functionally equivalent to the following code:
getBuffer().write(getOffset(), stream);
writeStream
in interface WriteBuffer.BufferOutput
stream
- the stream of bytes to write to this BufferOutputjava.io.IOException
- if an I/O error occurs, specifically if an IOException occurs reading from the passed streampublic void writeStream(InputStreaming stream, int cb) throws java.io.IOException
This is functionally equivalent to the following code:
getBuffer().write(getOffset(), stream, cb);
writeStream
in interface WriteBuffer.BufferOutput
stream
- the stream of bytes to write to this BufferOutputcb
- the exact number of bytes to read from the stream and write to this BufferOutputjava.io.EOFException
- if the stream is exhausted before the number of bytes indicated could be readjava.io.IOException
- if an I/O error occurs, specifically if an IOException occurs reading from the passed streampublic int getOffset()
getOffset
in interface WriteBuffer.BufferOutput
public void setOffset(int of)
setOffset
in interface WriteBuffer.BufferOutput
of
- the offset of the next byte to write to the WriteBufferpublic java.io.DataOutput getDataOutput()
|
Oracle® Coherence Java API Reference Release 12.1.2.0.3 E26043-02 |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |