com.latencybusters.lbm.sdm
Class LBMSDMFieldInt8

java.lang.Object
  com.latencybusters.lbm.sdm.LBMSDM
      com.latencybusters.lbm.sdm.LBMSDMField
          com.latencybusters.lbm.sdm.LBMSDMFieldInt8

All Implemented Interfaces:

java.lang.Cloneable

Direct Known Subclasses:

LBMSDMArrayInt8

public class LBMSDMFieldInt8
extends LBMSDMField
implements java.lang.Cloneable

Implements an 8 bit integer SDM Field

Field Summary

protected byte

internalValue The internal data storage for this field

Fields inherited from class com.latencybusters.lbm.sdm.LBMSDMField

elements, MAX_FIELD_NAME_LENGTH, name, type, TYPE_ARRAY_BLOB, TYPE_ARRAY_BOOLEAN, TYPE_ARRAY_DECIMAL, TYPE_ARRAY_DOUBLE, TYPE_ARRAY_FLOAT, TYPE_ARRAY_INT16, TYPE_ARRAY_INT32, TYPE_ARRAY_INT64, TYPE_ARRAY_INT8, TYPE_ARRAY_MESSAGE, TYPE_ARRAY_STRING, TYPE_ARRAY_TIMESTAMP, TYPE_ARRAY_UINT16, TYPE_ARRAY_UINT32, TYPE_ARRAY_UINT64, TYPE_ARRAY_UINT8, TYPE_ARRAY_UNICODE, TYPE_BLOB, TYPE_BOOLEAN, TYPE_DECIMAL, TYPE_DOUBLE, TYPE_FLOAT, TYPE_INT16, TYPE_INT32, TYPE_INT64, TYPE_INT8, TYPE_INVALID, TYPE_MESSAGE, TYPE_STRING, TYPE_TIMESTAMP, TYPE_UINT16, TYPE_UINT32, TYPE_UINT64, TYPE_UINT8, TYPE_UNICODE

Fields inherited from class com.latencybusters.lbm.sdm.LBMSDM

DEBUG_BASIC, debug_level, DEBUG_VERBOSE_PARSING

Constructor Summary

protected	LBMSDMFieldInt8(short type, java.lang.String name) Constructor for array subclasses
	LBMSDMFieldInt8(java.lang.String name) Constructor for an unset 8 bit integer field.
	LBMSDMFieldInt8(java.lang.String name, byte v) Constructor for an 8 bit integer field with a known byte

Method Summary

LBMSDMFieldInt8	clone() Get a copy of this object
static int	fixed_size() Get the length of formatted field (static field)
int	format(byte[] buf, int offset) Format the 8 bit integer in to a byte buffer
protected int	format(byte[] buf, int offset, byte v) Format an 8 bit integer in to a byte buffer
int	get_base_len() Get the length of formatted field This is used by the respective array class
int	get_len() Get the length of formatted field
byte	get() Get the 8 bit integer field (byte)
int	parse(byte[] buf, int offset) Parse a byte buffer and store the value
void	set(byte v) Set the 8 bit integer value from a byte.
java.lang.String	toDbgString() Get a string useful for debugging
java.lang.String	toString() Get the string form of the 8 bit integer

Methods inherited from class com.latencybusters.lbm.sdm.LBMSDMField

add_element, append, format_name, format_type, get_name, getType, getType, getTypeString, internalString, isNull, length, name_len, remove, sameBaseType, sameType, set_name, set, setNull, type_len

Methods inherited from class com.latencybusters.lbm.sdm.LBMSDM

log, set_debug_level

Methods inherited from class java.lang.Object

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

Field Detail

internalValue

protected byte internalValue

The internal data storage for this field

Constructor Detail

LBMSDMFieldInt8

public LBMSDMFieldInt8(java.lang.String name)

Constructor for an unset 8 bit integer field.

Parameters:

name - The field name

LBMSDMFieldInt8

public LBMSDMFieldInt8(java.lang.String name,
                       byte v)

Constructor for an 8 bit integer field with a known byte

Parameters:

name - The field name

v - The byte to be used as the field value

LBMSDMFieldInt8

protected LBMSDMFieldInt8(short type,
                          java.lang.String name)

Constructor for array subclasses

Parameters:

type - The field type to be created

name - The name of the field to be created

Method Detail

get

public byte get()

Get the 8 bit integer field (byte)

Returns:

the byte value

fixed_size

public static int fixed_size()

Get the length of formatted field (static field)

Returns:

The number of bytes a formatted byte will use

get_len

public int get_len()

Get the length of formatted field

Overrides:

get_len in class LBMSDMField

Returns:

The number of bytes a formatted byte will use!

get_base_len

public final int get_base_len()

Get the length of formatted field This is used by the respective array class

Returns:

The number of bytes a formatted byte will use!

set

public void set(byte v)

Set the 8 bit integer value from a byte.

Parameters:

v - The byte to be set

toDbgString

public java.lang.String toDbgString()

Get a string useful for debugging

Overrides:

toDbgString in class LBMSDMField

Returns:

A string representation of this object

format

protected int format(byte[] buf,
                     int offset,
                     byte v)
              throws LBMSDMException

Format an 8 bit integer in to a byte buffer

Parameters:

buf - The byte buffer to have the 8 bit integer formatted in

offset - The offset to begin formatting in the buffer

v - The 8 bit integer to be formatted

Returns:

The updated offset after formatting (points to an unused offset)

Throws:

LBMSDMException

format

public int format(byte[] buf,
                  int offset)
           throws LBMSDMException

Format the 8 bit integer in to a byte buffer

Overrides:

format in class LBMSDMField

Parameters:

buf - The byte buffer to have the 8 bit integer formatted in

offset - The offset to begin formatting in the buffer

Returns:

The updated offset after formatting (points to an unused offset)

Throws:

LBMSDMException - when an unexpected error occurs within LBMSDM

toString

public java.lang.String toString()

Get the string form of the 8 bit integer

Overrides:

toString in class java.lang.Object

Returns:

A String in the form of the 8 bit integer

parse

public int parse(byte[] buf,
                 int offset)
          throws LBMSDMException

Parse a byte buffer and store the value

Overrides:

parse in class LBMSDMField

Parameters:

buf - The byte buffer to be parsed for the boolean

offset - The offset to begin parsing the buffer

Returns:

The next offset to be parsed

Throws:

LBMSDMException - parse() should be overridden

clone

public LBMSDMFieldInt8 clone()
                      throws java.lang.CloneNotSupportedException

Get a copy of this object

Overrides:

clone in class LBMSDMField

Returns:

A new object with a copy

Throws:

java.lang.CloneNotSupportedException