com.latencybusters.lbm.sdm
Class LBMSDMArrayMessage

java.lang.Object
  com.latencybusters.lbm.sdm.LBMSDM
      com.latencybusters.lbm.sdm.LBMSDMField
          com.latencybusters.lbm.sdm.LBMSDMFieldMessage
              com.latencybusters.lbm.sdm.LBMSDMArrayMessage

All Implemented Interfaces:

java.lang.Cloneable, java.util.Iterator

public class LBMSDMArrayMessage
extends LBMSDMFieldMessage
implements java.lang.Cloneable, java.util.Iterator

Implements an SDM Field that is an array of SDM messages

Field Summary

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

internalValue

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

LBMSDMArrayMessage(java.lang.String name)
Constructor for a new array field

LBMSDMArrayMessage(java.lang.String name, boolean nullfield)
Constructor for a new array field

Method Summary

void	append(LBMSDMessage v) Append a value to the end of the array
void	append(LBMSDMField newfield) Append a value to the end of the array
LBMSDMArrayMessage	clone() Get a copy of this object
int	format(byte[] buf, int offset) Format the array in to a byte buffer
int	get_len() Get the length of formatted field
LBMSDMessage	get() Get the current field for this array
LBMSDMessage	get(int idx) Get the field for a specific array index
boolean	hasNext() Check to see if there is a next value
int	length() Get the length of this array
LBMSDMessage	next() Get the next element in the array
int	parse(byte[] buf, int offset) Parse a byte buffer and store the value
void	remove() Remove the current element
void	remove(int element) Remove an array element
void	reset() Reset the current element to the first
void	Reset() Reset the current element to the first
void	set(LBMSDMessage v) Set the current element
void	set(LBMSDMessage v, int idx) Set the current element based on the index
void	set(LBMSDMField newfield, int arrayindex) Set the current element based on the array index
java.lang.String	toDbgString() Get a string useful for debugging
java.lang.String	toString() Get the string form of the array

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

format

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

add_element, format_name, format_type, get_name, getType, getType, getTypeString, internalString, isNull, name_len, sameBaseType, sameType, set_name, 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

Constructor Detail

LBMSDMArrayMessage

public LBMSDMArrayMessage(java.lang.String name)

Constructor for a new array field

Parameters:

name - The name of the field

LBMSDMArrayMessage

public LBMSDMArrayMessage(java.lang.String name,
                          boolean nullfield)

Constructor for a new array field

Parameters:

name - The name of the field

nullfield - Boolean indicating if the field is a null field (true) or if its an array of 0 elements (non-null)

Method Detail

get

public LBMSDMessage get()

Get the current field for this array

Overrides:

get in class LBMSDMFieldMessage

Returns:

The current field value

get

public LBMSDMessage get(int idx)
                 throws LBMSDMException

Get the field for a specific array index

Parameters:

idx - The array index

Returns:

The current field value

Throws:

LBMSDMOutOfRangeException - when idx exceeds the number of elements in the array

LBMSDMException

get_len

public int get_len()

Get the length of formatted field

Overrides:

get_len in class LBMSDMFieldMessage

Returns:

The number of bytes a formatted message array will use

set

public void set(LBMSDMessage v)

Set the current element

Overrides:

set in class LBMSDMFieldMessage

Parameters:

v - The value to be set

set

public void set(LBMSDMessage v,
                int idx)

Set the current element based on the index

Parameters:

v - The value to be set

idx - The element of the array to be set

set

public void set(LBMSDMField newfield,
                int arrayindex)
         throws LBMSDMException

Set the current element based on the array index

Overrides:

set in class LBMSDMField

Parameters:

newfield - The new field

arrayindex - The array index in the field

Throws:

LBMSDMOutOfRangeException - when the array index exceeds the number of fields in the array

LBMSDMAddingFieldException - when a field doesnt exist at the array index

LBMSDMException

append

public void append(LBMSDMField newfield)
            throws LBMSDMException

Append a value to the end of the array

Overrides:

append in class LBMSDMField

Parameters:

newfield - The field value to be appended

Throws:

LBMSDMException - when a non array field tries to call append()

append

public void append(LBMSDMessage v)

Append a value to the end of the array

Parameters:

v - The field value to be appended

toDbgString

public java.lang.String toDbgString()

Get a string useful for debugging

Overrides:

toDbgString in class LBMSDMFieldMessage

Returns:

A string representation of this object

format

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

Format the array in to a byte buffer

Overrides:

format in class LBMSDMFieldMessage

Parameters:

buf - The byte buffer to have the array 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 array

Overrides:

toString in class LBMSDMFieldMessage

Returns:

A String in the form of the message

parse

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

Parse a byte buffer and store the value

Overrides:

parse in class LBMSDMFieldMessage

Parameters:

buf - The byte buffer to be parsed for the array

offset - The offset to begin parsing the buffer

Returns:

The next offset to be parsed

Throws:

LBMSDMException - parse() should be overridden

length

public int length()

Get the length of this array

Overrides:

length in class LBMSDMField

Returns:

The number of elements

clone

public LBMSDMArrayMessage clone()
                         throws java.lang.CloneNotSupportedException

Get a copy of this object

Overrides:

clone in class LBMSDMFieldMessage

Returns:

A new object with a copy

Throws:

java.lang.CloneNotSupportedException

remove

public void remove()

Remove the current element

Specified by:

remove in interface java.util.Iterator

next

public LBMSDMessage next()

Get the next element in the array

Specified by:

next in interface java.util.Iterator

Returns:

The next field value

hasNext

public boolean hasNext()

Check to see if there is a next value

Specified by:

hasNext in interface java.util.Iterator

reset

public void reset()

Reset the current element to the first

Reset

public void Reset()

Reset the current element to the first

remove

public void remove(int element)

Remove an array element

Overrides:

remove in class LBMSDMField

Parameters:

element - The element index to be removed