Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.ka2ddo.opentrac
Class OpenTracCountryCode

    java.lang.Object
      org.ka2ddo.opentrac.OpenTracElement
          org.ka2ddo.opentrac.OpenTracCountryCode

All Implemented Interfaces:
  java.io.Serializable

    public class OpenTracCountryCode

extends OpenTracElement

This class represents an OpenTRAC element containing the ISO 3166-1 country code (two characters), and an optional ISO 3166-2 country subdivision code.

See Also:
  Serialized Form

Field Summary

Fields inherited from class org.ka2ddo.opentrac.OpenTracElement
`id`

Constructor Summary
`OpenTracCountryCode()` Create an uninitialized OpenTRAC COUNTRYCODE element.
`OpenTracCountryCode(int type, byte[] body, int offset, int length)` Create an OpenTRAC COUNTRYCODE element from the next series of bytes in an encoded OpenTRAC message.
`OpenTracCountryCode(java.lang.String country)` Create an OpenTRAC COUNTRYCODE element with the specified country code.

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

### OpenTracCountryCode

    public OpenTracCountryCode()

  Create an uninitialized OpenTRAC COUNTRYCODE element.

### OpenTracCountryCode

    public OpenTracCountryCode(int type,
                               byte[] body,
                               int offset,
                               int length)

  Create an OpenTRAC COUNTRYCODE element from the next series of bytes in an encoded OpenTRAC message.

  Parameters:
    `type` - OpenTRAC element type code
    `body` - byte array containing the encoded OpenTRAC elements
    `offset` - starting index in the array where this element begins
    `length` - remaining number of bytes in the OpenTRAC encoded message

### OpenTracCountryCode

    public OpenTracCountryCode(java.lang.String country)

  Create an OpenTRAC COUNTRYCODE element with the specified country code.

  Parameters:
    `country` - ISO 3166-1 country code 2-character string

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

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD