|
Oracle® Coherence Java API Reference Release 3.7.1.0 E22843-01 |
|||||||
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.AbstractReadBuffer
com.tangosol.io.AbstractByteArrayReadBuffer
public abstract class AbstractByteArrayReadBuffer
The AbstractByteArrayReadBuffer abstract class is intended to serve as a base class for the following:
This implementation is not intended to be thread safe.
Nested Class Summary | |
---|---|
class |
AbstractByteArrayReadBuffer.ByteArrayBufferInput This is a simple implementation of the BufferInput interface on top of a byte array. |
Nested classes/interfaces inherited from class com.tangosol.io.AbstractReadBuffer |
---|
AbstractReadBuffer.AbstractBufferInput |
Nested classes/interfaces inherited from interface com.tangosol.io.ReadBuffer |
---|
ReadBuffer.BufferInput |
Field Summary | |
---|---|
protected byte[] |
m_ab The byte array that holds the binary data. |
protected int |
m_cb Number of bytes in the byte array that belong to this ReadBuffer object. |
protected int |
m_of Offset into the byte array at which the binary data is located. |
Fields inherited from class com.tangosol.io.AbstractReadBuffer |
---|
NO_BINARY, NO_BYTES |
Constructor Summary | |
---|---|
protected |
AbstractByteArrayReadBuffer() Default constructor; intended for deserialization use by subclasses. |
protected |
AbstractByteArrayReadBuffer(byte[] ab, int of, int cb) Construct an AbstractByteArrayReadBuffer on a portion of a byte array. |
Method Summary | |
---|---|
byte |
byteAt(int of) Returns the byte at the specified offset. |
void |
copyBytes(int ofBegin, int ofEnd, byte[] abDest, int ofDest) Copies bytes from this ReadBuffer into the destination byte array. |
boolean |
equals(java.lang.Object o) Compare two ReadBuffer objects for equality. |
protected ReadBuffer.BufferInput |
instantiateBufferInput() Factory method: Instantiate a BufferInput object to read data from the ReadBuffer. |
protected abstract boolean |
isByteArrayPrivate() Determine if the underlying byte[] should be treated as private data. |
int |
length() Determine the length of the buffer. |
protected void |
resetRange(int of, int cb) Reset the portion of the byte array the ReadBuffer operates upon. |
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(int of, int cb) Get a portion of the contents of the ReadBuffer as a byte array. |
Methods inherited from class com.tangosol.io.AbstractReadBuffer |
---|
checkBounds, clone, getBufferInput, getReadBuffer, instantiateReadBuffer, subSequence, toByteArray |
Field Detail |
---|
protected byte[] m_ab
protected int m_of
protected int m_cb
Constructor Detail |
---|
protected AbstractByteArrayReadBuffer()
Note that this default constructor leaves the buffer in an invalid state.
protected AbstractByteArrayReadBuffer(byte[] ab, int of, int cb)
ab
- a byte arrayof
- an offset into the byte arraycb
- the number of bytes to utilizejava.lang.IndexOutOfBoundsException
- if of
or cb
is negative, or of + cb
is larger than ab.length
java.lang.NullPointerException
- if ab
is null
Method Detail |
---|
public int length()
public 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 bytepublic void 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 topublic byte[] toByteArray(int of, int cb)
This is the equivalent of getReadBuffer(of, cb).toByteArray()
.
toByteArray
in interface ReadBuffer
toByteArray
in class AbstractReadBuffer
of
- the beginning index, inclusivecb
- the number of bytes to include in the resulting byte[]public Binary toBinary()
This is the equivalent of toBinary(0, length())
.
toBinary
in interface ReadBuffer
toBinary
in interface ByteSequence
toBinary
in class AbstractReadBuffer
public Binary toBinary(int of, int cb)
This is the equivalent of getReadBuffer(of, cb).toBinary()
.
toBinary
in interface ReadBuffer
toBinary
in class AbstractReadBuffer
of
- the beginning index, inclusivecb
- the number of bytes to include in the Binary objectpublic boolean equals(java.lang.Object o)
equals
in interface ReadBuffer
equals
in class AbstractReadBuffer
o
- a ReadBuffer objectprotected ReadBuffer.BufferInput instantiateBufferInput()
instantiateBufferInput
in class AbstractReadBuffer
protected void resetRange(int of, int cb)
of
- an offset into the byte arraycb
- the number of bytes to utilizejava.lang.IndexOutOfBoundsException
- if of
or cb
are negative, or of + cb
is larger than the buffer's lengthprotected abstract boolean isByteArrayPrivate()
|
Oracle® Coherence Java API Reference Release 3.7.1.0 E22843-01 |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |