net.kuujo.catalyst.buffer

Class SlicedBuffer

java.lang.Object

net.kuujo.catalyst.buffer.AbstractBuffer

net.kuujo.catalyst.buffer.SlicedBuffer

All Implemented Interfaces:

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

public class SlicedBuffer
extends AbstractBuffer

Sliced buffer.

The sliced buffer provides a view of a subset of an underlying buffer. This buffer operates directly on the Bytes underlying the child Buffer instance.

Author:

Jordan Halterman

Constructor Summary

Constructors

Constructor and Description
SlicedBuffer(Buffer root, Bytes bytes, long offset, long initialCapacity, long maxCapacity)

Method Summary

Modifier and Type	Method and Description
Buffer	acquire() Acquires a reference.
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.
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.
boolean	release() Releases a reference.
Buffer	root() Returns the root buffer.

Methods inherited from class net.kuujo.catalyst.buffer.AbstractBuffer

asReadOnlyBuffer, bytes, capacity, capacity, clear, flip, flush, hasRemaining, limit, limit, mark, maxCapacity, offset, order, order, position, position, read, read, read, read, read, read, read, readBoolean, readBoolean, readByte, readByte, readChar, readChar, readDouble, readDouble, readFloat, readFloat, readInt, readInt, readLong, readLong, readMedium, readMedium, readShort, readShort, readString, readString, readUnsignedByte, readUnsignedByte, readUnsignedInt, readUnsignedInt, readUnsignedMedium, readUnsignedMedium, readUnsignedShort, readUnsignedShort, readUTF8, readUTF8, references, remaining, reset, rewind, skip, slice, slice, slice, write, write, write, write, write, write, write, writeBoolean, writeBoolean, writeByte, writeByte, writeChar, writeChar, writeDouble, writeDouble, writeFloat, writeFloat, writeInt, writeInt, writeLong, writeLong, writeMedium, writeMedium, writeShort, writeShort, writeString, writeString, writeUnsignedByte, writeUnsignedByte, writeUnsignedInt, writeUnsignedInt, writeUnsignedMedium, writeUnsignedMedium, writeUnsignedShort, writeUnsignedShort, writeUTF8, writeUTF8, zero, zero, zero

Methods inherited from class java.lang.Object

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

Constructor Detail

SlicedBuffer

public SlicedBuffer(Buffer root,
                    Bytes bytes,
                    long offset,
                    long initialCapacity,
                    long maxCapacity)

Method Detail

root

public Buffer root()

Returns the root buffer.

Returns:

The root 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

Overrides:

isDirect in class AbstractBuffer

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

Overrides:

isFile in class AbstractBuffer

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

Overrides:

isReadOnly in class AbstractBuffer

Returns:

Indicates whether the buffer is 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

Overrides:

compact in class AbstractBuffer

Returns:

This buffer.

acquire

public Buffer acquire()

Description copied from interface: ReferenceCounted

Acquires a reference.

Specified by:

acquire in interface ReferenceCounted<Buffer>

Overrides:

acquire in class AbstractBuffer

Returns:

The acquired reference.

release

public boolean release()

Description copied from interface: ReferenceCounted

Releases a reference.

Specified by:

release in interface ReferenceCounted<Buffer>

Overrides:

release in class AbstractBuffer

Returns:

Indicates whether all references to the object have been released.

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>

Overrides:

close in class AbstractBuffer