org.ka2ddo.opentrac
Class OpenTracByte

java.lang.Object
  extended by org.ka2ddo.opentrac.OpenTracElement
      extended by org.ka2ddo.opentrac.OpenTracByte
All Implemented Interfaces:
java.io.Serializable

public class OpenTracByte
extends OpenTracElement

This class represents any type of OpenTRAC data element that has a single byte as its value.

See Also:
Serialized Form

Field Summary
 
Fields inherited from class org.ka2ddo.opentrac.OpenTracElement
id
 
Constructor Summary
OpenTracByte()
          Create an uninitialized OpenTracByte object.
OpenTracByte(int type, byte[] body, int offset, int length)
          Create an OpenTracByte object read from a byte array.
 
Method Summary
 int computeBody(byte[] buf, int offset)
          Append this element to a message buffer
 boolean equals(OpenTracElement other)
          Test if this OpenTracElement has the same type and value as another OpenTracElement.
 int length()
          Return the number of bytes needed to encode this element.
 java.lang.String valueString()
          Get the string representation of the value of this element.
 
Methods inherited from class org.ka2ddo.opentrac.OpenTracElement
getId, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

OpenTracByte

public OpenTracByte()
Create an uninitialized OpenTracByte object.


OpenTracByte

public OpenTracByte(int type,
                    byte[] body,
                    int offset,
                    int length)
Create an OpenTracByte object read from a byte array.

Parameters:
type - OpenTRAC element type
body - byte array to read
offset - zero-based index into array to start reading
length - used bytes remaining in the array
Method Detail

valueString

public java.lang.String valueString()
Get the string representation of the value of this element.

Specified by:
valueString in class OpenTracElement
Returns:
value string

computeBody

public int computeBody(byte[] buf,
                       int offset)
Append this element to a message buffer

Specified by:
computeBody in class OpenTracElement
Parameters:
buf - byte array to add the element to
offset - starting index to store the element
Returns:
index after the end of the stored element

length

public int length()
Return the number of bytes needed to encode this element.

Specified by:
length in class OpenTracElement
Returns:
byte count needed to hold this element

equals

public boolean equals(OpenTracElement other)
Test if this OpenTracElement has the same type and value as another OpenTracElement.

Specified by:
equals in class OpenTracElement
Parameters:
other - OpenTracElement to compare against this element
Returns:
boolean true if elements are of the same type, class, and value