SecsFormat00 (ErgoTech VIB/TransSECS Scripting API)

java.lang.Object
- java.util.AbstractCollection<E>
- - java.util.AbstractList<E>
  - - java.util.Vector<SecsFormat>
    - - com.ergotech.secs.SecsFormat00

All Implemented Interfaces:

SecsFormat, java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<SecsFormat>, java.util.Collection<SecsFormat>, java.util.List<SecsFormat>, java.util.RandomAccess
```
public class SecsFormat00
extends java.util.Vector<SecsFormat>
implements SecsFormat
```
This class is a representation of a Format00 or "List".

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`int`	`currentPosition` This is a convienence variable.
`static java.lang.String`	`cvsRev`
`static java.lang.String`	`indentCharacters` sets the indent charaters for SML formatting.
`static boolean`	`JSON` Set to true to output the "toString" as JSON.

Constructor Summary

Constructors
Constructor and Description
`SecsFormat00()` Required default constructor
`SecsFormat00(int newValue)` Creates an empty list of the provided length.
`SecsFormat00(SecsFormat onlyOne)` Creates a list of length one containing only the object provided.
`SecsFormat00(SecsFormat[] theData)` Create the list from an array of SecsFormat objects.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(int index, SecsFormat element)` Check for null element
`boolean`	`add(SecsFormat obj)` Check for null element
`void`	`addBinaryValue(byte value)` Add a simple type to the list
`void`	`addBinaryValues(byte[] values)` Add a simple type to the list
`void`	`addBoolValue(boolean value)` Add a simple type to the list
`void`	`addByteValue(byte value)` Add a simple type to the list
`void`	`addDoubleValue(double value)` Add a simple type to the list
`void`	`addElement(SecsFormat obj)` Provides backwards compatibility.
`void`	`addFloatValue(float value)` Add a simple type to the list
`void`	`addIntValue(int value)` Add a simple type to the list
`void`	`addLongValue(long value)` Add a simple type to the list
`void`	`addShortValue(short value)` Add a simple type to the list
`void`	`addStringValue(java.lang.String value)` Add a simple type to the list
`void`	`addUByteValue(short value)` Add a simple type to the list
`void`	`addUIntValue(long value)` Add a simple type to the list
`void`	`addULongValue(long value)` Add a simple type to the list
`void`	`addUShortValue(int value)` Add a simple type to the list
`SecsFormat`	`elementAt(int index)` Provides backwards compatibility.
`SecsFormat[]`	`getArray()` This allows for arrays of secsformats (not a list of secsformats).
`boolean`	`getBoolValue()` This method is required by the interface and has no meaning to the list.
`byte`	`getByteValue()` This method is required by the interface and has no meaning to the list.
`double`	`getDoubleValue()` Add a simple type to the list
`float`	`getFloatValue()` Add a simple type to the list
`byte[]`	`getFormattedBytes()` Returns the list in a manner suitable for encoding directly into a SECS message byte stream used over SECSI or HSMS transport.
`int`	`getIntValue()` This method is required by the interface and has no meaning to the list.
`int`	`getLength()` Returns the number of elements in the SecsFormat00.
`long`	`getLongValue()` This method is required by the interface and has no meaning to the list.
`int`	`getNumberOfLengthBytes()` Returns the number of length bytes.
`short`	`getShortValue()` This method is required by the interface and has no meaning to the list.
`java.lang.String`	`getStringValue()` This method is required by the interface and has no meaning to the list.
`void`	`insertElementAt(SecsFormat obj, int index)` Check for null element
`SecsFormat`	`set(int index, SecsFormat element)` Check for null element
`void`	`setArray(SecsFormat[] newValues)` This allows for a standard way to set arrays of secsformats.
`void`	`setDataFromByteArray(byte[] temp, int offset, int length)` This method should not be called.
`void`	`setElementAt(SecsFormat obj, int index)` Check for null element
`void`	`setLength(int newValue)` Requests that the length of the list be set to the provided length.
`void`	`setNumberOfLengthBytes(int numberOfLengthBytes)` Sets the number of length bytes to send when the format is encoded.
`static void`	`setUnrecoverableErrorHandler(UnrecoverableErrorInterface errorHandler)`
`java.lang.String`	`toSMLString()` Returns the SML string representing this value
`java.lang.String`	`toString()`
`java.lang.String`	`toString(int indentCount)` Returns the indented SML string representing this value.
`boolean`	`zeroLength()` Ask if the list is a zero length list.

Methods inherited from class java.util.Vector
addAll, addAll, capacity, clear, clone, contains, containsAll, copyInto, elements, ensureCapacity, equals, firstElement, forEach, get, hashCode, indexOf, indexOf, isEmpty, iterator, lastElement, lastIndexOf, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeAllElements, removeElement, removeElementAt, removeIf, replaceAll, retainAll, setSize, size, sort, spliterator, subList, toArray, toArray, trimToSize

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection
parallelStream, stream

- Field Detail
  - currentPosition
```
public int currentPosition
```
    This is a convienence variable. One technique used to decompose a message is to place each List element in a java.util.Stack object. The variable allow you to keep track of the state of this list when it is pushed or popped.
  - cvsRev
```
public static final java.lang.String cvsRev
```
    See Also:
    
    Constant Field Values
  - indentCharacters
```
public static java.lang.String indentCharacters
```
    sets the indent charaters for SML formatting. Defaults to 2 spaces " ".
  - JSON
```
public static boolean JSON
```
    Set to true to output the "toString" as JSON. "setStringValue" will also decode JSON.
- Constructor Detail
  - SecsFormat00
```
public SecsFormat00()
```
    Required default constructor
  - SecsFormat00
```
public SecsFormat00(int newValue)
```
    Creates an empty list of the provided length.
    
    Parameters:
    
    newValue - the length of the new list
  - SecsFormat00
```
public SecsFormat00(SecsFormat onlyOne)
```
    Creates a list of length one containing only the object provided.
    
    Parameters:
    
    onlyOne - the object to place in the List.
  - SecsFormat00
```
public SecsFormat00(SecsFormat[] theData)
```
    Create the list from an array of SecsFormat objects.
    
    Parameters:
    
    theData - and array of SecsFormat objects as defined by the message definition.
- Method Detail
  - add
```
public void add(int index,
                SecsFormat element)
```
    Check for null element
    
    Specified by:
    
    add in interface java.util.List<SecsFormat>
    
    Overrides:
    
    add in class java.util.Vector<SecsFormat>
  - add
```
public boolean add(SecsFormat obj)
```
    Check for null element
    
    Specified by:
    
    add in interface java.util.Collection<SecsFormat>
    
    Specified by:
    
    add in interface java.util.List<SecsFormat>
    
    Overrides:
    
    add in class java.util.Vector<SecsFormat>
  - addBinaryValue
```
public void addBinaryValue(byte value)
```
    Add a simple type to the list
  - addBinaryValues
```
public void addBinaryValues(byte[] values)
```
    Add a simple type to the list
  - addBoolValue
```
public void addBoolValue(boolean value)
```
    Add a simple type to the list
  - addByteValue
```
public void addByteValue(byte value)
```
    Add a simple type to the list
  - addDoubleValue
```
public void addDoubleValue(double value)
```
    Add a simple type to the list
  - addElement
```
public void addElement(SecsFormat obj)
```
    Provides backwards compatibility.
    
    Overrides:
    
    addElement in class java.util.Vector<SecsFormat>
  - addFloatValue
```
public void addFloatValue(float value)
```
    Add a simple type to the list
  - addIntValue
```
public void addIntValue(int value)
```
    Add a simple type to the list
  - addLongValue
```
public void addLongValue(long value)
```
    Add a simple type to the list
  - addShortValue
```
public void addShortValue(short value)
```
    Add a simple type to the list
  - addStringValue
```
public void addStringValue(java.lang.String value)
```
    Add a simple type to the list
  - addUByteValue
```
public void addUByteValue(short value)
```
    Add a simple type to the list
  - addUIntValue
```
public void addUIntValue(long value)
```
    Add a simple type to the list
  - addULongValue
```
public void addULongValue(long value)
```
    Add a simple type to the list
  - addUShortValue
```
public void addUShortValue(int value)
```
    Add a simple type to the list
  - elementAt
```
public SecsFormat elementAt(int index)
```
    Provides backwards compatibility.
    
    Overrides:
    
    elementAt in class java.util.Vector<SecsFormat>
  - getArray
```
public SecsFormat[] getArray()
```
    This allows for arrays of secsformats (not a list of secsformats). This will ALWAYS return an valid array... but if the SecsFormat has only one element, it will return an array of secsformats with one element (itself).
    
    Specified by:
    
    getArray in interface SecsFormat
  - getBoolValue
```
public boolean getBoolValue()
```
    This method is required by the interface and has no meaning to the list.
    
    Specified by:
    
    getBoolValue in interface SecsFormat
    
    Returns:
    
    false.
  - getByteValue
```
public byte getByteValue()
```
    This method is required by the interface and has no meaning to the list.
    
    Specified by:
    
    getByteValue in interface SecsFormat
    
    Returns:
    
    0.
  - getDoubleValue
```
public double getDoubleValue()
```
    Add a simple type to the list
    
    Specified by:
    
    getDoubleValue in interface SecsFormat
    
    Returns:
    
    0.
  - getFloatValue
```
public float getFloatValue()
```
    Add a simple type to the list
    
    Specified by:
    
    getFloatValue in interface SecsFormat
    
    Returns:
    
    0.
  - getFormattedBytes
```
public byte[] getFormattedBytes()
                         throws SecsException
```
    Returns the list in a manner suitable for encoding directly into a SECS message byte stream used over SECSI or HSMS transport.
    
    Specified by:
    
    getFormattedBytes in interface SecsFormat
    
    Returns:
    
    a SECSII formatted byte array.
    
    Throws:
    
    SecsException
  - getIntValue
```
public int getIntValue()
```
    This method is required by the interface and has no meaning to the list.
    
    Specified by:
    
    getIntValue in interface SecsFormat
    
    Returns:
    
    0.
  - getLength
```
public int getLength()
```
    Returns the number of elements in the SecsFormat00.
    
    Specified by:
    
    getLength in interface SecsFormat
    
    Returns:
    
    the length of the list
  - getLongValue
```
public long getLongValue()
```
    This method is required by the interface and has no meaning to the list.
    
    Specified by:
    
    getLongValue in interface SecsFormat
    
    Returns:
    
    0.
  - getNumberOfLengthBytes
```
public int getNumberOfLengthBytes()
```
    Returns the number of length bytes. This will return -1 if the default number of length bytes are to be used, otherwise it will return 1, 2, or 3
    
    Specified by:
    
    getNumberOfLengthBytes in interface SecsFormat
  - getShortValue
```
public short getShortValue()
```
    This method is required by the interface and has no meaning to the list.
    
    Specified by:
    
    getShortValue in interface SecsFormat
    
    Returns:
    
    0.
  - getStringValue
```
public java.lang.String getStringValue()
```
    This method is required by the interface and has no meaning to the list.
    
    Specified by:
    
    getStringValue in interface SecsFormat
    
    Returns:
    
    null.
  - insertElementAt
```
public void insertElementAt(SecsFormat obj,
                            int index)
```
    Check for null element
    
    Overrides:
    
    insertElementAt in class java.util.Vector<SecsFormat>
  - set
```
public SecsFormat set(int index,
                      SecsFormat element)
```
    Check for null element
    
    Specified by:
    
    set in interface java.util.List<SecsFormat>
    
    Overrides:
    
    set in class java.util.Vector<SecsFormat>
  - setArray
```
public void setArray(SecsFormat[] newValues)
              throws SecsException
```
    This allows for a standard way to set arrays of secsformats. This should also be valid if an array of one element be set. This will throw a secs exception if the secsformats are invalid or if (We will only accept a 1 element array with a SecsFormat00 in it.
    
    Specified by:
    
    setArray in interface SecsFormat
    
    Throws:
    
    SecsException
  - setDataFromByteArray
```
public void setDataFromByteArray(byte[] temp,
                                 int offset,
                                 int length)
```
    This method should not be called.
    
    Specified by:
    
    setDataFromByteArray in interface SecsFormat
  - setElementAt
```
public void setElementAt(SecsFormat obj,
                         int index)
```
    Check for null element
    
    Overrides:
    
    setElementAt in class java.util.Vector<SecsFormat>
  - setLength
```
public void setLength(int newValue)
```
    Requests that the length of the list be set to the provided length. If the new length is less than or equal to zero then all elements of the list are removed. If the length is less than the current size then elements are removed from the end of the list until it is the requested size. If the new length is greater than the existing length the the new length is ignored.
    
    Specified by:
    
    setLength in interface SecsFormat
    
    Parameters:
    
    newValue - the new requested length for the list
  - setNumberOfLengthBytes
```
public void setNumberOfLengthBytes(int numberOfLengthBytes)
                            throws java.lang.IllegalArgumentException
```
    Sets the number of length bytes to send when the format is encoded. The SecsFormat will normally send the minimum number of length bytes required for the format. This allows that to be overridden so a different number of length bytes can be send. The only available number for the length bytes are -1, 1, 2 or 3. A value of -1 indicates that the default number of length bytes should be used. Any other value will throw an "IllegalArgumentException".
    
    Specified by:
    
    setNumberOfLengthBytes in interface SecsFormat
    
    Parameters:
    
    numberOfLengthBytes - the new number of length bytes. This should be 1, 2,3 or -1 to indicate the default
    
    Throws:
    
    java.lang.IllegalArgumentException - if the value is not 1, 2, 3 or -1
  - setUnrecoverableErrorHandler
```
public static void setUnrecoverableErrorHandler(UnrecoverableErrorInterface errorHandler)
```
  - toSMLString
```
public java.lang.String toSMLString()
```
    Returns the SML string representing this value
    
    Returns:
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.util.Vector<SecsFormat>
  - toString
```
public java.lang.String toString(int indentCount)
```
    Returns the indented SML string representing this value.
    
    Specified by:
    
    toString in interface SecsFormat
    
    Parameters:
    
    the - indentation
    
    Returns:
    
    or
  zeroLength
  
  public boolean zeroLength()
  
  Ask if the list is a zero length list.
  
  Specified by:
  
  zeroLength in interface SecsFormat
  
  Returns:
  
  true if the list is zero length, otherwise false

Class SecsFormat00

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.util.Vector

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Collection

Field Detail

currentPosition

cvsRev

indentCharacters

JSON

Constructor Detail

SecsFormat00

SecsFormat00

SecsFormat00

SecsFormat00

Method Detail

add

add

addBinaryValue

addBinaryValues

addBoolValue

addByteValue

addDoubleValue

addElement

addFloatValue

addIntValue

addLongValue

addShortValue

addStringValue

addUByteValue

addUIntValue

addULongValue

addUShortValue

elementAt

getArray

getBoolValue

getByteValue

getDoubleValue

getFloatValue

getFormattedBytes

getIntValue

getLength

getLongValue

getNumberOfLengthBytes

getShortValue

getStringValue

insertElementAt

set

setArray

setDataFromByteArray

setElementAt

setLength

setNumberOfLengthBytes

setUnrecoverableErrorHandler

toSMLString

toString

toString

zeroLength