net.kuujo.catalyst.buffer

Class AbstractBuffer

java.lang.Object

net.kuujo.catalyst.buffer.AbstractBuffer

All Implemented Interfaces:

AutoCloseable, Buffer, BufferInput<Buffer>, BufferOutput<Buffer>, BytesInput<Buffer>, BytesOutput<Buffer>, ReferenceCounted<Buffer>

Direct Known Subclasses:

FileBuffer, HeapBuffer, NativeBuffer, ReadOnlyBuffer, SlicedBuffer, SwappedBuffer

public abstract class AbstractBuffer
extends Object
implements Buffer

Abstract buffer implementation.

Author:

Jordan Halterman

Method Summary

Modifier and Type	Method and Description
Buffer	acquire() Acquires a reference.
Buffer	asReadOnlyBuffer() Returns a read-only view of the buffer.
Bytes	bytes() Returns the bytes underlying the buffer.
long	capacity() Returns the buffer's capacity.
Buffer	capacity(long capacity) Updates the buffer 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	flip() Flips the buffer.
Buffer	flush() Flushes the bytes to the underlying persistence layer.
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.
long	limit() Returns the buffer's read/write limit.
Buffer	limit(long limit) Sets the buffer's read/write limit.
Buffer	mark() Sets a mark at the current position.
long	maxCapacity() Returns the maximum allowed capacity for the buffer.
long	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.
long	position() Returns the buffer's current read/write position.
Buffer	position(long 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, long offset, long 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, long offset, long length) Reads bytes into the given byte array starting at the current position.
Buffer	read(long srcOffset, byte[] bytes, long dstOffset, long length) Reads bytes into the given byte array starting at the given offset up to the given length.
Buffer	read(long srcOffset, Bytes bytes, long dstOffset, long 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(long 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(long 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(long 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(long 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(long 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(long 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(long offset) Reads a 64-bit signed integer from the buffer at the given offset.
int	readMedium() Reads a 24-bit signed integer from the buffer at the current position.
int	readMedium(long offset) Reads a 24-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(long offset) Reads a 16-bit signed integer from the buffer at the given offset.
String	readString() Reads a string from the buffer at the current position.
String	readString(long offset) Reads a string from the buffer at the given offset.
int	readUnsignedByte() Reads an unsigned byte from the buffer at the current position.
int	readUnsignedByte(long 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(long offset) Reads a 32-bit unsigned integer from the buffer at the given offset.
int	readUnsignedMedium() Reads a 24-bit unsigned integer from the buffer at the current position.
int	readUnsignedMedium(long offset) Reads a 24-bin 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(long 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(long offset) Reads a UTF-8 string from the buffer at the given offset.
int	references() Returns the number of open references.
boolean	release() Releases a reference.
long	remaining() Returns the number of bytes remaining in the buffer until the Buffer.limit() is reached.
Buffer	reset() Resets the buffer's position to the previously-marked position.
Buffer	rewind() Rewinds the buffer.
Buffer	skip(long length) Advances the buffer's position length bytes.
Buffer	slice() Returns a view of this buffer starting at the current position.
Buffer	slice(long length) Returns a view of this buffer of the given length starting at the current position.
Buffer	slice(long offset, long 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, long offset, long 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, long offset, long length) Writes an array of bytes to the buffer.
Buffer	write(long offset, byte[] bytes, long srcOffset, long length) Writes an array of bytes to the buffer.
Buffer	write(long offset, Bytes bytes, long srcOffset, long 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(long 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(long 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(long 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(long 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(long 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(long offset, int i) Writes a 32-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	writeLong(long offset, long l) Writes a 64-bit signed integer to the buffer at the given offset.
Buffer	writeMedium(int m) Writes a 24-bit signed integer to the buffer.
Buffer	writeMedium(long offset, int m) Writes a 24-bit signed integer to the buffer at the given offset.
Buffer	writeShort(long 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	writeString(long offset, String s) Writes a string to the buffer at the given offset.
Buffer	writeString(String s) Writes a string to the buffer.
Buffer	writeUnsignedByte(int b) Writes an unsigned byte to the buffer at the current position.
Buffer	writeUnsignedByte(long offset, int b) Writes an unsigned byte 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	writeUnsignedInt(long offset, long i) Writes a 32-bit signed integer to the buffer at the given offset.
Buffer	writeUnsignedMedium(int m) Writes a 24-bit unsigned integer to the buffer.
Buffer	writeUnsignedMedium(long offset, int m) Writes a 24-bit unsigned integer to the buffer at the given offset.
Buffer	writeUnsignedShort(int s) Writes a 16-bit signed integer to the buffer at the current position.
Buffer	writeUnsignedShort(long offset, int s) Writes a 16-bit signed integer to the buffer at the given offset.
Buffer	writeUTF8(long 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.
Buffer	zero() Zeros out all bytes in the array.
Buffer	zero(long offset) Zeros out all bytes starting at the given offset in the array.
Buffer	zero(long offset, long length) Zeros out bytes starting at the given offset up to the given length.

Methods inherited from class java.lang.Object

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

Method Detail

acquire

public Buffer acquire()

Description copied from interface: ReferenceCounted

Acquires a reference.

Specified by:

acquire in interface ReferenceCounted<Buffer>

Returns:

The acquired reference.

release

public boolean release()

Description copied from interface: ReferenceCounted

Releases a reference.

Specified by:

release in interface ReferenceCounted<Buffer>

Returns:

Indicates whether all references to the object have been released.

references

public int references()

Description copied from interface: ReferenceCounted

Returns the number of open references.

Specified by:

references in interface ReferenceCounted<Buffer>

Returns:

The number of open references.

bytes

public Bytes bytes()

Description copied from interface: Buffer

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.

Specified by:

bytes in interface Buffer

Returns:

The underlying bytes.

order

public ByteOrder order()

Description copied from interface: Buffer

Returns the byte order.

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

Specified by:

order in interface Buffer

Returns:

The byte order.

order

public Buffer order(ByteOrder order)

Description copied from interface: Buffer

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

Specified by:

order in interface Buffer

Parameters:

order - The byte order.

Returns:

The updated buffer.

isDirect

public boolean isDirect()

Description copied from interface: Buffer

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

Specified by:

isDirect in interface Buffer

Returns:

Indicates whether the buffer is a direct buffer.

isFile

public boolean isFile()

Description copied from interface: Buffer

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

Specified by:

isFile in interface Buffer

Returns:

Indicates whether the buffer is backed by a file.

isReadOnly

public boolean isReadOnly()

Description copied from interface: Buffer

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

Specified by:

isReadOnly in interface Buffer

Returns:

Indicates whether the buffer is a read-only buffer.

asReadOnlyBuffer

public Buffer asReadOnlyBuffer()

Description copied from interface: Buffer

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.

Specified by:

asReadOnlyBuffer in interface Buffer

Returns:

A read-only buffer.

compact

public Buffer compact()

Description copied from interface: Buffer

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

Specified by:

compact in interface Buffer

Returns:

This buffer.

slice

public Buffer slice()

Description copied from interface: Buffer

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 Buffer.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 Buffer.close() once finished using the buffer slice.

Specified by:

slice in interface Buffer

Returns:

A slice of this buffer.

See Also:

Buffer.slice(long), Buffer.slice(long, long)

slice

public Buffer slice(long length)

Description copied from interface: Buffer

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 Buffer.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 Buffer.close() once finished using the buffer slice.

Specified by:

slice in interface Buffer

Parameters:

length - The length of the slice.

Returns:

A slice of this buffer.

See Also:

Buffer.slice(), Buffer.slice(long, long)

slice

public Buffer slice(long offset,
                    long length)

Description copied from interface: Buffer

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 Buffer.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 Buffer.close() once finished using the buffer slice.

Specified by:

slice in interface Buffer

Parameters:

offset - The offset at which to begin the slice.

length - The number of bytes in the slice.

Returns:

The buffer slice.

See Also:

Buffer.slice(), Buffer.slice(long)

offset

public long offset()

Description copied from interface: Buffer

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.

Specified by:

offset in interface Buffer

Returns:

The buffer's offset.

capacity

public long capacity()

Description copied from interface: Buffer

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 Buffer.maxCapacity().

Specified by:

capacity in interface Buffer

Returns:

The buffer's capacity.

capacity

public Buffer capacity(long capacity)

Updates the buffer capacity.

Specified by:

capacity in interface Buffer

Parameters:

capacity - The capacity to which to resize the buffer.

Returns:

The resized buffer.

maxCapacity

public long maxCapacity()

Description copied from interface: Buffer

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.

Specified by:

maxCapacity in interface Buffer

Returns:

The buffer's maximum capacity.

position

public long position()

Description copied from interface: Buffer

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.

Specified by:

position in interface Buffer

Returns:

The buffer's current position.

position

public Buffer position(long position)

Description copied from interface: Buffer

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.

Specified by:

position in interface Buffer

Parameters:

position - The position to set.

Returns:

This buffer.

limit

public long limit()

Description copied from interface: Buffer

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 Buffer.flip()

Specified by:

limit in interface Buffer

Returns:

The buffer's limit.

limit

public Buffer limit(long limit)

Description copied from interface: Buffer

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 Buffer.capacity()

Specified by:

limit in interface Buffer

Parameters:

limit - The limit to set.

Returns:

This buffer.

remaining

public long remaining()

Description copied from interface: Buffer

Returns the number of bytes remaining in the buffer until the Buffer.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 Buffer

Specified by:

remaining in interface BufferInput<Buffer>

Returns:

The number of bytes remaining in the buffer.

hasRemaining

public boolean hasRemaining()

Description copied from interface: Buffer

Returns a boolean indicating whether the buffer has bytes remaining.

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

Specified by:

hasRemaining in interface Buffer

Specified by:

hasRemaining in interface BufferInput<Buffer>

Returns:

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

flip

public Buffer flip()

Description copied from interface: Buffer

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;
   
 

Specified by:

flip in interface Buffer

Returns:

This buffer.

mark

public Buffer mark()

Description copied from interface: Buffer

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;
   
 

Specified by:

mark in interface Buffer

Returns:

This buffer.

rewind

public Buffer rewind()

Description copied from interface: Buffer

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

Specified by:

rewind in interface Buffer

Returns:

This buffer.

reset

public Buffer reset()

Description copied from interface: Buffer

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

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

Specified by:

reset in interface Buffer

Returns:

This buffer.

skip

public Buffer skip(long length)

Description copied from interface: Buffer

Advances the buffer's position length bytes.

Specified by:

skip in interface Buffer

Specified by:

skip in interface BufferInput<Buffer>

Parameters:

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

Returns:

This buffer.

clear

public Buffer clear()

Description copied from interface: Buffer

Clears the buffer.

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

Specified by:

clear in interface Buffer

Returns:

This buffer.

zero

public Buffer zero()

Description copied from interface: BytesOutput

Zeros out all bytes in the array.

Specified by:

zero in interface BytesOutput<Buffer>

Returns:

The written bytes.

zero

public Buffer zero(long offset)

Description copied from interface: BytesOutput

Zeros out all bytes starting at the given offset in the array.

Specified by:

zero in interface BytesOutput<Buffer>

Parameters:

offset - The offset at which to start zeroing out bytes.

Returns:

The written bytes.

zero

public Buffer zero(long offset,
                   long length)

Description copied from interface: BytesOutput

Zeros out bytes starting at the given offset up to the given length.

Specified by:

zero in interface BytesOutput<Buffer>

Parameters:

offset - The offset at which to start zeroing out bytes.

length - THe total number of bytes to zero out.

Returns:

The written bytes.

read

public Buffer read(Buffer buffer)

Description copied from interface: Buffer

Reads bytes into the given buffer.

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

Specified by:

read in interface Buffer

Specified by:

read in interface BufferInput<Buffer>

Parameters:

buffer - The buffer into which to read bytes.

Returns:

The buffer.

read

public Buffer read(Bytes bytes)

Description copied from interface: Buffer

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 Buffer.limit() has been reached. If Buffer.remaining() is less than the length of the given byte array, a BufferUnderflowException will be thrown.

Specified by:

read in interface Buffer

Specified by:

read in interface BufferInput<Buffer>

Parameters:

bytes - The byte array into which to read bytes.

Returns:

The buffer.

See Also:

Buffer.read(Bytes, long, long), Buffer.read(long, Bytes, long, long)

read

public Buffer read(Bytes bytes,
                   long offset,
                   long length)

Description copied from interface: Buffer

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

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.

See Also:

Buffer.read(Bytes), Buffer.read(long, Bytes, long, long)

read

public Buffer read(long srcOffset,
                   Bytes bytes,
                   long dstOffset,
                   long length)

Description copied from interface: Buffer

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 Buffer

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.

See Also:

Buffer.read(Bytes), Buffer.read(Bytes, long, long)

read

public Buffer read(byte[] bytes)

Description copied from interface: Buffer

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 Buffer.limit() has been reached. If Buffer.remaining() is less than the length of the given byte array, a BufferUnderflowException will be thrown.

Specified by:

read in interface Buffer

Specified by:

read in interface BufferInput<Buffer>

Parameters:

bytes - The byte array into which to read bytes.

Returns:

The buffer.

See Also:

Buffer.read(byte[], long, long), Buffer.read(long, byte[], long, long)

read

public Buffer read(byte[] bytes,
                   long offset,
                   long length)

Description copied from interface: Buffer

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

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.

See Also:

Buffer.read(byte[]), Buffer.read(long, byte[], long, long)

read

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

Description copied from interface: Buffer

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

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.

See Also:

Buffer.read(byte[]), Buffer.read(byte[], long, long)

readByte

public int readByte()

Description copied from interface: Buffer

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 Buffer

Specified by:

readByte in interface BufferInput<Buffer>

Returns:

The read byte.

See Also:

Buffer.readByte(long)

readByte

public int readByte(long offset)

Description copied from interface: Buffer

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 Buffer

Specified by:

readByte in interface BytesInput<Buffer>

Parameters:

offset - The offset at which to read the byte.

Returns:

The read byte.

See Also:

Buffer.readByte()

readUnsignedByte

public int readUnsignedByte()

Description copied from interface: Buffer

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 Buffer

Specified by:

readUnsignedByte in interface BufferInput<Buffer>

Returns:

The read byte.

See Also:

Buffer.readUnsignedByte(long)

readUnsignedByte

public int readUnsignedByte(long offset)

Description copied from interface: Buffer

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 Buffer

Specified by:

readUnsignedByte in interface BytesInput<Buffer>

Parameters:

offset - The offset at which to read the byte.

Returns:

The read byte.

See Also:

Buffer.readUnsignedByte()

readChar

public char readChar()

Description copied from interface: Buffer

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 Buffer

Specified by:

readChar in interface BufferInput<Buffer>

Returns:

The read character.

See Also:

Buffer.readChar(long)

readChar

public char readChar(long offset)

Description copied from interface: Buffer

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 Buffer

Specified by:

readChar in interface BytesInput<Buffer>

Parameters:

offset - The offset at which to read the character.

Returns:

The read character.

See Also:

Buffer.readChar()

readShort

public short readShort()

Description copied from interface: Buffer

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 Buffer

Specified by:

readShort in interface BufferInput<Buffer>

Returns:

The read short.

See Also:

Buffer.readShort(long)

readShort

public short readShort(long offset)

Description copied from interface: Buffer

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 Buffer

Specified by:

readShort in interface BytesInput<Buffer>

Parameters:

offset - The offset at which to read the short.

Returns:

The read short.

See Also:

Buffer.readShort()

readUnsignedShort

public int readUnsignedShort()

Description copied from interface: Buffer

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 Buffer

Specified by:

readUnsignedShort in interface BufferInput<Buffer>

Returns:

The read short.

See Also:

Buffer.readUnsignedShort(long)

readUnsignedShort

public int readUnsignedShort(long offset)

Description copied from interface: Buffer

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 Buffer

Specified by:

readUnsignedShort in interface BytesInput<Buffer>

Parameters:

offset - The offset at which to read the short.

Returns:

The read short.

See Also:

Buffer.readUnsignedShort()

readMedium

public int readMedium()

Description copied from interface: BufferInput

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

Specified by:

readMedium in interface BufferInput<Buffer>

Returns:

The read integer.

readMedium

public int readMedium(long offset)

Description copied from interface: BytesInput

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

Specified by:

readMedium in interface BytesInput<Buffer>

Parameters:

offset - The offset at which to read the integer.

Returns:

The read medium.

readUnsignedMedium

public int readUnsignedMedium()

Description copied from interface: BufferInput

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

Specified by:

readUnsignedMedium in interface BufferInput<Buffer>

Returns:

The read integer.

readUnsignedMedium

public int readUnsignedMedium(long offset)

Description copied from interface: BytesInput

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

Specified by:

readUnsignedMedium in interface BytesInput<Buffer>

Parameters:

offset - The offset at which to read the integer.

Returns:

The read medium.

readInt

public int readInt()

Description copied from interface: Buffer

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 Buffer

Specified by:

readInt in interface BufferInput<Buffer>

Returns:

The read integer.

See Also:

Buffer.readInt(long)

readInt

public int readInt(long offset)

Description copied from interface: Buffer

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 Buffer

Specified by:

readInt in interface BytesInput<Buffer>

Parameters:

offset - The offset at which to read the integer.

Returns:

The read integer.

See Also:

Buffer.readInt()

readUnsignedInt

public long readUnsignedInt()

Description copied from interface: Buffer

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 Buffer

Specified by:

readUnsignedInt in interface BufferInput<Buffer>

Returns:

The read integer.

See Also:

Buffer.readUnsignedInt(long)

readUnsignedInt

public long readUnsignedInt(long offset)

Description copied from interface: Buffer

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 Buffer

Specified by:

readUnsignedInt in interface BytesInput<Buffer>

Parameters:

offset - The offset at which to read the integer.

Returns:

The read integer.

See Also:

Buffer.readUnsignedInt()

readLong

public long readLong()

Description copied from interface: Buffer

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 Buffer

Specified by:

readLong in interface BufferInput<Buffer>

Returns:

The read long.

See Also:

Buffer.readLong(long)

readLong

public long readLong(long offset)

Description copied from interface: Buffer

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 Buffer

Specified by:

readLong in interface BytesInput<Buffer>

Parameters:

offset - The offset at which to read the long.

Returns:

The read long.

See Also:

Buffer.readLong()

readFloat

public float readFloat()

Description copied from interface: Buffer

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 Buffer

Specified by:

readFloat in interface BufferInput<Buffer>

Returns:

The read float.

See Also:

Buffer.readFloat(long)

readFloat

public float readFloat(long offset)

Description copied from interface: Buffer

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 Buffer

Specified by:

readFloat in interface BytesInput<Buffer>

Parameters:

offset - The offset at which to read the float.

Returns:

The read float.

See Also:

Buffer.readFloat()

readDouble

public double readDouble()

Description copied from interface: Buffer

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 Buffer

Specified by:

readDouble in interface BufferInput<Buffer>

Returns:

The read double.

See Also:

Buffer.readDouble(long)

readDouble

public double readDouble(long offset)

Description copied from interface: Buffer

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 Buffer

Specified by:

readDouble in interface BytesInput<Buffer>

Parameters:

offset - The offset at which to read the double.

Returns:

The read double.

See Also:

Buffer.readDouble()

readBoolean

public boolean readBoolean()

Description copied from interface: Buffer

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 Buffer

Specified by:

readBoolean in interface BufferInput<Buffer>

Returns:

The read boolean.

See Also:

Buffer.readBoolean(long)

readBoolean

public boolean readBoolean(long offset)

Description copied from interface: Buffer

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 Buffer

Specified by:

readBoolean in interface BytesInput<Buffer>

Parameters:

offset - The offset at which to read the boolean.

Returns:

The read boolean.

See Also:

Buffer.readBoolean()

readString

public String readString()

Description copied from interface: BufferInput

Reads a string from the buffer at the current position.

Specified by:

readString in interface BufferInput<Buffer>

Returns:

The read string.

readString

public String readString(long offset)

Description copied from interface: BytesInput

Reads a string from the buffer at the given offset.

Specified by:

readString in interface BytesInput<Buffer>

Parameters:

offset - The offset at which to read the string.

Returns:

The read string.

readUTF8

public String readUTF8()

Description copied from interface: Buffer

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 Buffer

Specified by:

readUTF8 in interface BufferInput<Buffer>

Returns:

The read string.

See Also:

Buffer.readUTF8(long)

readUTF8

public String readUTF8(long offset)

Description copied from interface: Buffer

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 Buffer

Specified by:

readUTF8 in interface BytesInput<Buffer>

Parameters:

offset - The offset at which to read the boolean.

Returns:

The read string.

See Also:

Buffer.readUTF8()

write

public Buffer write(Buffer buffer)

Description copied from interface: 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 Buffer.remaining() exceeds Buffer.remaining() then an BufferOverflowException will be thrown.

Specified by:

write in interface Buffer

Specified by:

write in interface BufferOutput<Buffer>

Parameters:

buffer - The buffer to write.

Returns:

The written buffer.

write

public Buffer write(Bytes bytes)

Description copied from interface: Buffer

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 Buffer.limit() then an BufferOverflowException will be thrown.

Specified by:

write in interface Buffer

Specified by:

write in interface BufferOutput<Buffer>

Parameters:

bytes - The array of bytes to write.

Returns:

The written buffer.

See Also:

Buffer.write(Bytes, long, long), Buffer.write(long, Bytes, long, long)

write

public Buffer write(Bytes bytes,
                    long offset,
                    long length)

Description copied from interface: Buffer

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 Buffer

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.

See Also:

Buffer.write(Bytes), Buffer.write(long, Bytes, long, long)

write

public Buffer write(long offset,
                    Bytes bytes,
                    long srcOffset,
                    long length)

Description copied from interface: Buffer

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 Buffer.limit() minus offset then a BufferOverflowException will be thrown.

Specified by:

write in interface Buffer

Specified by:

write in interface BytesOutput<Buffer>

Parameters:

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

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

See Also:

Buffer.write(Bytes), Buffer.write(Bytes, long, long)

write

public Buffer write(byte[] bytes)

Description copied from interface: Buffer

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 Buffer.limit() then an BufferOverflowException will be thrown.

Specified by:

write in interface Buffer

Specified by:

write in interface BufferOutput<Buffer>

Parameters:

bytes - The array of bytes to write.

Returns:

The written buffer.

See Also:

Buffer.write(byte[], long, long), Buffer.write(long, byte[], long, long)

write

public Buffer write(byte[] bytes,
                    long offset,
                    long length)

Description copied from interface: Buffer

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 Buffer

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.

See Also:

Buffer.write(byte[]), Buffer.write(long, byte[], long, long)

write

public Buffer write(long offset,
                    byte[] bytes,
                    long srcOffset,
                    long length)

Description copied from interface: Buffer

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 Buffer.limit() minus offset then a BufferOverflowException will be thrown.

Specified by:

write in interface Buffer

Specified by:

write in interface BytesOutput<Buffer>

Parameters:

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

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

See Also:

Buffer.write(byte[]), Buffer.write(byte[], long, long)

writeByte

public Buffer writeByte(int b)

Description copied from interface: Buffer

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 Buffer

Specified by:

writeByte in interface BufferOutput<Buffer>

Parameters:

b - The byte to write.

Returns:

The written buffer.

See Also:

Buffer.writeByte(long, int)

writeByte

public Buffer writeByte(long offset,
                        int b)

Description copied from interface: Buffer

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 Buffer

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.

See Also:

Buffer.writeByte(int)

writeUnsignedByte

public Buffer writeUnsignedByte(int b)

Description copied from interface: Buffer

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 Buffer

Specified by:

writeUnsignedByte in interface BufferOutput<Buffer>

Parameters:

b - The byte to write.

Returns:

The written buffer.

See Also:

Buffer.writeUnsignedByte(long, int)

writeUnsignedByte

public Buffer writeUnsignedByte(long offset,
                                int b)

Description copied from interface: Buffer

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 Buffer

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.

See Also:

Buffer.writeUnsignedByte(int)

writeChar

public Buffer writeChar(char c)

Description copied from interface: Buffer

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 Buffer

Specified by:

writeChar in interface BufferOutput<Buffer>

Parameters:

c - The character to write.

Returns:

The written buffer.

See Also:

Buffer.writeChar(long, char)

writeChar

public Buffer writeChar(long offset,
                        char c)

Description copied from interface: Buffer

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 Buffer

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.

See Also:

Buffer.writeChar(char)

writeShort

public Buffer writeShort(short s)

Description copied from interface: Buffer

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 Buffer

Specified by:

writeShort in interface BufferOutput<Buffer>

Parameters:

s - The short to write.

Returns:

The written buffer.

See Also:

Buffer.writeShort(long, short)

writeShort

public Buffer writeShort(long offset,
                         short s)

Description copied from interface: Buffer

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 Buffer

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.

See Also:

Buffer.writeShort(short)

writeUnsignedShort

public Buffer writeUnsignedShort(int s)

Description copied from interface: Buffer

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 Buffer

Specified by:

writeUnsignedShort in interface BufferOutput<Buffer>

Parameters:

s - The short to write.

Returns:

The written buffer.

See Also:

Buffer.writeUnsignedShort(long, int)

writeUnsignedShort

public Buffer writeUnsignedShort(long offset,
                                 int s)

Description copied from interface: Buffer

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 Buffer

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.

See Also:

Buffer.writeUnsignedShort(int)

writeMedium

public Buffer writeMedium(int m)

Description copied from interface: BufferOutput

Writes a 24-bit signed integer to the buffer.

Specified by:

writeMedium in interface BufferOutput<Buffer>

Parameters:

m - The integer to write.

Returns:

The written buffer.

writeMedium

public Buffer writeMedium(long offset,
                          int m)

Description copied from interface: BytesOutput

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

Specified by:

writeMedium in interface BytesOutput<Buffer>

Parameters:

offset - The offset at which to write the short.

m - The short to write.

Returns:

The written buffer.

writeUnsignedMedium

public Buffer writeUnsignedMedium(int m)

Description copied from interface: BufferOutput

Writes a 24-bit unsigned integer to the buffer.

Specified by:

writeUnsignedMedium in interface BufferOutput<Buffer>

Parameters:

m - The integer to write.

Returns:

The written buffer.

writeUnsignedMedium

public Buffer writeUnsignedMedium(long offset,
                                  int m)

Description copied from interface: BytesOutput

Writes a 24-bit unsigned integer to the buffer at the given offset.

Specified by:

writeUnsignedMedium in interface BytesOutput<Buffer>

Parameters:

offset - The offset at which to write the short.

m - The short to write.

Returns:

The written buffer.

writeInt

public Buffer writeInt(int i)

Description copied from interface: Buffer

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 Buffer

Specified by:

writeInt in interface BufferOutput<Buffer>

Parameters:

i - The integer to write.

Returns:

The written buffer.

See Also:

Buffer.writeInt(long, int)

writeInt

public Buffer writeInt(long offset,
                       int i)

Description copied from interface: Buffer

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 Buffer

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.

See Also:

Buffer.writeInt(int)

writeUnsignedInt

public Buffer writeUnsignedInt(long i)

Description copied from interface: Buffer

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 Buffer

Specified by:

writeUnsignedInt in interface BufferOutput<Buffer>

Parameters:

i - The integer to write.

Returns:

The written buffer.

See Also:

Buffer.writeUnsignedInt(long, long)

writeUnsignedInt

public Buffer writeUnsignedInt(long offset,
                               long i)

Description copied from interface: Buffer

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 Buffer

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.

See Also:

Buffer.writeUnsignedInt(long)

writeLong

public Buffer writeLong(long l)

Description copied from interface: Buffer

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 Buffer

Specified by:

writeLong in interface BufferOutput<Buffer>

Parameters:

l - The long to write.

Returns:

The written buffer.

See Also:

Buffer.writeLong(long, long)

writeLong

public Buffer writeLong(long offset,
                        long l)

Description copied from interface: Buffer

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 Buffer

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.

See Also:

Buffer.writeLong(long)

writeFloat

public Buffer writeFloat(float f)

Description copied from interface: Buffer

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 Buffer

Specified by:

writeFloat in interface BufferOutput<Buffer>

Parameters:

f - The float to write.

Returns:

The written buffer.

See Also:

Buffer.writeFloat(long, float)

writeFloat

public Buffer writeFloat(long offset,
                         float f)

Description copied from interface: Buffer

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 Buffer

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.

See Also:

Buffer.writeFloat(float)

writeDouble

public Buffer writeDouble(double d)

Description copied from interface: Buffer

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 Buffer

Specified by:

writeDouble in interface BufferOutput<Buffer>

Parameters:

d - The double to write.

Returns:

The written buffer.

See Also:

Buffer.writeDouble(long, double)

writeDouble

public Buffer writeDouble(long offset,
                          double d)

Description copied from interface: Buffer

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 Buffer

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.

See Also:

Buffer.writeDouble(double)

writeBoolean

public Buffer writeBoolean(boolean b)

Description copied from interface: Buffer

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 Buffer

Specified by:

writeBoolean in interface BufferOutput<Buffer>

Parameters:

b - The boolean to write.

Returns:

The written buffer.

See Also:

Buffer.writeBoolean(long, boolean)

writeBoolean

public Buffer writeBoolean(long offset,
                           boolean b)

Description copied from interface: Buffer

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 Buffer

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.

See Also:

Buffer.writeBoolean(boolean)

writeString

public Buffer writeString(String s)

Description copied from interface: BufferOutput

Writes a string to the buffer.

Specified by:

writeString in interface BufferOutput<Buffer>

Parameters:

s - The string to write.

Returns:

The written buffer.

writeString

public Buffer writeString(long offset,
                          String s)

Description copied from interface: BytesOutput

Writes a string to the buffer at the given offset.

Specified by:

writeString in interface BytesOutput<Buffer>

Parameters:

offset - The offset at which to write the string.

s - The string to write.

Returns:

The written buffer.

writeUTF8

public Buffer writeUTF8(String s)

Description copied from interface: Buffer

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 Buffer

Specified by:

writeUTF8 in interface BufferOutput<Buffer>

Parameters:

s - The string to write.

Returns:

The written buffer.

See Also:

Buffer.writeUTF8(long, String)

writeUTF8

public Buffer writeUTF8(long offset,
                        String s)

Description copied from interface: Buffer

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 Buffer

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.

See Also:

Buffer.writeUTF8(String)

flush

public Buffer flush()

Description copied from interface: BytesOutput

Flushes the bytes to the underlying persistence layer.

Specified by:

flush in interface BufferOutput<Buffer>

Specified by:

flush in interface BytesOutput<Buffer>

Returns:

The flushed buffer.

close

public void close()

Description copied from interface: Buffer

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 Buffer

Specified by:

close in interface BufferInput<Buffer>

Specified by:

close in interface BufferOutput<Buffer>

Specified by:

close in interface ReferenceCounted<Buffer>