com.ergotech.secs

Class SecsFormat11

java.lang.Object

com.ergotech.secs.SecsFormat11

All Implemented Interfaces:

SecsFormat

public class SecsFormat11
extends java.lang.Object
implements SecsFormat

A representation of of the SECS Format11 (Boolean)

Field Summary

Fields

Modifier and Type	Field and Description
SecsFormat[]	dataArray This is the array of data if we receive an array.
int	length The length of this data, defaults to one.
boolean	theData The data value for this format.

Constructor Summary

Constructors

Constructor and Description
SecsFormat11() Creates a new object with the value "false".
SecsFormat11(boolean newValue) Creates a new object with the value provided.
SecsFormat11(int newValue) Creates a new object.

Method Summary

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 current value.
byte	getByteValue() Returns the current value as a long.
double	getDoubleValue() Returns the current value as a long.
float	getFloatValue() Returns the current value as a long.
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 current value as a long.
int	getLength() Returns the number of elements in the SecsFormat00.
long	getLongValue() Returns the current value as a long.
int	getNumberOfLengthBytes() Returns the number of length bytes.
short	getShortValue() Returns the current value as a long.
java.lang.String	getStringValue() Returns the current value as a string.
int	hashCode()
void	setArray(SecsFormat[] array) Set the data array if this is an array.
void	setDataFromByteArray(byte[] temp, int offset, int length) Interprets the data provided to create fill in an object of this type.
void	setLength(int newValue) Sets the length of format to the new value.
void	setNumberOfLengthBytes(int numberOfLengthBytes) Sets the number of length bytes to send when the format is encoded.
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() Ask if the list is a zero length list.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

dataArray

public SecsFormat[] dataArray

This is the array of data if we receive an array. The 0th element is also stored in theData so that you can use the first element the same way as always.

length

public int length

The length of this data, defaults to one.

theData

public boolean theData

The data value for this format.

Constructor Detail

SecsFormat11

public SecsFormat11()

Creates a new object with the value "false".

SecsFormat11

public SecsFormat11(boolean newValue)

Creates a new object with the value provided.

Parameters:

the - initial value for the object.

SecsFormat11

public SecsFormat11(int newValue)

Creates a new object. If the value provided is zero the value will be false, otherwise true.

Parameters:

newValue - the initial value to use

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 current value.

Specified by:

getBoolValue in interface SecsFormat

Returns:

true if the current value is true.

getByteValue

public byte getByteValue()

Returns the current value as a long.

Specified by:

getByteValue in interface SecsFormat

Returns:

1 or 0

getDoubleValue

public double getDoubleValue()

Returns the current value as a long.

Specified by:

getDoubleValue in interface SecsFormat

Returns:

1.0 or 0.0

getFloatValue

public float getFloatValue()

Returns the current value as a long.

Specified by:

getFloatValue in interface SecsFormat

Returns:

1.0 or 0.0

getFormattedBytes

public byte[] getFormattedBytes()

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.

getIntValue

public int getIntValue()

Returns the current value as a long.

Specified by:

getIntValue in interface SecsFormat

Returns:

1 or 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()

Returns the current value as a long.

Specified by:

getLongValue in interface SecsFormat

Returns:

1 or 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()

Returns the current value as a long.

Specified by:

getShortValue in interface SecsFormat

Returns:

1 or 0

getStringValue

public java.lang.String getStringValue()

Returns the current value as a string.

Specified by:

getStringValue in interface SecsFormat

Returns:

"true" or "false"

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

setArray

public void setArray(SecsFormat[] array)
              throws SecsException

Set the data array if this is an array.

Specified by:

setArray in interface SecsFormat

Throws:

SecsException

setDataFromByteArray

public void setDataFromByteArray(byte[] temp,
                                 int offset,
                                 int length)
                          throws SecsException

Interprets the data provided to create fill in an object of this type.

Specified by:

setDataFromByteArray in interface SecsFormat

Parameters:

temp - SECSII formatted data.

Throws:

SecsException

setLength

public void setLength(int newValue)

Sets the length of format to the new value.

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

toString

public java.lang.String toString()

Returns the SML string representing this value

Overrides:

toString in class java.lang.Object

Returns:

or

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