|
Oracle® Coherence Java API Reference Release 3.6.0.0 E15725-01 |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public static interface WriteBuffer.BufferOutput
The BufferOutput interface represents a DataOutputStream on top of a WriteBuffer.
Field Summary | |
---|---|
static int |
MAX_PACKED_INT_SIZE Maximum encoding length for a packed int value. |
static int |
MAX_PACKED_LONG_SIZE Maximum encoding length for a packed long value. |
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 writing 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 |
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 |
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 |
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 interface com.tangosol.io.OutputStreaming |
---|
flush, write, write, write |
Methods inherited from interface java.io.DataOutput |
---|
write, write, write |
Field Detail |
---|
static final int MAX_PACKED_INT_SIZE
static final int MAX_PACKED_LONG_SIZE
Method Detail |
---|
void close() throws IOException
BufferOutput implementations do not pass this call down onto an underlying stream, if any.
close
in interface OutputStreaming
IOException
- if an I/O error occursvoid writeBoolean(boolean f) throws IOException
writeBoolean
in interface DataOutput
f
- the boolean to be writtenIOException
- if an I/O error occursvoid writeByte(int b) throws IOException
writeByte
in interface DataOutput
b
- the byte to write (passed as an integer)IOException
- if an I/O error occursvoid writeShort(int n) throws IOException
writeShort
in interface DataOutput
n
- the short to write (passed as an integer)IOException
- if an I/O error occursvoid writeChar(int ch) throws IOException
writeChar
in interface DataOutput
ch
- the char to write (passed as an integer)IOException
- if an I/O error occursvoid writeInt(int n) throws IOException
writeInt
in interface DataOutput
n
- the int to writeIOException
- if an I/O error occursvoid writeLong(long l) throws IOException
writeLong
in interface DataOutput
l
- the long to writeIOException
- if an I/O error occursvoid writeFloat(float fl) throws IOException
writeFloat
in interface DataOutput
fl
- the float to writeIOException
- if an I/O error occursvoid writeDouble(double dfl) throws IOException
writeDouble
in interface DataOutput
dfl
- the double to writeIOException
- if an I/O error occursvoid writeBytes(String s) throws IOException
writeBytes
in interface DataOutput
s
- the String to writeIOException
- if an I/O error occursNullPointerException
- if s is nullvoid writeChars(String s) throws IOException
writeChars
in interface DataOutput
s
- the String to writeIOException
- if an I/O error occursNullPointerException
- if s is nullvoid writeUTF(String s) throws IOException
DataInput.readUTF()
method can reconstitute a String from the written data.writeUTF
in interface DataOutput
s
- the String to writeIOException
- if an I/O error occursNullPointerException
- if s is nullWriteBuffer getBuffer()
void writeSafeUTF(String s) throws 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.
s
- a String value to write; may be nullIOException
- if an I/O error occursvoid writePackedInt(int n) throws 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.
n
- an int value to writeIOException
- if an I/O error occursvoid writePackedLong(long l) throws 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.
l
- a long value to writeIOException
- if an I/O error occursvoid writeBuffer(ReadBuffer buf) throws IOException
This is functionally equivalent to the following code:
getBuffer().write(getOffset(), buf);
buf
- a ReadBuffer objectIOException
- if an I/O error occursvoid writeBuffer(ReadBuffer buf, int of, int cb) throws 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);
buf
- a ReadBuffer objectof
- the offset within the ReadBuffer of the first byte to write to this BufferOutputcb
- the number of bytes to writeIOException
- if an I/O error occursvoid writeStream(InputStreaming stream) throws IOException
This is functionally equivalent to the following code:
getBuffer().write(getOffset(), stream);
stream
- the stream of bytes to write to this BufferOutputIOException
- if an I/O error occurs, specifically if an IOException occurs reading from the passed streamvoid writeStream(InputStreaming stream, int cb) throws IOException
This is functionally equivalent to the following code:
getBuffer().write(getOffset(), stream, cb);
stream
- the stream of bytes to write to this BufferOutputcb
- the exact number of bytes to read from the stream and write to this BufferOutputEOFException
- if the stream is exhausted before the number of bytes indicated could be readIOException
- if an I/O error occurs, specifically if an IOException occurs reading from the passed streamint getOffset()
void setOffset(int of)
of
- the offset of the next byte to write to the WriteBufferIndexOutOfBoundsException
- if of < 0
or of > getBuffer().getMaximumCapacity()
|
Oracle® Coherence Java API Reference Release 3.6.0.0 E15725-01 |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |