com.neeve.sto
Class StoShortField

java.lang.Object
  com.neeve.util.UtlListElement
      com.neeve.sto.StoField
          com.neeve.sto.StoShortField

All Implemented Interfaces:

Cloneable

public final class StoShortField
extends StoField

An STO field that holds a short value.

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 StoShortField	create(ByteBuffer buffer, int bufferOffset) Create an STO short field from its serialized form.
static StoShortField	create(String name) Create an STO short field.
static short	get(ByteBuffer buffer, int offset) Deserialize a short value.
static int	getSerializedLength(ByteBuffer buffer, int offset) Get the length of a serialized short value.
short	getValue() Get the field value
boolean	isVariableLength() Implementation of StoField.isVariableLength()
static void	put(ByteBuffer buffer, int offset, short val) Serialize a short value.
void	reset() Implementation of StoField.reset()
void	setValue(short val) Set the field value

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

isVariableLength

public final boolean isVariableLength()

Implementation of StoField.isVariableLength()

Specified by:

isVariableLength in class StoField

create

public static StoShortField create(String name)

Create an STO short field.

Parameters:

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

create

public static StoShortField create(ByteBuffer buffer,
                                   int bufferOffset)

Create an STO short field from its serialized form.

Parameters:

buffer - The buffer containing the serialized field.

bufferOffset - The offset into the buffer where the serialized form of the field begins.

getSerializedLength

public static int getSerializedLength(ByteBuffer buffer,
                                      int offset)

Get the length of a serialized short value.

Parameters:

buffer - The buffer containing the serialized value.

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

This method leaves the buffer markers intact.

put

public static void put(ByteBuffer buffer,
                       int offset,
                       short val)

Serialize a short value.

Parameters:

buffer - The buffer in which to serialize the value.

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

This method leaves the buffer markers intact.

get

public static short get(ByteBuffer buffer,
                        int offset)

Deserialize a short value.

Parameters:

buffer - The buffer from which to deserialize the value.

offset - The offset into the buffer from which to deserialize the value.

This method leaves the buffer markers intact.

reset

public final void reset()

Implementation of StoField.reset()

Specified by:

reset in class StoField

setValue

public final void setValue(short val)

Set the field value

Parameters:

val - The value to set.

getValue

public final short getValue()

Get the field value