|
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 interface ReadBuffer
The ReadBuffer interface represents an in-memory block of binary data, such as that represented by a byte[], a Binary object, or an NIO buffer.
Nested Class Summary | |
---|---|
static interface |
ReadBuffer.BufferInput The BufferInput interface represents a DataInputStream on top of a ReadBuffer. |
Method Summary | |
---|---|
byte |
byteAt(int of) Returns the byte at the specified offset. |
Object |
clone() Create a clone of this ReadBuffer object. |
void |
copyBytes(int ofBegin, int ofEnd, byte[] abDest, int ofDest) Copies bytes from this ReadBuffer into the destination byte array. |
boolean |
equals(Object o) Compare two ReadBuffer objects for equality. |
ReadBuffer.BufferInput |
getBufferInput() Get a BufferInput object to read data from this buffer. |
ReadBuffer |
getReadBuffer(int of, int cb) Obtain a ReadBuffer for a portion of this ReadBuffer. |
int |
length() Determine the length of the buffer. |
Binary |
toBinary() Returns a new Binary object that holds the complete contents of this ReadBuffer. |
Binary |
toBinary(int of, int cb) Returns a Binary object that holds the specified portion of this ReadBuffer. |
byte[] |
toByteArray() Get the contents of the ReadBuffer as a byte array. |
byte[] |
toByteArray(int of, int cb) Get a portion of the contents of the ReadBuffer as a byte array. |
Method Detail |
---|
int length()
byte byteAt(int of)
0
to length() - 1
. The first byte of the sequence is at offset 0
, the next at offset 1
, and so on, as for array indexing.of
- the offset (index) of the byteIndexOutOfBoundsException
- if the of
argument is negative or not less than the length of this ReadBuffervoid copyBytes(int ofBegin, int ofEnd, byte[] abDest, int ofDest)
The first byte to be copied is at offset ofBegin
; the last byte to be copied is at offset ofEnd-1
(thus the total number of bytes to be copied is ofEnd - ofBegin
). The bytes are copied into the subarray of abDest
starting at offset ofDest
and ending at index:
ofDest + (ofEnd - ofBegin) - 1
This method is the ReadBuffer equivalent of String.getChars(int, int, char[], int)
. It allows the caller to extract a chunk of bytes into the caller's own array.
ofBegin
- offset of the first byte in the ReadBuffer to copyofEnd
- offset after the last byte in the ReadBuffer to copyabDest
- the destination byte arrayofDest
- the offset in the destination byte array to copy the first byte toIndexOutOfBoundsException
- Thrown if any of the following is true:
ofBegin
is negative;ofBegin
is greater than ofEnd
ofEnd
is greater than the length of this ReadBuffer;ofDest
is negativeofDest + (ofEnd - ofBegin)
is larger than abDest.length
NullPointerException
- if abDest
is null
ReadBuffer.BufferInput getBufferInput()
ReadBuffer getReadBuffer(int of, int cb)
of
- the beginning index, inclusivecb
- the number of bytes to include in the resulting ReadBufferIndexOutOfBoundsException
- if of
or cb
is negative, or of + cb
is larger than the length of this ReadBuffer
objectbyte[] toByteArray()
This is the equivalent of toByteArray(0, length())
.
byte[] toByteArray(int of, int cb)
This is the equivalent of getReadBuffer(of, cb).toByteArray()
.
of
- the beginning index, inclusivecb
- the number of bytes to include in the resulting byte[]IndexOutOfBoundsException
- if of
or cb
is negative, or of + cb
is larger than the length of this ReadBuffer
objectBinary toBinary()
This is the equivalent of toBinary(0, length())
.
Binary toBinary(int of, int cb)
This is the equivalent of getReadBuffer(of, cb).toBinary()
.
of
- the beginning index, inclusivecb
- the number of bytes to include in the Binary objectIndexOutOfBoundsException
- if of
or cb
is negative, or of + cb
is larger than the length of this ReadBuffer
objectboolean equals(Object o)
o
- a ReadBuffer objectObject clone()
|
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 |