io.atomix.storage.buffer

Interface Buffer

All Superinterfaces:

AutoCloseable, BufferInput<Buffer>, BufferOutput<Buffer>, BytesInput<Buffer>, BytesOutput<Buffer>, io.atomix.utils.concurrent.ReferenceCounted<Buffer>

All Known Implementing Classes:

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

public interface Buffer
extends BytesInput<Buffer>, BufferInput<Buffer>, BytesOutput<Buffer>, BufferOutput<Buffer>, io.atomix.utils.concurrent.ReferenceCounted<Buffer>

Navigable byte buffer for input/output operations.

The byte buffer provides a fluent interface for reading bytes from and writing bytes to some underlying storage implementation. The Buffer type is agnostic about the specific underlying storage implementation, but different buffer implementations may be designed for specific storage layers.

Aside from the underlying storage implementation, this buffer works very similarly to Java's ByteBuffer. It intentionally exposes methods that can be easily understood by any developer with experience with ByteBuffer.

In order to support reading and writing from buffers, Buffer implementations maintain a series of pointers to aid in navigating the buffer.

Most notable of these pointers is the position. When values are written to or read from the buffer, the buffer increments its internal position according to the number of bytes read. This allows users to iterate through the bytes in the buffer without maintaining external pointers.

   
      try (Buffer buffer = DirectBuffer.allocate(1024)) {
        buffer.writeInt(1);
        buffer.flip();
        assert buffer.readInt() == 1;
      }
   
 

Buffers implement ReferenceCounted in order to keep track of the number of currently held references to a given buffer. When a buffer is constructed, the buffer contains only 1 reference. This reference can be released via the close() method which can be called automatically by using a try-with-resources statement demonstrated above. Additional references to the buffer should be acquired via ReferenceCounted.acquire() and released via ReferenceCounted.release(). Once all references to a buffer have been released - including the initial reference - the memory will be freed (for in-memory buffers) and writes will be automatically flushed to disk (for persistent buffers).

Author:

Jordan Halterman

Method Summary

Modifier and Type	Method and Description
default byte[]	array() Returns the underlying byte array.
Buffer	asReadOnlyBuffer() Returns a read-only view of the buffer.
Bytes	bytes() Returns the bytes underlying the buffer.
int	capacity() Returns the buffer's capacity.
Buffer	capacity(int capacity) Sets the buffer's capacity.
Buffer	clear() Clears the buffer.
void	close() Closes the buffer.
Buffer	compact() Compacts the buffer, moving bytes from the current position to the end of the buffer to the head of the buffer.
Buffer	duplicate() Returns a duplicate of the buffer.
Buffer	flip() Flips the buffer.
default boolean	hasArray() Returns whether the buffer has an array.
boolean	hasRemaining() Returns a boolean indicating whether the buffer has bytes remaining.
boolean	isDirect() Returns a boolean value indicating whether the buffer is a direct buffer.
boolean	isFile() Returns a boolean value indicating whether the buffer is backed by a file.
boolean	isReadOnly() Returns a boolean value indicating whether the buffer is a read-only buffer.
int	limit() Returns the buffer's read/write limit.
Buffer	limit(int limit) Sets the buffer's read/write limit.
Buffer	mark() Sets a mark at the current position.
int	maxCapacity() Returns the maximum allowed capacity for the buffer.
int	offset() Returns the buffer's starting offset within the underlying Bytes.
ByteOrder	order() Returns the byte order.
Buffer	order(ByteOrder order) Sets the byte order, returning a new swapped Buffer instance.
Buffer	position(int position) Sets the buffer's current read/write position.
Buffer	read(Buffer buffer) Reads bytes into the given buffer.
Buffer	read(byte[] bytes) Reads bytes into the given byte array.
Buffer	read(byte[] bytes, int offset, int length) Reads bytes into the given byte array starting at current position up to the given length.
Buffer	read(Bytes bytes) Reads bytes into the given byte array.
Buffer	read(Bytes bytes, int dstOffset, int length) Reads bytes into the given byte array starting at the current position.
Buffer	read(int srcOffset, byte[] bytes, int dstOffset, int length) Reads bytes into the given byte array starting at the given offset up to the given length.
Buffer	read(int srcOffset, Bytes bytes, int dstOffset, int length) Reads bytes into the given byte array starting at the given offset up to the given length.
boolean	readBoolean() Reads a 1 byte boolean from the buffer at the current position.
boolean	readBoolean(int offset) Reads a 1 byte boolean from the buffer at the given offset.
int	readByte() Reads a byte from the buffer at the current position.
int	readByte(int offset) Reads a byte from the buffer at the given offset.
char	readChar() Reads a 16-bit character from the buffer at the current position.
char	readChar(int offset) Reads a 16-bit character from the buffer at the given offset.
double	readDouble() Reads a double-precision 64-bit floating point number from the buffer at the current position.
double	readDouble(int offset) Reads a double-precision 64-bit floating point number from the buffer at the given offset.
float	readFloat() Reads a single-precision 32-bit floating point number from the buffer at the current position.
float	readFloat(int offset) Reads a single-precision 32-bit floating point number from the buffer at the given offset.
int	readInt() Reads a 32-bit signed integer from the buffer at the current position.
int	readInt(int offset) Reads a 32-bit signed integer from the buffer at the given offset.
long	readLong() Reads a 64-bit signed integer from the buffer at the current position.
long	readLong(int offset) Reads a 64-bit signed integer from the buffer at the given offset.
short	readShort() Reads a 16-bit signed integer from the buffer at the current position.
short	readShort(int offset) Reads a 16-bit signed integer from the buffer at the given offset.
int	readUnsignedByte() Reads an unsigned byte from the buffer at the current position.
int	readUnsignedByte(int offset) Reads an unsigned byte from the buffer at the given offset.
long	readUnsignedInt() Reads a 32-bit unsigned integer from the buffer at the current position.
long	readUnsignedInt(int offset) Reads a 32-bit unsigned integer from the buffer at the given offset.
int	readUnsignedShort() Reads a 16-bit unsigned integer from the buffer at the current position.
int	readUnsignedShort(int offset) Reads a 16-bit unsigned integer from the buffer at the given offset.
String	readUTF8() Reads a UTF-8 string from the buffer at the current position.
String	readUTF8(int offset) Reads a UTF-8 string from the buffer at the given offset.
int	remaining() Returns the number of bytes remaining in the buffer until the limit() is reached.
Buffer	reset() Resets the buffer's position to the previously-marked position.
Buffer	rewind() Rewinds the buffer.
Buffer	skip(int length) Advances the buffer's position length bytes.
Buffer	slice() Returns a view of this buffer starting at the current position.
Buffer	slice(int length) Returns a view of this buffer of the given length starting at the current position.
Buffer	slice(int offset, int length) Returns a view of this buffer starting at the given offset with the given length.
Buffer	write(Buffer buffer) Writes a buffer to the buffer.
Buffer	write(byte[] bytes) Writes an array of bytes to the buffer.
Buffer	write(byte[] bytes, int offset, int length) Writes an array of bytes to the buffer.
Buffer	write(Bytes bytes) Writes an array of bytes to the buffer.
Buffer	write(Bytes bytes, int offset, int length) Writes an array of bytes to the buffer.
Buffer	write(int offset, byte[] src, int srcOffset, int length) Writes an array of bytes to the buffer.
Buffer	write(int offset, Bytes src, int srcOffset, int length) Writes an array of bytes to the buffer.
Buffer	writeBoolean(boolean b) Writes a 1 byte boolean to the buffer at the current position.
Buffer	writeBoolean(int offset, boolean b) Writes a 1 byte boolean to the buffer at the given offset.
Buffer	writeByte(int b) Writes a byte to the buffer at the current position.
Buffer	writeByte(int offset, int b) Writes a byte to the buffer at the given offset.
Buffer	writeChar(char c) Writes a 16-bit character to the buffer at the current position.
Buffer	writeChar(int offset, char c) Writes a 16-bit character to the buffer at the given offset.
Buffer	writeDouble(double d) Writes a double-precision 64-bit floating point number to the buffer at the current position.
Buffer	writeDouble(int offset, double d) Writes a double-precision 64-bit floating point number to the buffer at the given offset.
Buffer	writeFloat(float f) Writes a single-precision 32-bit floating point number to the buffer at the current position.
Buffer	writeFloat(int offset, float f) Writes a single-precision 32-bit floating point number to the buffer at the given offset.
Buffer	writeInt(int i) Writes a 32-bit signed integer to the buffer at the current position.
Buffer	writeInt(int offset, int i) Writes a 32-bit signed integer to the buffer at the given offset.
Buffer	writeLong(int offset, long l) Writes a 64-bit signed integer to the buffer at the given offset.
Buffer	writeLong(long l) Writes a 64-bit signed integer to the buffer at the current position.
Buffer	writeShort(int offset, short s) Writes a 16-bit signed integer to the buffer at the given offset.
Buffer	writeShort(short s) Writes a 16-bit signed integer to the buffer at the current position.
Buffer	writeUnsignedByte(int b) Writes an unsigned byte to the buffer at the current position.
Buffer	writeUnsignedByte(int offset, int b) Writes an unsigned byte to the buffer at the given offset.
Buffer	writeUnsignedInt(int offset, long i) Writes a 32-bit signed integer to the buffer at the given offset.
Buffer	writeUnsignedInt(long i) Writes a 32-bit signed integer to the buffer at the current position.
Buffer	writeUnsignedShort(int s) Writes a 16-bit signed integer to the buffer at the current position.
Buffer	writeUnsignedShort(int offset, int s) Writes a 16-bit signed integer to the buffer at the given offset.
Buffer	writeUTF8(int offset, String s) Writes a UTF-8 string to the buffer at the given offset.
Buffer	writeUTF8(String s) Writes a UTF-8 string to the buffer at the current position.

Methods inherited from interface io.atomix.storage.buffer.BytesInput

readMedium, readString, readString, readUnsignedMedium

Methods inherited from interface io.atomix.storage.buffer.BufferInput

position, readBytes, readMedium, readString, readString, readUnsignedMedium

Methods inherited from interface io.atomix.storage.buffer.BytesOutput

flush, writeMedium, writeString, writeString, writeUnsignedMedium, zero, zero, zero

Methods inherited from interface io.atomix.storage.buffer.BufferOutput

flush, writeBytes, writeMedium, writeString, writeString, writeUnsignedMedium

Methods inherited from interface io.atomix.utils.concurrent.ReferenceCounted

acquire, references, release

Method Detail

hasArray

default boolean hasArray()

Returns whether the buffer has an array.

Returns:

Whether the buffer has an underlying array.

array

default byte[] array()

Returns the underlying byte array.

Returns:

the underlying byte array

Throws:

UnsupportedOperationException - if a heap array is not supported

order

ByteOrder order()

Returns the byte order.

For consistency with ByteBuffer, all buffer implementations are initially in ByteOrder.BIG_ENDIAN order.

Returns:

The byte order.

order

Buffer order(ByteOrder order)

Sets the byte order, returning a new swapped Buffer instance.

By default, all buffers are read and written in ByteOrder.BIG_ENDIAN order. This provides complete consistency with ByteBuffer. To flip buffers to ByteOrder.LITTLE_ENDIAN order, this buffer's Bytes instance is decorated by a SwappedBytes instance which will reverse read and written bytes using, e.g. Integer.reverseBytes(int).

Parameters:

order - The byte order.

Returns:

The updated buffer.

isDirect

boolean isDirect()

Returns a boolean value indicating whether the buffer is a direct buffer.

Returns:

Indicates whether the buffer is a direct buffer.

isReadOnly

boolean isReadOnly()

Returns a boolean value indicating whether the buffer is a read-only buffer.

Returns:

Indicates whether the buffer is a read-only buffer.

isFile

boolean isFile()

Returns a boolean value indicating whether the buffer is backed by a file.

Returns:

Indicates whether the buffer is backed by a file.

asReadOnlyBuffer

Buffer asReadOnlyBuffer()

Returns a read-only view of the buffer.

The returned buffer will share the underlying Bytes with which buffer, but the buffer's limit, capacity, and position will be independent of this buffer.

Returns:

A read-only buffer.

offset

int offset()

Returns the buffer's starting offset within the underlying Bytes.

The offset is used to calculate the absolute position of the buffer's relative position within the underlying Bytes.

Returns:

The buffer's offset.

capacity

int capacity()

Returns the buffer's capacity.

The capacity represents the total amount of storage space allocated to the buffer by the underlying storage implementation. As bytes are written to the buffer, the buffer's capacity may grow up to maxCapacity().

Returns:

The buffer's capacity.

capacity

Buffer capacity(int capacity)

Sets the buffer's capacity.

The given capacity must be greater than the current capacity and less than or equal to maxCapacity(). When the capacity is changed, the underlying Bytes will be resized via Bytes.resize(int).

Parameters:

capacity - The capacity to which to resize the buffer.

Returns:

The resized buffer.

Throws:

IllegalArgumentException - If the given capacity is less than the current capacity or greater than maxCapacity()

maxCapacity

int maxCapacity()

Returns the maximum allowed capacity for the buffer.

The maximum capacity is the limit up to which this buffer's capacity can be expanded. While the capacity grows, the maximum capacity is fixed from the moment the buffer is created and cannot change.

Returns:

The buffer's maximum capacity.

position

Buffer position(int position)

Sets 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.

Parameters:

position - The position to set.

Returns:

This buffer.

Throws:

IllegalArgumentException - If the given position is less than 0 or more than limit()

limit

int limit()

Returns the buffer's read/write limit.

The limit dictates the highest position to which bytes can be read from or written to the buffer. If the limit is not explicitly set then it will always equal the buffer's maxCapacity. Note that the limit may be set by related methods such as flip()

Returns:

The buffer's limit.

limit

Buffer limit(int limit)

Sets the buffer's read/write limit.

The limit dictates the highest position to which bytes can be read from or written to the buffer. The limit must be within the bounds of the buffer, i.e. greater than 0 and less than or equal to capacity()

Parameters:

limit - The limit to set.

Returns:

This buffer.

Throws:

IllegalArgumentException - If the given limit is less than 0 or more than capacity()

remaining

int remaining()

Returns the number of bytes remaining in the buffer until the limit() is reached.

The bytes remaining is calculated by buffer.limit() - buffer.position(). If no limit is set on the buffer then the maxCapacity will be used.

Specified by:

remaining in interface BufferInput<Buffer>

Returns:

The number of bytes remaining in the buffer.

hasRemaining

boolean hasRemaining()

Returns a boolean indicating whether the buffer has bytes remaining.

If remaining() is greater than 0 then this method will return true, otherwise false

Specified by:

hasRemaining in interface BufferInput<Buffer>

Returns:

Indicates whether bytes are remaining in the buffer. true if remaining() is greater than 0, false otherwise.

flip

Buffer flip()

Flips the buffer.

The limit is set to the current position and then the position is set to zero. If the mark is defined then it is discarded.

   
   assert buffer.writeLong(1234).flip().readLong() == 1234;
   
 

Returns:

This buffer.

mark

Buffer mark()

Sets a mark at the current position.

The mark is a simple internal reference to the buffer's current position. Marks can be used to reset the buffer to a specific position after some operation.

   
   buffer.mark();
   buffer.writeInt(1).writeBoolean(true);
   buffer.reset();
   assert buffer.readInt() == 1;
   
 

Returns:

This buffer.

reset

Buffer reset()

Resets the buffer's position to the previously-marked position.

Invoking this method neither changes nor discards the mark's value.

Returns:

This buffer.

Throws:

InvalidMarkException - If no mark is set.

rewind

Buffer rewind()

Rewinds the buffer. The position is set to zero and the mark is discarded.

Returns:

This buffer.

skip

Buffer skip(int length)

Advances the buffer's position length bytes.

Specified by:

skip in interface BufferInput<Buffer>

Parameters:

length - The number of bytes to advance this buffer's position.

Returns:

This buffer.

Throws:

IndexOutOfBoundsException - If length is greater than remaining()

clear

Buffer clear()

Clears the buffer.

The position is set to zero, the limit is set to the capacity, and the mark is discarded.

Returns:

This buffer.

compact

Buffer compact()

Compacts the buffer, moving bytes from the current position to the end of the buffer to the head of the buffer.

Returns:

This buffer.

duplicate

Buffer duplicate()

Returns a duplicate of the buffer.

Returns:

A duplicate buffer.

bytes

Bytes bytes()

Returns the bytes underlying the buffer.

The buffer is a wrapper around Bytes that handles writing sequences of bytes by tracking positions and limits. This method returns the Bytes that this buffer wraps.

Returns:

The underlying bytes.

slice

Buffer slice()

Returns a view of this buffer starting at the current position.

The returned buffer will contain the same underlying Bytes instance as this buffer, but its pointers will be offset by the current position of this buffer at the time the slice is created. Calls to rewind() and similar methods on the resulting Buffer will result in the buffer's position being reset to the position of this buffer at the time the slice was created.

The returned buffer is reference counted separately from this buffer. Therefore, closing the returned buffer will release the buffer back to the internal buffer poll and will not result in this buffer being closed. Users should always call close() once finished using the buffer slice.

Returns:

A slice of this buffer.

See Also:

slice(int), slice(int, int)

slice

Buffer slice(int length)

Returns a view of this buffer of the given length starting at the current position.

The returned buffer will contain the same underlying Bytes instance as this buffer, but its pointers will be offset by the current position of this buffer at the time the slice is created. Calls to rewind() and similar methods on the resulting Buffer will result in the buffer's position being reset to the position of this buffer at the time the slice was created.

The returned buffer is reference counted separately from this buffer. Therefore, closing the returned buffer will release the buffer back to the internal buffer poll and will not result in this buffer being closed. Users should always call close() once finished using the buffer slice.

Parameters:

length - The length of the slice.

Returns:

A slice of this buffer.

See Also:

slice(), slice(int, int)

slice

Buffer slice(int offset,
             int length)

Returns a view of this buffer starting at the given offset with the given length.

The returned buffer will contain the same underlying Bytes instance as this buffer, but its pointers will be offset by the given offset and its length limited by the given length. Calls to rewind() and similar methods on the resulting Buffer will result in the buffer's position being reset to the given offset.

The returned buffer is reference counted separately from this buffer. Therefore, closing the returned buffer will release the buffer back to the internal buffer poll and will not result in this buffer being closed. Users should always call close() once finished using the buffer slice.

Parameters:

offset - The offset at which to begin the slice.

length - The number of bytes in the slice.

Returns:

The buffer slice.

Throws:

IndexOutOfBoundsException - If the given offset is not contained within the bounds of this buffer

BufferUnderflowException - If the length of the remaining bytes in the buffer is less than length

See Also:

slice(), slice(int)

read

Buffer read(Buffer buffer)

Reads bytes into the given buffer.

Bytes will be read starting at the current buffer position until either limit() has been reached. If remaining() is less than the remaining() of the given buffer, a BufferUnderflowException will be thrown.

Specified by:

read in interface BufferInput<Buffer>

Parameters:

buffer - The buffer into which to read bytes.

Returns:

The buffer.

Throws:

BufferUnderflowException - If the given remaining() is greater than this buffer's remaining()

read

Buffer read(Bytes bytes)

Reads bytes into the given byte array.

Bytes will be read starting at the current buffer position until either the byte array length or the limit() has been reached. If remaining() is less than the length of the given byte array, a BufferUnderflowException will be thrown.

Specified by:

read in interface BufferInput<Buffer>

Parameters:

bytes - The byte array into which to read bytes.

Returns:

The buffer.

Throws:

BufferUnderflowException - If the given byte array's length is greater than remaining()

See Also:

read(Bytes, int, int), read(int, Bytes, int, int)

read

Buffer read(byte[] bytes)

Reads bytes into the given byte array.

Bytes will be read starting at the current buffer position until either the byte array length or the limit() has been reached. If remaining() is less than the length of the given byte array, a BufferUnderflowException will be thrown.

Specified by:

read in interface BufferInput<Buffer>

Parameters:

bytes - The byte array into which to read bytes.

Returns:

The buffer.

Throws:

BufferUnderflowException - If the given byte array's length is greater than remaining()

See Also:

read(byte[], int, int), read(int, byte[], int, int)

read

Buffer read(Bytes bytes,
            int dstOffset,
            int length)

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

Bytes will be read from the current position up to the given length. If the provided length is greater than remaining() then a BufferUnderflowException will be thrown. If the offset is out of bounds of the buffer then an IndexOutOfBoundsException will be thrown.

Specified by:

read in interface BufferInput<Buffer>

Parameters:

bytes - The byte array into which to read bytes.

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

Returns:

The buffer.

Throws:

BufferUnderflowException - If length is greater than remaining()

IndexOutOfBoundsException - If the given offset is out of the bounds of the buffer. Note that bounds are determined by the buffer's limit() rather than capacity.

See Also:

read(Bytes), read(int, Bytes, int, int)

read

Buffer read(int srcOffset,
            Bytes bytes,
            int dstOffset,
            int length)

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

Bytes will be read from the given starting offset up to the given length. If the provided length is greater than - srcOffset then a BufferUnderflowException will be thrown. If the srcOffset is out of bounds of the buffer then an IndexOutOfBoundsException will be thrown.

Specified by:

read in interface BytesInput<Buffer>

Parameters:

srcOffset - The offset from which to start reading bytes.

bytes - 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.

Throws:

BufferUnderflowException - If length is greater than remaining()

IndexOutOfBoundsException - If the given offset is out of the bounds of the buffer. Note that bounds are determined by the buffer's limit() rather than capacity.

See Also:

read(Bytes), read(Bytes, int, int)

read

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

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

Bytes will be read from the current position up to the given length. If the provided length is greater than remaining() then a BufferUnderflowException will be thrown. If the offset is out of bounds of the buffer then an IndexOutOfBoundsException will be thrown.

Specified by:

read in interface BufferInput<Buffer>

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.

Throws:

BufferUnderflowException - If length is greater than remaining()

IndexOutOfBoundsException - If the given offset is out of the bounds of the buffer. Note that bounds are determined by the buffer's limit() rather than capacity.

See Also:

read(byte[]), read(int, byte[], int, int)

read

Buffer read(int srcOffset,
            byte[] bytes,
            int dstOffset,
            int length)

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

Bytes will be read from the given starting offset up to the given length. If the provided length is greater than remaining() then a BufferUnderflowException will be thrown. If the offset is out of bounds of the buffer then an IndexOutOfBoundsException will be thrown.

Specified by:

read in interface BytesInput<Buffer>

Parameters:

srcOffset - The offset from which to start reading bytes.

bytes - 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.

Throws:

BufferUnderflowException - If length is greater than remaining()

IndexOutOfBoundsException - If the given offset is out of the bounds of the buffer. Note that bounds are determined by the buffer's limit() rather than capacity.

See Also:

read(byte[]), read(byte[], int, int)

readByte

int readByte()

Reads a byte from the buffer at the current position.

When the byte is read from the buffer, the buffer's position will be advanced by Bytes.BYTE. If there are no bytes remaining in the buffer then a BufferUnderflowException will be thrown.

Specified by:

readByte in interface BufferInput<Buffer>

Returns:

The read byte.

Throws:

BufferUnderflowException - If remaining() is less than Bytes.BYTE

See Also:

readByte(int)

readByte

int readByte(int offset)

Reads a byte from the buffer at the given offset.

The byte will be read from the given offset. If the given index is out of the bounds of the buffer then a IndexOutOfBoundsException will be thrown.

Specified by:

readByte in interface BytesInput<Buffer>

Parameters:

offset - The offset at which to read the byte.

Returns:

The read byte.

Throws:

IndexOutOfBoundsException - If the given offset is out of the bounds of the buffer. Note that bounds are determined by the buffer's limit() rather than capacity.

See Also:

readByte()

readUnsignedByte

int readUnsignedByte()

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

When the byte is read from the buffer, the buffer's position will be advanced by Bytes.BYTE. If there are no bytes remaining in the buffer then a BufferUnderflowException will be thrown.

Specified by:

readUnsignedByte in interface BufferInput<Buffer>

Returns:

The read byte.

Throws:

BufferUnderflowException - If remaining() is less than Bytes.BYTE

See Also:

readUnsignedByte(int)

readUnsignedByte

int readUnsignedByte(int offset)

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

The byte will be read from the given offset. If the given index is out of the bounds of the buffer then a IndexOutOfBoundsException will be thrown.

Specified by:

readUnsignedByte in interface BytesInput<Buffer>

Parameters:

offset - The offset at which to read the byte.

Returns:

The read byte.

Throws:

IndexOutOfBoundsException - If the given offset is out of the bounds of the buffer. Note that bounds are determined by the buffer's limit() rather than capacity.

See Also:

readUnsignedByte()

readChar

char readChar()

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

When the character is read from the buffer, the buffer's position will be advanced by Bytes.CHARACTER. If there are less than Bytes.CHARACTER bytes remaining in the buffer then a BufferUnderflowException will be thrown.

Specified by:

readChar in interface BufferInput<Buffer>

Returns:

The read character.

Throws:

BufferUnderflowException - If remaining() is less than Bytes.CHARACTER

See Also:

readChar(int)

readChar

char readChar(int offset)

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

The character will be read from the given offset. If the given index is out of the bounds of the buffer then a IndexOutOfBoundsException will be thrown.

Specified by:

readChar in interface BytesInput<Buffer>

Parameters:

offset - The offset at which to read the character.

Returns:

The read character.

Throws:

IndexOutOfBoundsException - If the given offset is out of the bounds of the buffer. Note that bounds are determined by the buffer's limit() rather than capacity.

See Also:

readChar()

readShort

short readShort()

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

When the short is read from the buffer, the buffer's position will be advanced by Bytes.SHORT. If there are less than Bytes.SHORT bytes remaining in the buffer then a BufferUnderflowException will be thrown.

Specified by:

readShort in interface BufferInput<Buffer>

Returns:

The read short.

Throws:

BufferUnderflowException - If remaining() is less than Bytes.SHORT

See Also:

readShort(int)

readShort

short readShort(int offset)

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

The short will be read from the given offset. If the given index is out of the bounds of the buffer then a IndexOutOfBoundsException will be thrown.

Specified by:

readShort in interface BytesInput<Buffer>

Parameters:

offset - The offset at which to read the short.

Returns:

The read short.

Throws:

IndexOutOfBoundsException - If the given offset is out of the bounds of the buffer. Note that bounds are determined by the buffer's limit() rather than capacity.

See Also:

readShort()

readUnsignedShort

int readUnsignedShort()

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

When the short is read from the buffer, the buffer's position will be advanced by Bytes.SHORT. If there are less than Bytes.SHORT bytes remaining in the buffer then a BufferUnderflowException will be thrown.

Specified by:

readUnsignedShort in interface BufferInput<Buffer>

Returns:

The read short.

Throws:

BufferUnderflowException - If remaining() is less than Bytes.SHORT

See Also:

readUnsignedShort(int)

readUnsignedShort

int readUnsignedShort(int offset)

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

The short will be read from the given offset. If the given index is out of the bounds of the buffer then a IndexOutOfBoundsException will be thrown.

Specified by:

readUnsignedShort in interface BytesInput<Buffer>

Parameters:

offset - The offset at which to read the short.

Returns:

The read short.

Throws:

IndexOutOfBoundsException - If the given offset is out of the bounds of the buffer. Note that bounds are determined by the buffer's limit() rather than capacity.

See Also:

readUnsignedShort()

readInt

int readInt()

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

When the integer is read from the buffer, the buffer's position will be advanced by Bytes.INTEGER. If there are less than Bytes.INTEGER bytes remaining in the buffer then a BufferUnderflowException will be thrown.

Specified by:

readInt in interface BufferInput<Buffer>

Returns:

The read integer.

Throws:

BufferUnderflowException - If remaining() is less than Bytes.INTEGER

See Also:

readInt(int)

readInt

int readInt(int offset)

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

The integer will be read from the given offset. If the given index is out of the bounds of the buffer then a IndexOutOfBoundsException will be thrown.

Specified by:

readInt in interface BytesInput<Buffer>

Parameters:

offset - The offset at which to read the integer.

Returns:

The read integer.

Throws:

IndexOutOfBoundsException - If the given offset is out of the bounds of the buffer. Note that bounds are determined by the buffer's limit() rather than capacity.

See Also:

readInt()

readUnsignedInt

long readUnsignedInt()

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

When the integer is read from the buffer, the buffer's position will be advanced by Bytes.INTEGER. If there are less than Bytes.INTEGER bytes remaining in the buffer then a BufferUnderflowException will be thrown.

Specified by:

readUnsignedInt in interface BufferInput<Buffer>

Returns:

The read integer.

Throws:

BufferUnderflowException - If remaining() is less than Bytes.INTEGER

See Also:

readUnsignedInt(int)

readUnsignedInt

long readUnsignedInt(int offset)

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

The integer will be read from the given offset. If the given index is out of the bounds of the buffer then a IndexOutOfBoundsException will be thrown.

Specified by:

readUnsignedInt in interface BytesInput<Buffer>

Parameters:

offset - The offset at which to read the integer.

Returns:

The read integer.

Throws:

IndexOutOfBoundsException - If the given offset is out of the bounds of the buffer. Note that bounds are determined by the buffer's limit() rather than capacity.

See Also:

readUnsignedInt()

readLong

long readLong()

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

When the long is read from the buffer, the buffer's position will be advanced by Bytes.LONG. If there are less than Bytes.LONG bytes remaining in the buffer then a BufferUnderflowException will be thrown.

Specified by:

readLong in interface BufferInput<Buffer>

Returns:

The read long.

Throws:

BufferUnderflowException - If remaining() is less than Bytes.LONG

See Also:

readLong(int)

readLong

long readLong(int offset)

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

The long will be read from the given offset. If the given index is out of the bounds of the buffer then a IndexOutOfBoundsException will be thrown.

Specified by:

readLong in interface BytesInput<Buffer>

Parameters:

offset - The offset at which to read the long.

Returns:

The read long.

Throws:

IndexOutOfBoundsException - If the given offset is out of the bounds of the buffer. Note that bounds are determined by the buffer's limit() rather than capacity.

See Also:

readLong()

readFloat

float readFloat()

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

When the float is read from the buffer, the buffer's position will be advanced by Bytes.FLOAT. If there are less than Bytes.FLOAT bytes remaining in the buffer then a BufferUnderflowException will be thrown.

Specified by:

readFloat in interface BufferInput<Buffer>

Returns:

The read float.

Throws:

BufferUnderflowException - If remaining() is less than Bytes.FLOAT

See Also:

readFloat(int)

readFloat

float readFloat(int offset)

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

The float will be read from the given offset. If the given index is out of the bounds of the buffer then a IndexOutOfBoundsException will be thrown.

Specified by:

readFloat in interface BytesInput<Buffer>

Parameters:

offset - The offset at which to read the float.

Returns:

The read float.

Throws:

IndexOutOfBoundsException - If the given offset is out of the bounds of the buffer. Note that bounds are determined by the buffer's limit() rather than capacity.

See Also:

readFloat()

readDouble

double readDouble()

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

When the double is read from the buffer, the buffer's position will be advanced by Bytes.DOUBLE. If there are less than Bytes.DOUBLE bytes remaining in the buffer then a BufferUnderflowException will be thrown.

Specified by:

readDouble in interface BufferInput<Buffer>

Returns:

The read double.

Throws:

BufferUnderflowException - If remaining() is less than Bytes.DOUBLE

See Also:

readDouble(int)

readDouble

double readDouble(int offset)

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

The double will be read from the given offset. If the given index is out of the bounds of the buffer then a IndexOutOfBoundsException will be thrown.

Specified by:

readDouble in interface BytesInput<Buffer>

Parameters:

offset - The offset at which to read the double.

Returns:

The read double.

Throws:

IndexOutOfBoundsException - If the given offset is out of the bounds of the buffer. Note that bounds are determined by the buffer's limit() rather than capacity.

See Also:

readDouble()

readBoolean

boolean readBoolean()

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

When the boolean is read from the buffer, the buffer's position will be advanced by 1. If there are no bytes remaining in the buffer then a BufferUnderflowException will be thrown.

Specified by:

readBoolean in interface BufferInput<Buffer>

Returns:

The read boolean.

Throws:

BufferUnderflowException - If remaining() is less than 1

See Also:

readBoolean(int)

readBoolean

boolean readBoolean(int offset)

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

The boolean will be read from the given offset. If the given index is out of the bounds of the buffer then a IndexOutOfBoundsException will be thrown.

Specified by:

readBoolean in interface BytesInput<Buffer>

Parameters:

offset - The offset at which to read the boolean.

Returns:

The read boolean.

Throws:

IndexOutOfBoundsException - If the given offset is out of the bounds of the buffer. Note that bounds are determined by the buffer's limit() rather than capacity.

See Also:

readBoolean()

readUTF8

String readUTF8()

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

When the string is read from the buffer, the buffer's position will be advanced by 2 bytes plus the byte length of the string. If there are no bytes remaining in the buffer then a BufferUnderflowException will be thrown.

Specified by:

readUTF8 in interface BufferInput<Buffer>

Returns:

The read string.

Throws:

BufferUnderflowException - If remaining() is less than 1

See Also:

readUTF8(int)

readUTF8

String readUTF8(int offset)

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

The string will be read from the given offset. If the given index is out of the bounds of the buffer then a IndexOutOfBoundsException will be thrown.

Specified by:

readUTF8 in interface BytesInput<Buffer>

Parameters:

offset - The offset at which to read the boolean.

Returns:

The read string.

Throws:

IndexOutOfBoundsException - If the given offset is out of the bounds of the buffer. Note that bounds are determined by the buffer's limit() rather than capacity.

See Also:

readUTF8()

write

Buffer write(Buffer buffer)

Writes a buffer to the buffer.

When the buffer is written to the buffer, the buffer's position will be advanced by the number of bytes in the provided buffer. If the provided remaining() exceeds remaining() then an BufferOverflowException will be thrown.

Specified by:

write in interface BufferOutput<Buffer>

Parameters:

buffer - The buffer to write.

Returns:

The written buffer.

Throws:

BufferOverflowException - If the given buffer's remaining() bytes exceeds this buffer's remaining bytes.

write

Buffer write(Bytes bytes)

Writes an array of bytes to the buffer.

When the bytes are written to the buffer, the buffer's position will be advanced by the number of bytes in the provided byte array. If the number of bytes exceeds limit() then an BufferOverflowException will be thrown.

Specified by:

write in interface BufferOutput<Buffer>

Parameters:

bytes - The array of bytes to write.

Returns:

The written buffer.

Throws:

BufferOverflowException - If the number of bytes exceeds the buffer's remaining bytes.

See Also:

write(Bytes, int, int), write(int, Bytes, int, int)

write

Buffer write(byte[] bytes)

Writes an array of bytes to the buffer.

When the bytes are written to the buffer, the buffer's position will be advanced by the number of bytes in the provided byte array. If the number of bytes exceeds limit() then an BufferOverflowException will be thrown.

Specified by:

write in interface BufferOutput<Buffer>

Parameters:

bytes - The array of bytes to write.

Returns:

The written buffer.

Throws:

BufferOverflowException - If the number of bytes exceeds the buffer's remaining bytes.

See Also:

write(byte[], int, int), write(int, byte[], int, int)

write

Buffer write(Bytes bytes,
             int offset,
             int length)

Writes an array of bytes to the buffer.

The bytes will be written starting at the current position up to the given length. If the length of the byte array is larger than the provided length then only length bytes will be read from the array. If the provided length is greater than the remaining bytes in this buffer then a BufferOverflowException will be thrown.

Specified by:

write in interface BufferOutput<Buffer>

Parameters:

bytes - The array of bytes to write.

offset - The offset at which to start writing the bytes.

length - The number of bytes from the provided byte array to write to the buffer.

Returns:

The written buffer.

Throws:

BufferOverflowException - If there are not enough bytes remaining in the buffer.

IndexOutOfBoundsException - If the given offset is out of the bounds of the buffer.

See Also:

write(Bytes), write(int, Bytes, int, int)

write

Buffer write(int offset,
             Bytes src,
             int srcOffset,
             int length)

Writes an array of bytes to the buffer.

The bytes will be written starting at the given offset up to the given length. If the remaining bytes in the byte array is larger than the provided length then only length bytes will be read from the array. If the provided length is greater than limit() minus offset then a BufferOverflowException will be thrown.

Specified by:

write in interface BytesOutput<Buffer>

Parameters:

offset - The offset at which to start writing the bytes.

src - The array of bytes to write.

srcOffset - The offset at which to begin reading bytes from the source.

length - The number of bytes from the provided byte array to write to the buffer.

Returns:

The written buffer.

Throws:

BufferOverflowException - If there are not enough bytes remaining in the buffer.

IndexOutOfBoundsException - If the given offset is out of the bounds of the buffer.

See Also:

write(Bytes), write(Bytes, int, int)

write

Buffer write(byte[] bytes,
             int offset,
             int length)

Writes an array of bytes to the buffer.

The bytes will be written starting at the current position up to the given length. If the length of the byte array is larger than the provided length then only length bytes will be read from the array. If the provided length is greater than the remaining bytes in this buffer then a BufferOverflowException will be thrown.

Specified by:

write in interface BufferOutput<Buffer>

Parameters:

bytes - The array of bytes to write.

offset - The offset at which to start writing the bytes.

length - The number of bytes from the provided byte array to write to the buffer.

Returns:

The written buffer.

Throws:

BufferOverflowException - If there are not enough bytes remaining in the buffer.

IndexOutOfBoundsException - If the given offset is out of the bounds of the buffer.

See Also:

write(byte[]), write(int, byte[], int, int)

write

Buffer write(int offset,
             byte[] src,
             int srcOffset,
             int length)

Writes an array of bytes to the buffer.

The bytes will be written starting at the given offset up to the given length. If the remaining bytes in the byte array is larger than the provided length then only length bytes will be read from the array. If the provided length is greater than limit() minus offset then a BufferOverflowException will be thrown.

Specified by:

write in interface BytesOutput<Buffer>

Parameters:

offset - The offset at which to start writing the bytes.

src - The array of bytes to write.

srcOffset - The offset at which to begin reading bytes from the source.

length - The number of bytes from the provided byte array to write to the buffer.

Returns:

The written buffer.

Throws:

BufferOverflowException - If there are not enough bytes remaining in the buffer.

IndexOutOfBoundsException - If the given offset is out of the bounds of the buffer.

See Also:

write(byte[]), write(byte[], int, int)

writeByte

Buffer writeByte(int b)

Writes a byte to the buffer at the current position.

When the byte is written to the buffer, the buffer's position will be advanced by Bytes.BYTE. If there are no bytes remaining in the buffer then a BufferOverflowException will be thrown.

Specified by:

writeByte in interface BufferOutput<Buffer>

Parameters:

b - The byte to write.

Returns:

The written buffer.

Throws:

BufferOverflowException - If there are no bytes remaining in the buffer.

See Also:

writeByte(int, int)

writeByte

Buffer writeByte(int offset,
                 int b)

Writes a byte to the buffer at the given offset.

The byte will be written at the given offset. If there are no bytes remaining in the buffer then a BufferOverflowException will be thrown.

Specified by:

writeByte in interface BytesOutput<Buffer>

Parameters:

offset - The offset at which to write the byte.

b - The byte to write.

Returns:

The written buffer.

Throws:

BufferOverflowException - If there are not enough bytes remaining in the buffer.

IndexOutOfBoundsException - If the given offset is out of the bounds of the buffer. Note that bounds are determined by the buffer's limit() rather than capacity.

See Also:

writeByte(int)

writeUnsignedByte

Buffer writeUnsignedByte(int b)

Writes an unsigned byte to the buffer at the current position.

When the byte is written to the buffer, the buffer's position will be advanced by Bytes.BYTE. If there are no bytes remaining in the buffer then a BufferOverflowException will be thrown.

Specified by:

writeUnsignedByte in interface BufferOutput<Buffer>

Parameters:

b - The byte to write.

Returns:

The written buffer.

Throws:

BufferOverflowException - If there are no bytes remaining in the buffer.

See Also:

writeUnsignedByte(int, int)

writeUnsignedByte

Buffer writeUnsignedByte(int offset,
                         int b)

Writes an unsigned byte to the buffer at the given offset.

The byte will be written at the given offset. If there are no bytes remaining in the buffer then a BufferOverflowException will be thrown.

Specified by:

writeUnsignedByte in interface BytesOutput<Buffer>

Parameters:

offset - The offset at which to write the byte.

b - The byte to write.

Returns:

The written buffer.

Throws:

BufferOverflowException - If there are not enough bytes remaining in the buffer.

IndexOutOfBoundsException - If the given offset is out of the bounds of the buffer. Note that bounds are determined by the buffer's limit() rather than capacity.

See Also:

writeUnsignedByte(int)

writeChar

Buffer writeChar(char c)

Writes a 16-bit character to the buffer at the current position.

When the character is written to the buffer, the buffer's position will be advanced by Bytes.CHARACTER. If less than 2 bytes are remaining in the buffer then a BufferOverflowException will be thrown.

Specified by:

writeChar in interface BufferOutput<Buffer>

Parameters:

c - The character to write.

Returns:

The written buffer.

Throws:

BufferOverflowException - If remaining() is less than Bytes.CHARACTER.

See Also:

writeChar(int, char)

writeChar

Buffer writeChar(int offset,
                 char c)

Writes a 16-bit character to the buffer at the given offset.

The character will be written at the given offset. If there are less than Bytes.CHARACTER bytes remaining in the buffer then a BufferOverflowException will be thrown.

Specified by:

writeChar in interface BytesOutput<Buffer>

Parameters:

offset - The offset at which to write the character.

c - The character to write.

Returns:

The written buffer.

Throws:

BufferOverflowException - If remaining() is less than Bytes.CHARACTER.

IndexOutOfBoundsException - If the given offset is out of the bounds of the buffer. Note that bounds are determined by the buffer's limit() rather than capacity.

See Also:

writeChar(char)

writeShort

Buffer writeShort(short s)

Writes a 16-bit signed integer to the buffer at the current position.

When the short is written to the buffer, the buffer's position will be advanced by Bytes.SHORT. If less than Bytes.SHORT bytes are remaining in the buffer then a BufferOverflowException will be thrown.

Specified by:

writeShort in interface BufferOutput<Buffer>

Parameters:

s - The short to write.

Returns:

The written buffer.

Throws:

BufferOverflowException - If remaining() is less than Bytes.SHORT.

See Also:

writeShort(int, short)

writeShort

Buffer writeShort(int offset,
                  short s)

Writes a 16-bit signed integer to the buffer at the given offset.

The short will be written at the given offset. If there are less than Bytes.SHORT bytes remaining in the buffer then a BufferOverflowException will be thrown.

Specified by:

writeShort in interface BytesOutput<Buffer>

Parameters:

offset - The offset at which to write the short.

s - The short to write.

Returns:

The written buffer.

Throws:

BufferOverflowException - If remaining() is less than Bytes.SHORT.

IndexOutOfBoundsException - If the given offset is out of the bounds of the buffer. Note that bounds are determined by the buffer's limit() rather than capacity.

See Also:

writeShort(short)

writeUnsignedShort

Buffer writeUnsignedShort(int s)

Writes a 16-bit signed integer to the buffer at the current position.

When the short is written to the buffer, the buffer's position will be advanced by Bytes.SHORT. If less than Bytes.SHORT bytes are remaining in the buffer then a BufferOverflowException will be thrown.

Specified by:

writeUnsignedShort in interface BufferOutput<Buffer>

Parameters:

s - The short to write.

Returns:

The written buffer.

Throws:

BufferOverflowException - If remaining() is less than Bytes.SHORT.

See Also:

writeUnsignedShort(int, int)

writeUnsignedShort

Buffer writeUnsignedShort(int offset,
                          int s)

Writes a 16-bit signed integer to the buffer at the given offset.

The short will be written at the given offset. If there are less than Bytes.SHORT bytes remaining in the buffer then a BufferOverflowException will be thrown.

Specified by:

writeUnsignedShort in interface BytesOutput<Buffer>

Parameters:

offset - The offset at which to write the short.

s - The short to write.

Returns:

The written buffer.

Throws:

BufferOverflowException - If remaining() is less than Bytes.SHORT.

IndexOutOfBoundsException - If the given offset is out of the bounds of the buffer. Note that bounds are determined by the buffer's limit() rather than capacity.

See Also:

writeUnsignedShort(int)

writeInt

Buffer writeInt(int i)

Writes a 32-bit signed integer to the buffer at the current position.

When the integer is written to the buffer, the buffer's position will be advanced by Bytes.INTEGER. If less than Bytes.INTEGER bytes are remaining in the buffer then a BufferOverflowException will be thrown.

Specified by:

writeInt in interface BufferOutput<Buffer>

Parameters:

i - The integer to write.

Returns:

The written buffer.

Throws:

BufferOverflowException - If remaining() is less than Bytes.INTEGER.

See Also:

writeInt(int, int)

writeInt

Buffer writeInt(int offset,
                int i)

Writes a 32-bit signed integer to the buffer at the given offset.

The integer will be written at the given offset. If there are less than Bytes.INTEGER bytes remaining in the buffer then a BufferOverflowException will be thrown.

Specified by:

writeInt in interface BytesOutput<Buffer>

Parameters:

offset - The offset at which to write the integer.

i - The integer to write.

Returns:

The written buffer.

Throws:

BufferOverflowException - If remaining() is less than Bytes.INTEGER.

IndexOutOfBoundsException - If the given offset is out of the bounds of the buffer. Note that bounds are determined by the buffer's limit() rather than capacity.

See Also:

writeInt(int)

writeUnsignedInt

Buffer writeUnsignedInt(long i)

Writes a 32-bit signed integer to the buffer at the current position.

When the integer is written to the buffer, the buffer's position will be advanced by Bytes.INTEGER. If less than Bytes.INTEGER bytes are remaining in the buffer then a BufferOverflowException will be thrown.

Specified by:

writeUnsignedInt in interface BufferOutput<Buffer>

Parameters:

i - The integer to write.

Returns:

The written buffer.

Throws:

BufferOverflowException - If remaining() is less than Bytes.INTEGER.

See Also:

writeUnsignedInt(int, long)

writeUnsignedInt

Buffer writeUnsignedInt(int offset,
                        long i)

Writes a 32-bit signed integer to the buffer at the given offset.

The integer will be written at the given offset. If there are less than Bytes.INTEGER bytes remaining in the buffer then a BufferOverflowException will be thrown.

Specified by:

writeUnsignedInt in interface BytesOutput<Buffer>

Parameters:

offset - The offset at which to write the integer.

i - The integer to write.

Returns:

The written buffer.

Throws:

BufferOverflowException - If remaining() is less than Bytes.INTEGER.

IndexOutOfBoundsException - If the given offset is out of the bounds of the buffer. Note that bounds are determined by the buffer's limit() rather than capacity.

See Also:

writeUnsignedInt(long)

writeLong

Buffer writeLong(long l)

Writes a 64-bit signed integer to the buffer at the current position.

When the long is written to the buffer, the buffer's position will be advanced by Bytes.LONG. If less than Bytes.LONG bytes are remaining in the buffer then a BufferOverflowException will be thrown.

Specified by:

writeLong in interface BufferOutput<Buffer>

Parameters:

l - The long to write.

Returns:

The written buffer.

Throws:

BufferOverflowException - If remaining() is less than Bytes.LONG.

See Also:

writeLong(int, long)

writeLong

Buffer writeLong(int offset,
                 long l)

Writes a 64-bit signed integer to the buffer at the given offset.

The long will be written at the given offset. If there are less than Bytes.LONG bytes remaining in the buffer then a BufferOverflowException will be thrown.

Specified by:

writeLong in interface BytesOutput<Buffer>

Parameters:

offset - The offset at which to write the long.

l - The long to write.

Returns:

The written buffer.

Throws:

BufferOverflowException - If remaining() is less than Bytes.LONG.

IndexOutOfBoundsException - If the given offset is out of the bounds of the buffer. Note that bounds are determined by the buffer's limit() rather than capacity.

See Also:

writeLong(long)

writeFloat

Buffer writeFloat(float f)

Writes a single-precision 32-bit floating point number to the buffer at the current position.

When the float is written to the buffer, the buffer's position will be advanced by Bytes.FLOAT. If less than Bytes.FLOAT bytes are remaining in the buffer then a BufferOverflowException will be thrown.

Specified by:

writeFloat in interface BufferOutput<Buffer>

Parameters:

f - The float to write.

Returns:

The written buffer.

Throws:

BufferOverflowException - If remaining() is less than Bytes.FLOAT.

See Also:

writeFloat(int, float)

writeFloat

Buffer writeFloat(int offset,
                  float f)

Writes a single-precision 32-bit floating point number to the buffer at the given offset.

The float will be written at the given offset. If there are less than Bytes.FLOAT bytes remaining in the buffer then a BufferOverflowException will be thrown.

Specified by:

writeFloat in interface BytesOutput<Buffer>

Parameters:

offset - The offset at which to write the float.

f - The float to write.

Returns:

The written buffer.

Throws:

BufferOverflowException - If remaining() is less than Bytes.FLOAT.

IndexOutOfBoundsException - If the given offset is out of the bounds of the buffer. Note that bounds are determined by the buffer's limit() rather than capacity.

See Also:

writeFloat(float)

writeDouble

Buffer writeDouble(double d)

Writes a double-precision 64-bit floating point number to the buffer at the current position.

When the double is written to the buffer, the buffer's position will be advanced by Bytes.DOUBLE. If less than Bytes.DOUBLE bytes are remaining in the buffer then a BufferOverflowException will be thrown.

Specified by:

writeDouble in interface BufferOutput<Buffer>

Parameters:

d - The double to write.

Returns:

The written buffer.

Throws:

BufferOverflowException - If remaining() is less than Bytes.DOUBLE.

See Also:

writeDouble(int, double)

writeDouble

Buffer writeDouble(int offset,
                   double d)

Writes a double-precision 64-bit floating point number to the buffer at the given offset.

The double will be written at the given offset. If there are less than Bytes.DOUBLE bytes remaining in the buffer then a BufferOverflowException will be thrown.

Specified by:

writeDouble in interface BytesOutput<Buffer>

Parameters:

offset - The offset at which to write the double.

d - The double to write.

Returns:

The written buffer.

Throws:

BufferOverflowException - If remaining() is less than Bytes.DOUBLE.

IndexOutOfBoundsException - If the given offset is out of the bounds of the buffer. Note that bounds are determined by the buffer's limit() rather than capacity.

See Also:

writeDouble(double)

writeBoolean

Buffer writeBoolean(boolean b)

Writes a 1 byte boolean to the buffer at the current position.

When the boolean is written to the buffer, the buffer's position will be advanced by 1. If there are no bytes remaining in the buffer then a BufferOverflowException will be thrown.

Specified by:

writeBoolean in interface BufferOutput<Buffer>

Parameters:

b - The boolean to write.

Returns:

The written buffer.

Throws:

BufferOverflowException - If the number of bytes exceeds the buffer's remaining bytes.

See Also:

writeBoolean(int, boolean)

writeBoolean

Buffer writeBoolean(int offset,
                    boolean b)

Writes a 1 byte boolean to the buffer at the given offset.

The boolean will be written as a single byte at the given offset. If there are no bytes remaining in the buffer then a BufferOverflowException will be thrown.

Specified by:

writeBoolean in interface BytesOutput<Buffer>

Parameters:

offset - The offset at which to write the boolean.

b - The boolean to write.

Returns:

The written buffer.

Throws:

BufferOverflowException - If remaining() is less than 1.

IndexOutOfBoundsException - If the given offset is out of the bounds of the buffer. Note that bounds are determined by the buffer's limit() rather than capacity.

See Also:

writeBoolean(boolean)

writeUTF8

Buffer writeUTF8(String s)

Writes a UTF-8 string to the buffer at the current position.

The string will be written with a two-byte unsigned byte length followed by the UTF-8 bytes. If there are not enough bytes remaining in the buffer then a BufferOverflowException will be thrown.

Specified by:

writeUTF8 in interface BufferOutput<Buffer>

Parameters:

s - The string to write.

Returns:

The written buffer.

Throws:

BufferOverflowException - If the number of bytes exceeds the buffer's remaining bytes.

See Also:

writeUTF8(int, String)

writeUTF8

Buffer writeUTF8(int offset,
                 String s)

Writes a UTF-8 string to the buffer at the given offset.

The string will be written with a two-byte unsigned byte length followed by the UTF-8 bytes. If there are not enough bytes remaining in the buffer then a BufferOverflowException will be thrown.

Specified by:

writeUTF8 in interface BytesOutput<Buffer>

Parameters:

offset - The offset at which to write the string.

s - The string to write.

Returns:

The written buffer.

Throws:

BufferOverflowException - If remaining() is less than 1.

IndexOutOfBoundsException - If the given offset is out of the bounds of the buffer. Note that bounds are determined by the buffer's limit() rather than capacity.

See Also:

writeUTF8(String)

close

void close()

Closes the buffer.

This method effectively acts as an alias to ReferenceCounted.release() and allows buffers to be used as resources in try-with-resources statements. When the buffer is closed the internal reference counter defined by ReferenceCounted will be decremented. However, if references to the buffer still exist then those references will be allowed to continue to operate on the buffer until all references have been released.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface BufferInput<Buffer>

Specified by:

close in interface BufferOutput<Buffer>

Specified by:

close in interface io.atomix.utils.concurrent.ReferenceCounted<Buffer>