com.neeve.sto
Class StoBooleanField

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

All Implemented Interfaces:

Cloneable

public final class StoBooleanField
extends StoField

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

Create an STO boolean field.

Parameters:

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

create

public static StoBooleanField create(ByteBuffer buffer,
                                     int bufferOffset)

Create an STO boolean 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.

This method leaves the buffer markers intact.

getSerializedLength

public static int getSerializedLength(ByteBuffer buffer,
                                      int offset)

Get the length of a serialized boolean 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,
                       boolean val)

Serialize a boolean 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 boolean get(ByteBuffer buffer,
                          int offset)

Deserialize a boolean 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.

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(boolean val)

Set the field value

Parameters:

val - The value to set.

getValue

public final boolean getValue()

Get the field value