com.neeve.sto
Class StoFixedLengthStringField

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

All Implemented Interfaces:

Cloneable

public final class StoFixedLengthStringField
extends StoField

An STO field that holds a fixed length string.

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 StoFixedLengthStringField	create(ByteBuffer buffer, int offset) Create an STO fixed length string field from its serialized form.
static StoFixedLengthStringField	create(String name, int len) Create an STO fixed length string field.
static int	getSerializedLength(ByteBuffer buffer, int offset) Get the length of a serialized fixed length string value.
String	getValue() Get the field value
boolean	isVariableLength() Implementation of StoField.isVariableLength()
void	reset() Implementation of StoField.reset()
void	setValue(String 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

create

public static StoFixedLengthStringField create(String name,
                                               int len)

Create an STO fixed length string field.

Parameters:

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

len - The fixed field length. The field length must be > 0.

create

public static StoFixedLengthStringField create(ByteBuffer buffer,
                                               int offset)

Create an STO fixed length string field from its serialized form.

Parameters:

buffer - The buffer containing the serialized field.

offset - 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 fixed length string 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.

isVariableLength

public final boolean isVariableLength()

Implementation of StoField.isVariableLength()

Specified by:

isVariableLength in class StoField

reset

public final void reset()

Implementation of StoField.reset()

Specified by:

reset in class StoField

setValue

public final void setValue(String val)

Set the field value

Parameters:

val - The value to set.

getValue

public final String getValue()

Get the field value