Package org.ka2ddo.opentrac
Class OpenTracByteArray
java.lang.Object
org.ka2ddo.opentrac.OpenTracElement
org.ka2ddo.opentrac.OpenTracByteArray
- All Implemented Interfaces:
Serializable
- Direct Known Subclasses:
OpenTracMapSymbol
This class represents any type of OpenTRAC data element that has an array of bytes
as its value. It can also be used as a hashmap key.
- Author:
- Andrew Pavlin, KA2DDO
- See Also:
-
Field Summary
Fields inherited from class org.ka2ddo.opentrac.OpenTracElement
id
-
Constructor Summary
ConstructorDescriptionCreate an untyped empty OpenTracByteArray element.OpenTracByteArray
(int type, byte[] body, int offset, int length) Create an OpenTRAC element with an arbitrary-length byte array value from the next series of bytes in an encoded OpenTRAC message. -
Method Summary
Modifier and TypeMethodDescriptionint
computeBody
(byte[] buf, int offset) Append this element to a message bufferboolean
Indicates whether some other object is "equal to" this one.boolean
equalsElement
(OpenTracElement other) Test if this OpenTracElement has the same type and value as another OpenTracElement.byte[]
Get the value of this OpenTracByteArray.int
hashCode()
Returns a hash code value for the object.int
length()
Return the number of bytes needed to encode this element.toString()
Returns a string representation of the object.Get the string representation of the value of this element.Methods inherited from class org.ka2ddo.opentrac.OpenTracElement
getId
-
Constructor Details
-
OpenTracByteArray
public OpenTracByteArray()Create an untyped empty OpenTracByteArray element. -
OpenTracByteArray
public OpenTracByteArray(int type, byte[] body, int offset, int length) Create an OpenTRAC element with an arbitrary-length byte array value from the next series of bytes in an encoded OpenTRAC message.- Parameters:
type
- OpenTRAC element type codebody
- byte array containing the encoded OpenTRAC elementsoffset
- starting index in the array where this element beginslength
- remaining number of bytes in the OpenTRAC encoded message
-
-
Method Details
-
valueString
Get the string representation of the value of this element.- Specified by:
valueString
in classOpenTracElement
- Returns:
- value string
-
computeBody
public int computeBody(byte[] buf, int offset) Append this element to a message buffer- Specified by:
computeBody
in classOpenTracElement
- Parameters:
buf
- byte array to add the element tooffset
- starting index to store the element- Returns:
- index after the end of the stored element
-
getByteArray
public byte[] getByteArray()Get the value of this OpenTracByteArray.- Returns:
- the encapsulated array of arbitrary bytes
-
length
public int length()Return the number of bytes needed to encode this element.- Specified by:
length
in classOpenTracElement
- Returns:
- byte count needed to hold this element
-
equals
Indicates whether some other object is "equal to" this one. -
hashCode
public int hashCode()Returns a hash code value for the object. This method is supported for the benefit of hashtables such as those provided byjava.util.Hashtable
. -
toString
Returns a string representation of the object.- Overrides:
toString
in classOpenTracElement
- Returns:
- a string representation of the object.
-
equalsElement
Test if this OpenTracElement has the same type and value as another OpenTracElement.- Specified by:
equalsElement
in classOpenTracElement
- Parameters:
other
- OpenTracElement to compare against this element- Returns:
- boolean true if elements are of the same type, class, and value
-