io.atomix.storage.buffer

Interface BufferInput<T extends BufferInput<?>>

All Superinterfaces:

AutoCloseable

All Known Subinterfaces:

Buffer

All Known Implementing Classes:

AbstractBuffer, ByteBufferBuffer, DirectBuffer, FileBuffer, HeapBuffer, MappedBuffer, NativeBuffer, ReadOnlyBuffer, SlicedBuffer, SwappedBuffer, UnsafeDirectBuffer, UnsafeHeapBuffer, UnsafeMappedBuffer

public interface BufferInput<T extends BufferInput<?>>
extends AutoCloseable

Readable buffer.

This interface exposes methods for reading from a byte buffer. Readable buffers maintain a small amount of state regarding current cursor positions and limits similar to the behavior of ByteBuffer.

Author:

Jordan Halterman

Method Summary

Modifier and Type	Method and Description
void	close()
boolean	hasRemaining() Returns a boolean value indicating whether the input has bytes remaining.
int	position() Returns the buffer's current read/write position.
T	read(Buffer buffer) Reads bytes into the given buffer.
T	read(byte[] bytes) Reads bytes into the given byte array.
T	read(byte[] bytes, int offset, int length) Reads bytes into the given byte array starting at current position up to the given length.
T	read(Bytes bytes) Reads bytes into the given byte array.
T	read(Bytes bytes, int offset, int length) Reads bytes into the given byte array starting at the current position.
boolean	readBoolean() Reads a 1 byte boolean from the buffer at the current position.
int	readByte() Reads a byte from the buffer at the current position.
default byte[]	readBytes(int length) Reads a byte array.
char	readChar() Reads a 16-bit character from the buffer at the current position.
double	readDouble() Reads a double-precision 64-bit floating point number from the buffer at the current position.
float	readFloat() Reads a single-precision 32-bit floating point number from the buffer at the current position.
int	readInt() Reads a 32-bit signed integer from the buffer at the current position.
long	readLong() Reads a 64-bit signed integer from the buffer at the current position.
int	readMedium() Reads a 24-bit signed integer from the buffer at the current position.
short	readShort() Reads a 16-bit signed integer from the buffer at the current position.
String	readString() Reads a string from the buffer at the current position.
String	readString(Charset charset) Reads a string from the buffer at the current position.
int	readUnsignedByte() Reads an unsigned byte from the buffer at the current position.
long	readUnsignedInt() Reads a 32-bit unsigned integer from the buffer at the current position.
int	readUnsignedMedium() Reads a 24-bit unsigned integer from the buffer at the current position.
int	readUnsignedShort() Reads a 16-bit unsigned integer from the buffer at the current position.
String	readUTF8() Reads a UTF-8 string from the buffer at the current position.
int	remaining() Returns the number of bytes remaining in the input.
T	skip(int bytes) Skips the given number of bytes in the input.

Method Detail

position

int position()

Returns the buffer's current read/write position.

The position is an internal cursor that tracks where to write/read bytes in the underlying storage implementation. As bytes are written to or read from the buffer, the position will advance based on the number of bytes read.

Returns:

The buffer's current position.

remaining

int remaining()

Returns the number of bytes remaining in the input.

Returns:

The number of bytes remaining in the input.

hasRemaining

boolean hasRemaining()

Returns a boolean value indicating whether the input has bytes remaining.

Returns:

Indicates whether bytes remain to be read from the input.

skip

T skip(int bytes)

Skips the given number of bytes in the input.

Parameters:

bytes - The number of bytes to attempt to skip.

Returns:

The skipped input.

read

T read(Bytes bytes)

Reads bytes into the given byte array.

Parameters:

bytes - The byte array into which to read bytes.

Returns:

The buffer.

read

T read(byte[] bytes)

Reads bytes into the given byte array.

Parameters:

bytes - The byte array into which to read bytes.

Returns:

The buffer.

read

T read(Bytes bytes,
       int offset,
       int length)

Reads bytes into the given byte array starting at the current position.

Parameters:

bytes - The byte array into which to read bytes.

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

Returns:

The buffer.

read

T read(byte[] bytes,
       int offset,
       int length)

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

Parameters:

bytes - The byte array into which to read bytes.

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

Returns:

The buffer.

read

T read(Buffer buffer)

Reads bytes into the given buffer.

Parameters:

buffer - The buffer into which to read bytes.

Returns:

The buffer.

readBytes

default byte[] readBytes(int length)

Reads a byte array.

Parameters:

length - The byte array length

Returns:

The read byte array.

readByte

int readByte()

Reads a byte from the buffer at the current position.

Returns:

The read byte.

readUnsignedByte

int readUnsignedByte()

Reads an unsigned byte from the buffer at the current position.

Returns:

The read byte.

readChar

char readChar()

Reads a 16-bit character from the buffer at the current position.

Returns:

The read character.

readShort

short readShort()

Reads a 16-bit signed integer from the buffer at the current position.

Returns:

The read short.

readUnsignedShort

int readUnsignedShort()

Reads a 16-bit unsigned integer from the buffer at the current position.

Returns:

The read short.

readMedium

int readMedium()

Reads a 24-bit signed integer from the buffer at the current position.

Returns:

The read integer.

readUnsignedMedium

int readUnsignedMedium()

Reads a 24-bit unsigned integer from the buffer at the current position.

Returns:

The read integer.

readInt

int readInt()

Reads a 32-bit signed integer from the buffer at the current position.

Returns:

The read integer.

readUnsignedInt

long readUnsignedInt()

Reads a 32-bit unsigned integer from the buffer at the current position.

Returns:

The read integer.

readLong

long readLong()

Reads a 64-bit signed integer from the buffer at the current position.

Returns:

The read long.

readFloat

float readFloat()

Reads a single-precision 32-bit floating point number from the buffer at the current position.

Returns:

The read float.

readDouble

double readDouble()

Reads a double-precision 64-bit floating point number from the buffer at the current position.

Returns:

The read double.

readBoolean

boolean readBoolean()

Reads a 1 byte boolean from the buffer at the current position.

Returns:

The read boolean.

readString

String readString()

Reads a string from the buffer at the current position.

Returns:

The read string.

readString

String readString(Charset charset)

Reads a string from the buffer at the current position.

Parameters:

charset - The character set with which to decode the string.

Returns:

The read string.

readUTF8

String readUTF8()

Reads a UTF-8 string from the buffer at the current position.

Returns:

The read string.

close

void close()

Specified by:

close in interface AutoCloseable