net.kuujo.catalyst.buffer

Interface BytesInput<T extends BytesInput<T>>

All Known Subinterfaces:

Buffer, Bytes

All Known Implementing Classes:

AbstractBuffer, AbstractBytes, DirectBuffer, DirectBytes, FileBuffer, FileBytes, HeapBuffer, HeapBytes, MappedBuffer, MappedBytes, NativeBuffer, NativeBytes, ReadOnlyBuffer, SlicedBuffer, SwappedBuffer, SwappedBytes, WrappedBytes

public interface BytesInput<T extends BytesInput<T>>

Readable bytes.

This interface exposes methods for reading bytes from specific positions in a byte array.

Author:

Jordan Halterman

Method Summary

Modifier and Type	Method and Description
T	read(long offset, byte[] dst, long dstOffset, long length) Reads bytes into the given byte array starting at the given offset up to the given length.
T	read(long offset, Bytes dst, long dstOffset, long length) Reads bytes into the given byte array starting at the given offset up to the given length.
boolean	readBoolean(long offset) Reads a 1 byte boolean from the buffer at the given offset.
int	readByte(long offset) Reads a byte from the buffer at the given offset.
char	readChar(long offset) Reads a 16-bit character from the buffer at the given offset.
double	readDouble(long offset) Reads a double-precision 64-bit floating point number from the buffer at the given offset.
float	readFloat(long offset) Reads a single-precision 32-bit floating point number from the buffer at the given offset.
int	readInt(long offset) Reads a 32-bit signed integer from the buffer at the given offset.
long	readLong(long offset) Reads a 64-bit signed integer from the buffer at the given offset.
int	readMedium(long offset) Reads a 24-bit signed integer from the buffer at the given offset.
short	readShort(long offset) Reads a 16-bit signed integer from the buffer at the given offset.
String	readString(long offset) Reads a string from the buffer at the given offset.
int	readUnsignedByte(long offset) Reads an unsigned byte from the buffer at the given offset.
long	readUnsignedInt(long offset) Reads a 32-bit unsigned integer from the buffer at the given offset.
int	readUnsignedMedium(long offset) Reads a 24-bin unsigned integer from the buffer at the given offset.
int	readUnsignedShort(long offset) Reads a 16-bit unsigned integer from the buffer at the given offset.
String	readUTF8(long offset) Reads a UTF-8 string from the buffer at the given offset.

Method Detail

read

T read(long offset,
       Bytes dst,
       long dstOffset,
       long length)

Reads bytes into the given byte array starting at the given offset up to the given length.

Parameters:

offset - The offset from which to start reading bytes.

dst - The byte array into which to read bytes.

dstOffset - The offset at which to write bytes into the given buffer.

length - The total number of bytes to read.

Returns:

The buffer.

read

T read(long offset,
       byte[] dst,
       long dstOffset,
       long length)

Reads bytes into the given byte array starting at the given offset up to the given length.

Parameters:

offset - The offset from which to start reading bytes.

dst - The byte array into which to read bytes.

dstOffset - The offset at which to write bytes into the given buffer

length - The total number of bytes to read.

Returns:

The buffer.

readByte

int readByte(long offset)

Reads a byte from the buffer at the given offset.

Parameters:

offset - The offset at which to read the byte.

Returns:

The read byte.

readUnsignedByte

int readUnsignedByte(long offset)

Reads an unsigned byte from the buffer at the given offset.

Parameters:

offset - The offset at which to read the byte.

Returns:

The read unsigned byte.

readChar

char readChar(long offset)

Reads a 16-bit character from the buffer at the given offset.

Parameters:

offset - The offset at which to read the character.

Returns:

The read character.

readShort

short readShort(long offset)

Reads a 16-bit signed integer from the buffer at the given offset.

Parameters:

offset - The offset at which to read the short.

Returns:

The read short.

readUnsignedShort

int readUnsignedShort(long offset)

Reads a 16-bit unsigned integer from the buffer at the given offset.

Parameters:

offset - The offset at which to read the short.

Returns:

The read short.

readMedium

int readMedium(long offset)

Reads a 24-bit signed integer from the buffer at the given offset.

Parameters:

offset - The offset at which to read the integer.

Returns:

The read medium.

readUnsignedMedium

int readUnsignedMedium(long offset)

Reads a 24-bin unsigned integer from the buffer at the given offset.

Parameters:

offset - The offset at which to read the integer.

Returns:

The read medium.

readInt

int readInt(long offset)

Reads a 32-bit signed integer from the buffer at the given offset.

Parameters:

offset - The offset at which to read the integer.

Returns:

The read integer.

readUnsignedInt

long readUnsignedInt(long offset)

Reads a 32-bit unsigned integer from the buffer at the given offset.

Parameters:

offset - The offset at which to read the integer.

Returns:

The read integer.

readLong

long readLong(long offset)

Reads a 64-bit signed integer from the buffer at the given offset.

Parameters:

offset - The offset at which to read the long.

Returns:

The read long.

readFloat

float readFloat(long offset)

Reads a single-precision 32-bit floating point number from the buffer at the given offset.

Parameters:

offset - The offset at which to read the float.

Returns:

The read float.

readDouble

double readDouble(long offset)

Reads a double-precision 64-bit floating point number from the buffer at the given offset.

Parameters:

offset - The offset at which to read the double.

Returns:

The read double.

readBoolean

boolean readBoolean(long offset)

Reads a 1 byte boolean from the buffer at the given offset.

Parameters:

offset - The offset at which to read the boolean.

Returns:

The read boolean.

readString

String readString(long offset)

Reads a string from the buffer at the given offset.

Parameters:

offset - The offset at which to read the string.

Returns:

The read string.

readUTF8

String readUTF8(long offset)

Reads a UTF-8 string from the buffer at the given offset.

Parameters:

offset - The offset at which to read the string.

Returns:

The read string.