net.kuujo.catalyst.buffer

Class AbstractBytes

java.lang.Object

net.kuujo.catalyst.buffer.AbstractBytes

All Implemented Interfaces:

AutoCloseable, Bytes, BytesInput<Bytes>, BytesOutput<Bytes>

Direct Known Subclasses:

FileBytes, HeapBytes, NativeBytes, WrappedBytes

public abstract class AbstractBytes
extends Object
implements Bytes

Abstract bytes implementation.

This class provides common state and bounds checking functionality for all Bytes implementations.

Author:

Jordan Halterman

Field Summary

Fields inherited from interface net.kuujo.catalyst.buffer.Bytes

BOOLEAN, BYTE, CHARACTER, DOUBLE, FLOAT, INTEGER, LONG, MEDIUM, SHORT

Constructor Summary

Constructors

Constructor and Description
AbstractBytes()

Method Summary

Modifier and Type	Method and Description
void	close()
boolean	isDirect() Returns a boolean value indicating whether the bytes are direct.
boolean	isFile() Returns a boolean value indicating whether the bytes are backed by a file.
ByteOrder	order() Returns the byte order.
Bytes	order(ByteOrder order) Sets the byte order, returning a new swapped Bytes instance.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.kuujo.catalyst.buffer.Bytes

resize, size

Methods inherited from interface net.kuujo.catalyst.buffer.BytesInput

read, read, readBoolean, readByte, readChar, readDouble, readFloat, readInt, readLong, readMedium, readShort, readString, readUnsignedByte, readUnsignedInt, readUnsignedMedium, readUnsignedShort, readUTF8

Methods inherited from interface net.kuujo.catalyst.buffer.BytesOutput

flush, write, write, writeBoolean, writeByte, writeChar, writeDouble, writeFloat, writeInt, writeLong, writeMedium, writeShort, writeString, writeUnsignedByte, writeUnsignedInt, writeUnsignedMedium, writeUnsignedShort, writeUTF8, zero, zero, zero

Constructor Detail

AbstractBytes

public AbstractBytes()

Method Detail

isDirect

public boolean isDirect()

Description copied from interface: Bytes

Returns a boolean value indicating whether the bytes are direct.

Specified by:

isDirect in interface Bytes

Returns:

Indicates whether the bytes are direct.

isFile

public boolean isFile()

Description copied from interface: Bytes

Returns a boolean value indicating whether the bytes are backed by a file.

Specified by:

isFile in interface Bytes

Returns:

Indicates whether the bytes are backed by a file.

order

public ByteOrder order()

Description copied from interface: Bytes

Returns the byte order.

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

Specified by:

order in interface Bytes

Returns:

The byte order.

order

public Bytes order(ByteOrder order)

Description copied from interface: Bytes

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

By default, all bytes are read and written in ByteOrder.BIG_ENDIAN order. This provides complete consistency with ByteBuffer. To flip bytes to ByteOrder.LITTLE_ENDIAN order, this 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 Bytes

Parameters:

order - The byte order.

Returns:

The updated bytes.

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Bytes