com.nt.udc.ndk.node

Class ListField

java.lang.Object

com.nt.udc.ndk.node.DCField

com.nt.udc.ndk.node.ListField

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class ListField
extends DCField

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	LENGTH

Fields inherited from class com.nt.udc.ndk.node.DCField

ATTR_HEADER_SIZE, BYTE, BYTES, datatype, DOUBLE, FLOAT, INTEGER, IP, IPV6, LIST, LONG, MAC, MAP, NULL, OBJECT, SHORT, STRING, TIMEINMILLIS, TIMEINSECONDS, UINT128, value

Constructor Summary

Constructors

Constructor and Description
ListField()
ListField(FieldKey key)
ListField(FieldKey key, byte[] val)
ListField(int id, byte[] val) Deprecated.
ListField(int id, java.util.Collection fields) Deprecated.
ListField(java.lang.String id, byte[] val) Deprecated.

Method Summary

Methods

Modifier and Type	Method and Description
void	addField(DCField field)
void	addFields(java.util.Collection fieldList)
void	appendList(ListField list)
void	clear()
DCField	firstField()
byte[]	getBytesValue()
DCField	getField(int index) Returns the field at the specified position in this list.
int	getLength()
java.util.List	getList() Return the fields in the ListField as a List.
java.lang.String	getStringValue()
int	getType()
boolean	isEmpty()
java.util.Iterator	iterator()
DCField	lastField()
void	removeField(DCField field)
void	removeField(int index)
void	removeField(java.lang.String key)
void	setValue(byte[] newVal) Sets the value of this DCField to what is contained in valueBytes
void	setValue(java.util.Collection fields)
int	size()
java.lang.String	toString()
void	updateBytes()

Methods inherited from class com.nt.udc.ndk.node.DCField

clone, create, dup, equals, equalsValue, getBytes, getByteValue, getDateValue, getDCField, getDCField, getDCField, getDoubleValue, getFloatValue, getID, getIntValue, getKey, getLongValue, getShortValue, getStaticAttrLength, init, init, init, isVarLength, makeAttrfromBytes, makeAttrfromBytes, makeAttrfromBytes, makeAttrfromBytes, makeAttrfromStream, readValueFromStream, setID, setID, setKey, setType, writeValueToStream

Methods inherited from class java.lang.Object

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

Field Detail

LENGTH

public static final int LENGTH

See Also:

Constant Field Values

Constructor Detail

ListField

public ListField()

ListField

public ListField(FieldKey key,
         byte[] val)

ListField

public ListField(FieldKey key)

ListField

public ListField(java.lang.String id,
         byte[] val)

Deprecated.

ListField

public ListField(int id,
         java.util.Collection fields)

Deprecated.

ListField

public ListField(int id,
         byte[] val)

Deprecated.

Method Detail

addField

public void addField(DCField field)

removeField

public void removeField(DCField field)

removeField

public void removeField(java.lang.String key)

removeField

public void removeField(int index)

setValue

public void setValue(byte[] newVal)
              throws NDKException

Description copied from class: DCField

Sets the value of this DCField to what is contained in valueBytes

NOTE: Caveat Machinator (Engineer beware)
At this time, there is no validation of the byte array passed in to this method. The developer should ensure that the bytes used to create this DCField object are appropriate for the specific data type. For example, a byte[] consisting of 7 bytes should not be used to create an IntField object.

Overrides:

setValue in class DCField

Throws:

NDKException

addFields

public void addFields(java.util.Collection fieldList)

updateBytes

public void updateBytes()

getType

public int getType()

Overrides:

getType in class DCField

Returns:

the type for this DCField object

getBytesValue

public byte[] getBytesValue()
                     throws java.lang.ClassCastException

Overrides:

getBytesValue in class DCField

Returns:

a byte array containing the value of this DCField

Throws:

java.lang.ClassCastException

getStringValue

public java.lang.String getStringValue()

Overrides:

getStringValue in class DCField

toString

public java.lang.String toString()

Overrides:

toString in class DCField

size

public int size()

setValue

public void setValue(java.util.Collection fields)

lastField

public DCField lastField()

firstField

public DCField firstField()

getField

public DCField getField(int index)

Returns the field at the specified position in this list.

Performance Note: Finding the element at a given position performs a linear search through the list. Thus, this method should be avoided when possible. Stepping through all elements of the list should be done with the iterator instead.

Parameters:

index - index of element to return.

Returns:

the field at the specified position in this list.

clear

public void clear()

isEmpty

public boolean isEmpty()

Overrides:

isEmpty in class DCField

appendList

public void appendList(ListField list)

iterator

public java.util.Iterator iterator()

getLength

public int getLength()

Overrides:

getLength in class DCField

Returns:

the length of this DCField's byte array

getList

public java.util.List getList()

Return the fields in the ListField as a List. This list is a copy of the elements - modifications to the list are not allowed.

Returns:

an unmodifiable List containing DCField objects