SecsFormat20 (ErgoTech VIB/TransSECS Scripting API)

java.lang.Object
- com.ergotech.secs.SecsFormat20

All Implemented Interfaces:: SecsFormat

public class SecsFormat20
extends java.lang.Object
implements SecsFormat

Field Summary

Fields
Modifier and Type	Field and Description
`int`	`justification` The jusfication (left or right) of this item.
`static int`	`LEFT_JUSTIFY` Jusfication constant.
`static int`	`RIGHT_JUSTIFY` Jusfication constant.
`java.lang.String`	`theData`

Constructor Summary

Constructors
Constructor and Description

SecsFormat20()

SecsFormat20(char[] newValue)

SecsFormat20(java.lang.String newValue)

Constructors
Constructor and Description
`SecsFormat20()`
`SecsFormat20(char[] newValue)`
`SecsFormat20(java.lang.String newValue)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`SecsFormat[]`	`getArray()` This allows for arrays of secsformats (not a list of secsformats).
`boolean`	`getBoolValue()` Returns the true if the length of the data is non-zero.
`byte`	`getByteValue()` Returns the data converted to a byte.
`double`	`getDoubleValue()` Returns the data converted to a double.
`float`	`getFloatValue()` Returns the data converted to a float.
`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()` Returns the data converted to a int.
`int`	`getJustification()` Get the justification of the formatted string.
`int`	`getLength()` Returns the length of the format.
`long`	`getLongValue()` Returns the data converted to a long.
`int`	`getNumberOfLengthBytes()` Returns the number of length bytes.
`short`	`getShortValue()` Returns the data converted to a short.
`java.lang.String`	`getStringValue()` Returns the data as a string.
`int`	`hashCode()`
`void`	`setArray(SecsFormat[] newValues)` This allows for a standard way to set arrays of secsformats.
`void`	`setDataFromByteArray(byte[] temp, int offset, int length)` stores the incoming value in the format object.
`void`	`setJustification(int justification)` Sets the justification of the formatted string.
`void`	`setLength(int newValue)` Sets the length of the format.
`void`	`setNumberOfLengthBytes(int numberOfLengthBytes)` Sets the number of length bytes to send when the format is encoded.
`int`	`size()`
`java.lang.String`	`toString()` Returns the SML string representing this value
`java.lang.String`	`toString(int indentCount)` Returns the indented SML string representing this value.
`boolean`	`zeroLength()` Returns true if the format is zero length.

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

- Field Detail
  - justification
```
public int justification
```
    The jusfication (left or right) of this item.
  - LEFT_JUSTIFY
```
public static final int LEFT_JUSTIFY
```
    Jusfication constant.
    
    See Also:
    
    Constant Field Values
  - RIGHT_JUSTIFY
```
public static final int RIGHT_JUSTIFY
```
    Jusfication constant.
    
    See Also:
    
    Constant Field Values
  - theData
```
public java.lang.String theData
```
- Constructor Detail
  - SecsFormat20
```
public SecsFormat20()
```
  - SecsFormat20
```
public SecsFormat20(char[] newValue)
```
  - SecsFormat20
```
public SecsFormat20(java.lang.String newValue)
```
- Method Detail
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - 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()
```
    Returns the true if the length of the data is non-zero.
    
    Specified by:
    
    getBoolValue in interface SecsFormat
    
    Returns:
    
    true if the string has characters, otherwise false.
  - getByteValue
```
public byte getByteValue()
```
    Returns the data converted to a byte. Will print an error and return zero if the value cannot be converted.
    
    Specified by:
    
    getByteValue in interface SecsFormat
    
    Returns:
    
    the data converted to a value
  - getDoubleValue
```
public double getDoubleValue()
```
    Returns the data converted to a double. Will print an error and return zero if the value cannot be converted.
    
    Specified by:
    
    getDoubleValue in interface SecsFormat
    
    Returns:
    
    the data converted to a value
  - getFloatValue
```
public float getFloatValue()
```
    Returns the data converted to a float. Will print an error and return zero if the value cannot be converted.
    
    Specified by:
    
    getFloatValue in interface SecsFormat
    
    Returns:
    
    the data converted to a value
  - 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()
```
    Returns the data converted to a int. Will print an error and return zero if the value cannot be converted.
    
    Specified by:
    
    getIntValue in interface SecsFormat
    
    Returns:
    
    the data converted to a value
  - getJustification
```
public int getJustification()
```
    Get the justification of the formatted string.
    
    Parameters:
    
    the - justification
  - getLength
```
public int getLength()
```
    Description copied from interface: SecsFormat
    
    Returns the length of the format.
    
    Specified by:
    
    getLength in interface SecsFormat
    
    Returns:
    
    the length
  - getLongValue
```
public long getLongValue()
```
    Returns the data converted to a long. Will print an error and return zero if the value cannot be converted.
    
    Specified by:
    
    getLongValue in interface SecsFormat
    
    Returns:
    
    the data converted to a value
  - 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()
```
    Returns the data converted to a short. Will print an error and return zero if the value cannot be converted.
    
    Specified by:
    
    getShortValue in interface SecsFormat
    
    Returns:
    
    the data converted to a value
  - getStringValue
```
public java.lang.String getStringValue()
```
    Returns the data as a string.
    
    Specified by:
    
    getStringValue in interface SecsFormat
    
    Returns:
    
    the data itself
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - 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 SecsFormat20 in it.
    
    Specified by:
    
    setArray in interface SecsFormat
    
    Throws:
    
    SecsException
  - setDataFromByteArray
```
public void setDataFromByteArray(byte[] temp,
                                 int offset,
                                 int length)
                          throws SecsException
```
    Description copied from interface: SecsFormat
    
    stores the incoming value in the format object. The method of storage is type-specific. For example, the integer classes convert the incoming byte array to integers. Format20 the ASCII format uses a String, and so forth. This method will raise a SecsException if the value cannot be converted.
    
    Specified by:
    
    setDataFromByteArray in interface SecsFormat
    
    Throws:
    
    SecsException
  - setJustification
```
public void setJustification(int justification)
```
    Sets the justification of the formatted string. The justification must be set before the length.
    
    Parameters:
    
    the - justification
  - setLength
```
public void setLength(int newValue)
```
    Description copied from interface: SecsFormat
    
    Sets the length of the format.
    
    Specified by:
    
    setLength in interface SecsFormat
    
    Parameters:
    
    newValue - the new length
  - 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
  - size
```
public int size()
```
  - toString
```
public java.lang.String toString()
```
    Returns the SML string representing this value
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
  - 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:
  - zeroLength
```
public boolean zeroLength()
```
    Description copied from interface: SecsFormat
    
    Returns true if the format is zero length.
    
    Specified by:
    
    zeroLength in interface SecsFormat

Class SecsFormat20

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

justification

LEFT_JUSTIFY

RIGHT_JUSTIFY

theData

Constructor Detail

SecsFormat20

SecsFormat20

SecsFormat20

Method Detail

equals

getArray

getBoolValue

getByteValue

getDoubleValue

getFloatValue

getFormattedBytes

getIntValue

getJustification

getLength

getLongValue

getNumberOfLengthBytes

getShortValue

getStringValue

hashCode

setArray

setDataFromByteArray

setJustification

setLength

setNumberOfLengthBytes

size

toString

toString

zeroLength