com.neeve.sto
Class StoByteArrayField

java.lang.Object
  com.neeve.util.UtlListElement
      com.neeve.sto.StoField
          com.neeve.sto.StoVariableLengthField<byte[]>
              com.neeve.sto.StoByteArrayField

All Implemented Interfaces:

Cloneable

public final class StoByteArrayField
extends StoVariableLengthField<byte[]>

An STO field that holds an array of byte values.

TODO

Threading:

STO fields are not safe for concurrent access by multiple threads.

Nested Class Summary

Nested classes/interfaces inherited from class com.neeve.sto.StoField

StoField.Type

Field Summary

Fields inherited from class com.neeve.util.UtlListElement

count, head, next, prev

Method Summary

static StoByteArrayField	create(ByteBuffer buffer, int bufferOffset) Create an STO byte array field from its serialized form.
static StoByteArrayField	create(String name) Create an STO byte array field.
static byte[]	get(ByteBuffer buffer, int offset) Deserialize an byte array.
static int	getSerializedLength(byte[] val) Get the serialized length of an byte array.
static int	getSerializedLength(ByteBuffer buffer, int offset) Get the length of a serialized byte array.
static void	put(ByteBuffer buffer, int offset, byte[] val) Serialize an byte array.

Methods inherited from class com.neeve.sto.StoVariableLengthField

getValue, isVariableLength, reset, setValue

Methods inherited from class com.neeve.sto.StoField

changeBackingBuffer, clearBackingBuffer, clone, contentsEquals, getBackingBuffer, getHeader, getLength, getName, getSerializedLength, getType, getVersion, isNamed, setBackingBuffer, shiftForHeader, sync, toString

Methods inherited from class com.neeve.util.UtlListElement

count, insertAfter, insertBefore, isLinked, next, previous, unlink, wipe

Methods inherited from class java.lang.Object

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

Method Detail

create

public static StoByteArrayField create(String name)

Create an STO byte array field.

Parameters:

name - The name of the field. A value of null will cause an unnamed field to be created.

create

public static StoByteArrayField create(ByteBuffer buffer,
                                       int bufferOffset)

Create an STO byte array field from its serialized form.

Parameters:

buffer - The buffer to deserialize the field from.

bufferOffset - The offset into the supplied buffer from where to deserialize the field.

getSerializedLength

public static int getSerializedLength(ByteBuffer buffer,
                                      int offset)

Get the length of a serialized byte array.

Parameters:

buffer - The buffer containing the serialized array.

offset - The offset into the buffer where the array is serialized.

This method leaves the buffer markers intact.

getSerializedLength

public static int getSerializedLength(byte[] val)

Get the serialized length of an byte array.

Parameters:

val - The byte array whose serialized length is to be returned.

put

public static void put(ByteBuffer buffer,
                       int offset,
                       byte[] val)

Serialize an byte array.

Parameters:

buffer - The buffer in which to serialize the array.

offset - The offset into the buffer at which point to serialize the array.

This method leaves the buffer markers intact.

get

public static byte[] get(ByteBuffer buffer,
                         int offset)

Deserialize an byte array.

Parameters:

buffer - The byte array from which to deserialize the value.

offset - The offset into the array from which to deserialize the array.

This method leaves the buffer markers intact.