objects

Class ArrayOfByte

java.lang.Object

objects.ArrayOfByte

public class ArrayOfByte
extends Object

An array of bytes that encodes an "index". Note that this class does not implement the ConfigurableObject or TimestampedObject interfaces, and therefore must be special cased in ObjectHelper methods.

Since:

3.0

See Also:

ArrayOfBytePrms

Constructor Summary

Constructors

Constructor and Description
ArrayOfByte()

Method Summary

Modifier and Type	Method and Description
static int	getIndex(byte[] bytes) Returns the index encoded in the give byte array.
static long	getTimestamp(byte[] bytes) Returns the timestamp encoded in the give byte array, if any.
static byte[]	init(int index) Returns a byte array that optionally encodes the given index and a timestamp.
protected static byte[]	init(int index, int size, boolean encodeKey, boolean encodeTimestamp) Returns a byte array that optionally encodes the given index and a timestamp.
static void	resetTimestamp(byte[] bytes) Resets the timestamp to the current time.
static void	validate(int index, byte[] bytes) Validates that the given index is encoded in the given byte array.

Methods inherited from class java.lang.Object

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

Constructor Detail

ArrayOfByte

public ArrayOfByte()

Method Detail

init

public static byte[] init(int index)

Returns a byte array that optionally encodes the given index and a timestamp.

Throws:

ObjectCreationException - information cannot be encoded

init

protected static byte[] init(int index,
                             int size,
                             boolean encodeKey,
                             boolean encodeTimestamp)

Returns a byte array that optionally encodes the given index and a timestamp.

Throws:

ObjectCreationException - information cannot be encoded

getIndex

public static int getIndex(byte[] bytes)

Returns the index encoded in the give byte array.

Throws:

ObjectAccessException - The index cannot be decoded from bytes

getTimestamp

public static long getTimestamp(byte[] bytes)

Returns the timestamp encoded in the give byte array, if any.

Throws:

HydraConfigException - The object is not configured to encode a timestamp.

ObjectAccessException - The timestamp cannot be decoded from bytes

resetTimestamp

public static void resetTimestamp(byte[] bytes)

Resets the timestamp to the current time.

validate

public static void validate(int index,
                            byte[] bytes)

Validates that the given index is encoded in the given byte array.

Throws:

ObjectValidationException - If index is not encoded in bytes