|
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 |
java.lang.Object
java.io.OutputStream
com.tangosol.io.AbstractWriteBuffer.AbstractBufferOutput
com.tangosol.io.MultiBufferWriteBuffer.MultiBufferOutput
public final class MultiBufferWriteBuffer.MultiBufferOutput
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. <p/> 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 | |
---|---|
MultiBufferWriteBuffer.MultiBufferOutput(int of) Construct an AbstractBufferOutput that will begin writing at the specified offset within the containing WriteBuffer. |
Method Summary | |
---|---|
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() Closes this OutputStream and releases any associated system resources. |
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 . The 24 high-order bits of b are ignored. |
void |
writeBuffer(ReadBuffer buf) Write all the bytes from the passed ReadBuffer object. This is functionally equivalent to the following code:
|
void |
writeBuffer(ReadBuffer buf, int of, int cb) Write cb bytes from the passed ReadBuffer object starting at offset of within the passed ReadBuffer.
This is functionally equivalent to the following code:
|
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. 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. |
void |
writePackedLong(long n) 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. |
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. This is functionally equivalent to the following code:
|
void |
writeStream(InputStreaming stream, int cb) Write the specified number of bytes of the specified InputStreaming object. This is functionally equivalent to the following code:
|
Methods inherited from class com.tangosol.io.AbstractWriteBuffer.AbstractBufferOutput |
---|
calcUTF, flush, formatUTF, formatUTF, getBuffer, getCharBuf, getOffset, writeBoolean, writeByte, writeBytes, writeChars, writeSafeUTF, writeUTF, writeUTF |
Constructor Detail |
---|
public MultiBufferWriteBuffer.MultiBufferOutput(int of)
of
- the offset at which to begin writingMethod Detail |
---|
public void write(int b) throws IOException
b
. The 24 high-order bits of b
are ignored.write
in interface OutputStreaming
write
in interface DataOutput
write
in class AbstractWriteBuffer.AbstractBufferOutput
b
- the byte to write (passed as an integer)IOException
- if an I/O error occurspublic void write(byte[] ab) throws IOException
ab
.write
in interface OutputStreaming
write
in interface DataOutput
write
in class AbstractWriteBuffer.AbstractBufferOutput
ab
- the byte array to writeIOException
- if an I/O error occurspublic void write(byte[] ab, int of, int cb) throws IOException
cb
bytes starting at offset of
from the array ab
.write
in interface OutputStreaming
write
in interface DataOutput
write
in class AbstractWriteBuffer.AbstractBufferOutput
ab
- the byte array to write fromof
- the offset into ab
to start writing fromcb
- the number of bytes from ab
to writeIOException
- if an I/O error occurspublic void writeShort(int n) throws IOException
writeShort
in interface WriteBuffer.BufferOutput
writeShort
in interface DataOutput
writeShort
in class AbstractWriteBuffer.AbstractBufferOutput
n
- the short to write (passed as an integer)IOException
- if an I/O error occurspublic void writeChar(int ch) throws IOException
writeChar
in interface WriteBuffer.BufferOutput
writeChar
in interface DataOutput
writeChar
in class AbstractWriteBuffer.AbstractBufferOutput
ch
- the char to write (passed as an integer)IOException
- if an I/O error occurspublic void writeInt(int n) throws IOException
writeInt
in interface WriteBuffer.BufferOutput
writeInt
in interface DataOutput
writeInt
in class AbstractWriteBuffer.AbstractBufferOutput
n
- the int to writeIOException
- if an I/O error occurspublic void 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.
writePackedInt
in interface WriteBuffer.BufferOutput
writePackedInt
in class AbstractWriteBuffer.AbstractBufferOutput
n
- an int value to writeIOException
- if an I/O error occurspublic void writeLong(long l) throws IOException
writeLong
in interface WriteBuffer.BufferOutput
writeLong
in interface DataOutput
writeLong
in class AbstractWriteBuffer.AbstractBufferOutput
l
- the long to writeIOException
- if an I/O error occurspublic void writePackedLong(long n) 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.
writePackedLong
in interface WriteBuffer.BufferOutput
writePackedLong
in class AbstractWriteBuffer.AbstractBufferOutput
n
- a long value to writeIOException
- if an I/O error occurspublic void writeFloat(float fl) throws IOException
writeFloat
in interface WriteBuffer.BufferOutput
writeFloat
in interface DataOutput
writeFloat
in class AbstractWriteBuffer.AbstractBufferOutput
fl
- the float to writeIOException
- if an I/O error occurspublic void writeDouble(double dfl) throws IOException
writeDouble
in interface WriteBuffer.BufferOutput
writeDouble
in interface DataOutput
writeDouble
in class AbstractWriteBuffer.AbstractBufferOutput
dfl
- the double to writeIOException
- if an I/O error occurspublic void writeBuffer(ReadBuffer buf) throws IOException
This is functionally equivalent to the following code:
getBuffer().write(getOffset(), buf);
writeBuffer
in interface WriteBuffer.BufferOutput
writeBuffer
in class AbstractWriteBuffer.AbstractBufferOutput
buf
- a ReadBuffer objectIOException
- if an I/O error occurspublic void 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);
writeBuffer
in interface WriteBuffer.BufferOutput
writeBuffer
in class AbstractWriteBuffer.AbstractBufferOutput
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 occurspublic void writeStream(InputStreaming stream) throws IOException
This is functionally equivalent to the following code:
getBuffer().write(getOffset(), stream);
writeStream
in interface WriteBuffer.BufferOutput
writeStream
in class AbstractWriteBuffer.AbstractBufferOutput
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 streampublic void writeStream(InputStreaming stream, int cb) throws IOException
This is functionally equivalent to the following code:
getBuffer().write(getOffset(), stream, cb);
writeStream
in interface WriteBuffer.BufferOutput
writeStream
in class AbstractWriteBuffer.AbstractBufferOutput
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 streampublic void setOffset(int of)
setOffset
in interface WriteBuffer.BufferOutput
setOffset
in class AbstractWriteBuffer.AbstractBufferOutput
of
- the offset of the next byte to write to the WriteBufferpublic void close() throws IOException
close
in interface OutputStreaming
close
in interface WriteBuffer.BufferOutput
close
in interface Closeable
close
in class AbstractWriteBuffer.AbstractBufferOutput
IOException
- if an I/O error occursprotected WriteBuffer.BufferOutput getOut()
protected boolean hasRemaining(int cb)
cb
- the length to writeprotected void adjust(int cb)
cb
- the number of bytes that were just written directly to the underlying BufferOutputprotected void advance()
protected void sync()
|
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 |