net.openhft.hashing

Class ByteBufferAccess

java.lang.Object

net.openhft.hashing.Access<ByteBuffer>

net.openhft.hashing.ByteBufferAccess

public final class ByteBufferAccess
extends Access<ByteBuffer>

Field Summary

Fields

Modifier and Type	Field and Description
static ByteBufferAccess	INSTANCE

Method Summary

Modifier and Type	Method and Description
ByteOrder	byteOrder(ByteBuffer input) The byte order in which all multi-byte getXXX() reads from the given input are performed.
int	getByte(ByteBuffer input, long offset) Reads a single byte at the given offset in the byte sequence represented by the given input, returned widened to int.
int	getInt(ByteBuffer input, long offset) Reads [offset, offset + 3] bytes of the byte sequence represented by the given input as a single int value.
long	getLong(ByteBuffer input, long offset) Reads [offset, offset + 7] bytes of the byte sequence represented by the given input as a single long value.
int	getShort(ByteBuffer input, long offset) Reads [offset, offset + 1] bytes of the byte sequence represented by the given input as a single short value, returned widened to int.
int	getUnsignedByte(ByteBuffer input, long offset) Shortcut for getByte(input, offset) & 0xFF.
long	getUnsignedInt(ByteBuffer input, long offset) Shortcut for getInt(input, offset) & 0xFFFFFFFFL.
int	getUnsignedShort(ByteBuffer input, long offset) Shortcut for getShort(input, offset) & 0xFFFF.
protected Access<ByteBuffer>	reverseAccess() Get the Access object with a different byte order.

Methods inherited from class net.openhft.hashing.Access

byteOrder, i16, i32, i64, i8, toByteBuffer, toCharSequence, toNativeCharSequence, u16, u32, u8, unsafe

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static final ByteBufferAccess INSTANCE

Method Detail

getLong

public long getLong(ByteBuffer input,
                    long offset)

Description copied from class: Access

Reads [offset, offset + 7] bytes of the byte sequence represented by the given input as a single long value.

Overrides:

getLong in class Access<ByteBuffer>

Parameters:

input - the object to access

offset - offset to the first byte to read within the byte sequence represented by the given object

Returns:

eight bytes as a long value, in the expected order

getUnsignedInt

public long getUnsignedInt(ByteBuffer input,
                           long offset)

Description copied from class: Access

Shortcut for getInt(input, offset) & 0xFFFFFFFFL. Could be implemented more efficiently.

Overrides:

getUnsignedInt in class Access<ByteBuffer>

Parameters:

input - the object to access

offset - offset to the first byte to read within the byte sequence represented by the given object

Returns:

four bytes as an unsigned int value, in the expected order

getInt

public int getInt(ByteBuffer input,
                  long offset)

Description copied from class: Access

Reads [offset, offset + 3] bytes of the byte sequence represented by the given input as a single int value.

Overrides:

getInt in class Access<ByteBuffer>

Parameters:

input - the object to access

offset - offset to the first byte to read within the byte sequence represented by the given object

Returns:

four bytes as an int value, in the expected order

getUnsignedShort

public int getUnsignedShort(ByteBuffer input,
                            long offset)

Description copied from class: Access

Shortcut for getShort(input, offset) & 0xFFFF. Could be implemented more efficiently.

Overrides:

getUnsignedShort in class Access<ByteBuffer>

Parameters:

input - the object to access

offset - offset to the first byte to read within the byte sequence represented by the given object

Returns:

two bytes as an unsigned short value, in the expected order

getShort

public int getShort(ByteBuffer input,
                    long offset)

Description copied from class: Access

Reads [offset, offset + 1] bytes of the byte sequence represented by the given input as a single short value, returned widened to int.

Overrides:

getShort in class Access<ByteBuffer>

Parameters:

input - the object to access

offset - offset to the first byte to read within the byte sequence represented by the given object

Returns:

two bytes as a short value, in the expected order, widened to int

getUnsignedByte

public int getUnsignedByte(ByteBuffer input,
                           long offset)

Description copied from class: Access

Shortcut for getByte(input, offset) & 0xFF. Could be implemented more efficiently.

Overrides:

getUnsignedByte in class Access<ByteBuffer>

Parameters:

input - the object to access

offset - offset to the byte to read within the byte sequence represented by the given object

Returns:

a byte by the given offset, interpreted as unsigned

getByte

public int getByte(ByteBuffer input,
                   long offset)

Description copied from class: Access

Reads a single byte at the given offset in the byte sequence represented by the given input, returned widened to int.

Specified by:

getByte in class Access<ByteBuffer>

Parameters:

input - the object to access

offset - offset to the byte to read within the byte sequence represented by the given object

Returns:

a byte by the given offset, widened to int

byteOrder

public ByteOrder byteOrder(ByteBuffer input)

Description copied from class: Access

The byte order in which all multi-byte getXXX() reads from the given input are performed.

Specified by:

byteOrder in class Access<ByteBuffer>

Parameters:

input - the accessed object

Returns:

the byte order of all multi-byte reads from the given input

reverseAccess

protected Access<ByteBuffer> reverseAccess()

Description copied from class: Access

Get the Access object with a different byte order. This method should always return a fixed reference.

Specified by:

reverseAccess in class Access<ByteBuffer>