com.tangosol.io

Class AbstractReadBuffer

java.lang.Object

com.tangosol.util.Base

com.tangosol.io.AbstractReadBuffer

All Implemented Interfaces:

ReadBuffer, ByteSequence, HashEncoded, Cloneable

Direct Known Subclasses:

AbstractByteArrayReadBuffer, ByteBufferReadBuffer, MultiBufferReadBuffer

public abstract class AbstractReadBuffer
extends Base
implements ReadBuffer, HashEncoded

Abstract base implementation of the ReadBuffer interface.

Author:

cp 2006.04.17

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	AbstractReadBuffer.AbstractBufferInput This is an implementation of the BufferInput interface that delegates its work back to its ReadBuffer.

Nested classes/interfaces inherited from class com.tangosol.util.Base

Base.LoggingWriter, Base.StackFrame

Nested classes/interfaces inherited from interface com.tangosol.io.ReadBuffer

ReadBuffer.BufferInput

Field Summary

Fields

Modifier and Type	Field and Description
static Binary	NO_BINARY An empty Binary object.
static byte[]	NO_BYTES An empty byte array (by definition immutable).

Fields inherited from class com.tangosol.util.Base

LOG_ALWAYS, LOG_DEBUG, LOG_ERR, LOG_INFO, LOG_MAX, LOG_MIN, LOG_QUIET, LOG_WARN, POWER_0, POWER_G, POWER_K, POWER_M, POWER_T, UNIT_D, UNIT_H, UNIT_M, UNIT_MS, UNIT_NS, UNIT_S, UNIT_US

Fields inherited from interface com.tangosol.util.HashEncoded

UNENCODED

Constructor Summary

Constructors

Constructor and Description
AbstractReadBuffer()

Method Summary

Modifier and Type	Method and Description
protected void	checkBounds(int of, int cb) Check if the specified read is within bounds.
Object	clone() Create a clone of this ReadBuffer object.
boolean	equals(Object o) Compare two ReadBuffer objects for equality.
ReadBuffer.BufferInput	getBufferInput() Get a BufferInput object to read data from this buffer.
int	getEncodedHash() Return the encoded hash value or HashEncoded.UNENCODED if absent.
ReadBuffer	getReadBuffer(int of, int cb) Obtain a ReadBuffer for a portion of this ReadBuffer.
protected abstract ReadBuffer.BufferInput	instantiateBufferInput() Factory method: Instantiate a BufferInput object to read data from the ReadBuffer.
protected abstract ReadBuffer	instantiateReadBuffer(int of, int cb) Factory method: Instantiate a ReadBuffer for a portion of this ReadBuffer.
static int	readPackedInt(ByteSequence bin, int of) Read an int value using a variable-length storage format as described by WriteBuffer.BufferOutput.writePackedInt(int) from the given ByteSequence and offset.
static int	readUnsignedByte(ByteSequence bin, int of) Read an unsigned byte value from the given ByteSequence and offset.
static int	sizeofPackedInt(int n) Return the number of bytes that would be required to store the given int using the variable-length storage format as described by WriteBuffer.BufferOutput.writePackedInt(int).
ByteSequence	subSequence(int ofStart, int ofEnd) Returns a new ByteSequence that is a subsequence of this sequence.
Binary	toBinary() Return a new Binary object that holds the complete contents of this ReadBuffer.
Binary	toBinary(int of, int cb) Return 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.

Methods inherited from class com.tangosol.util.Base

azzert, azzert, azzert, azzertFailed, breakLines, breakLines, capitalize, checkNotEmpty, checkNotNull, checkRange, computeSafeWaitTime, decimalValue, dup, dup, ensureBigDecimal, ensureClassLoader, ensureRuntimeException, ensureRuntimeException, equals, equalsDeep, err, err, err, err, err, escape, formatDateTime, getCallerStackFrame, getCommonMonitor, getCommonMonitor, getCommonMonitor, getContextClassLoader, getContextClassLoader, getDeepMessage, getErr, getLastSafeTimeMillis, getLog, getMaxDecDigits, getMaxHexDigits, getOriginalException, getOut, getProcessRandom, getRandom, getRandomBinary, getRandomBinary, getRandomString, getSafeTimeMillis, getStackFrame, getStackFrames, getStackTrace, getStackTrace, getThreadFactory, getTimeZone, getUpTimeMillis, hashCode, hexValue, indentString, indentString, isDecimal, isHex, isLogEcho, isOctal, log, log, log, log, log, makeInteger, makeLong, makeThread, mod, mod, octalValue, out, out, out, out, out, pad, parseBandwidth, parseBandwidth, parseDelimitedString, parseHex, parseHex, parseMemorySize, parseMemorySize, parsePercentage, parseTime, parseTime, parseTimeNanos, parseTimeNanos, printStackTrace, randomize, randomize, randomize, randomize, read, read, read, read, read, read, read, replace, setErr, setLog, setLogEcho, setOut, sleep, toBandwidthString, toBandwidthString, toCharEscape, toCrc, toCrc, toCrc, toCrc, toCrc, toDecString, toDelimitedString, toDelimitedString, toDelimitedString, toDelimitedString, toHex, toHex, toHexDump, toHexEscape, toHexEscape, toHexEscape, toHexEscape, toHexString, toMemorySizeString, toMemorySizeString, toQuotedCharEscape, toQuotedStringEscape, toSqlString, toString, toString, toStringEscape, toUnicodeEscape, trace, trace, trace, trace, trace, trace, trace, trace, trace, truncateString, truncateString, wait

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.tangosol.io.ReadBuffer

byteAt, copyBytes, length, toByteBuffer, toByteBuffer, writeTo, writeTo, writeTo, writeTo, writeTo, writeTo

Field Detail

NO_BYTES

public static final byte[] NO_BYTES

An empty byte array (by definition immutable).

NO_BINARY

public static final Binary NO_BINARY

An empty Binary object.

Constructor Detail

AbstractReadBuffer

public AbstractReadBuffer()

Method Detail

getBufferInput

public ReadBuffer.BufferInput getBufferInput()

Get a BufferInput object to read data from this buffer. Note that each call to this method will return a new BufferInput object, with the possible exception being that a zero-length ReadBuffer could always return the same instance (since there is nothing to read).

Specified by:

getBufferInput in interface ReadBuffer

Returns:

a BufferInput that is reading from this buffer starting at offset zero

getReadBuffer

public ReadBuffer getReadBuffer(int of,
                                int cb)

Obtain a ReadBuffer for a portion of this ReadBuffer.

Specified by:

getReadBuffer in interface ReadBuffer

Parameters:

of - the beginning index, inclusive

cb - the number of bytes to include in the resulting ReadBuffer

Returns:

a ReadBuffer that represents a portion of this ReadBuffer

toByteArray

public byte[] toByteArray()

Get the contents of the ReadBuffer as a byte array.

This is the equivalent of toByteArray(0, length()).

Specified by:

toByteArray in interface ReadBuffer

Returns:

a byte[] with the contents of this ReadBuffer object

toByteArray

public byte[] toByteArray(int of,
                          int cb)

Get a portion of the contents of the ReadBuffer as a byte array.

This method is an equivalent of getReadBuffer(of, cb).toByteArray().

Specified by:

toByteArray in interface ReadBuffer

Parameters:

of - the beginning index, inclusive

cb - the number of bytes to include in the resulting byte[]

Returns:

a byte[] containing the specified portion of this ReadBuffer

toBinary

public Binary toBinary()

Return a new Binary object that holds the complete contents of this ReadBuffer.

This is the equivalent of toBinary(0, length()).

Specified by:

toBinary in interface ReadBuffer

Specified by:

toBinary in interface ByteSequence

Returns:

the contents of this ReadBuffer as a Binary object

toBinary

public Binary toBinary(int of,
                       int cb)

Return a Binary object that holds the specified portion of this ReadBuffer.

This method is an equivalent of getReadBuffer(of, cb).toBinary().

Specified by:

toBinary in interface ReadBuffer

Parameters:

of - the beginning index, inclusive

cb - the number of bytes to include in the Binary object

Returns:

a Binary object containing the specified portion of this ReadBuffer

subSequence

public ByteSequence subSequence(int ofStart,
                                int ofEnd)

Returns a new ByteSequence that is a subsequence of this sequence. The subsequence starts with the byte value at the specified index and ends with the byte value at index ofEnd - 1. The length (in bytes) of the returned sequence is ofEnd - ofStart, so if ofStart == ofEnd then an empty sequence is returned.

Specified by:

subSequence in interface ReadBuffer

Specified by:

subSequence in interface ByteSequence

Parameters:

ofStart - the start index, inclusive

ofEnd - the end index, exclusive

Returns:

the specified subsequence

Since:

Coherence 3.7

getEncodedHash

public int getEncodedHash()

Return the encoded hash value or HashEncoded.UNENCODED if absent.

Specified by:

getEncodedHash in interface HashEncoded

Returns:

the encoded hash value or HashEncoded.UNENCODED if absent

equals

public boolean equals(Object o)

Compare two ReadBuffer objects for equality.

Specified by:

equals in interface ReadBuffer

Overrides:

equals in class Object

Parameters:

o - a ReadBuffer object

Returns:

true iff the other ReadBuffer is identical to this

clone

public Object clone()

Create a clone of this ReadBuffer object.

Specified by:

clone in interface ReadBuffer

Overrides:

clone in class Object

Returns:

a ReadBuffer object with the same contents as this ReadBuffer object

instantiateReadBuffer

protected abstract ReadBuffer instantiateReadBuffer(int of,
                                                    int cb)

Factory method: Instantiate a ReadBuffer for a portion of this ReadBuffer.

Parameters:

of - the beginning index, inclusive

cb - the number of bytes to include in the resulting ReadBuffer

Returns:

a ReadBuffer that represents a portion of this ReadBuffer

instantiateBufferInput

protected abstract ReadBuffer.BufferInput instantiateBufferInput()

Factory method: Instantiate a BufferInput object to read data from the ReadBuffer.

Returns:

a new BufferInput reading from this ReadBuffer

checkBounds

protected void checkBounds(int of,
                           int cb)

Check if the specified read is within bounds.

Parameters:

of - the absolute offset of the read operation

cb - the length in bytes of the read operation

Throws:

IndexOutOfBoundsException - if the specified read is not within bounds

readUnsignedByte

public static int readUnsignedByte(ByteSequence bin,
                                   int of)

Read an unsigned byte value from the given ByteSequence and offset.

This method is the counterpart for the DataOutput.writeByte(int) method when it is used with unsigned 8-bit values.

Parameters:

bin - the byte sequence

of - the offset

Returns:

an int value in the range 0x00 to 0xFF

readPackedInt

public static int readPackedInt(ByteSequence bin,
                                int of)

Read an int value using a variable-length storage format as described by WriteBuffer.BufferOutput.writePackedInt(int) from the given ByteSequence and offset.

Parameters:

bin - the byte sequence

of - the offset

Returns:

an int value

sizeofPackedInt

public static int sizeofPackedInt(int n)

Return the number of bytes that would be required to store the given int using the variable-length storage format as described by WriteBuffer.BufferOutput.writePackedInt(int).

Parameters:

n - the integer that will be stored as a packed int

Returns:

the number of bytes required to store the packed int