com.oziexplorer
Enum TrackType

java.lang.Object
  java.lang.Enum<TrackType>
      com.oziexplorer.TrackType

All Implemented Interfaces:

Serializable, Comparable<TrackType>

public enum TrackType
extends Enum<TrackType>

Enumeration of the different track types supported by OziExplorer.

Copyright 2011 Alan Burlison, . All rights reserved. Use is subject to license terms, see LICENSE.txt.

Enum Constant Summary

ALARM_ZONE
Trck is an alarm zone.

LINE
Track is a line.

POINTS
Track is a series of points.

POLYGON
Track is a closed polygon.

Method Summary

int	getInteger() Retrieve the integer constant for this emumerated type member.
String	getString() Retrieve the name of this enumerated type member.
static TrackType	intToEnum(int value) Convert the integers used by OziAPI to identify track types to the enumeration type.
String	toString() Retrieve a string representation of this enumerated type member.
static TrackType	valueOf(String name) Returns the enum constant of this type with the specified name.
static TrackType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

LINE

public static final TrackType LINE

Track is a line.

POINTS

public static final TrackType POINTS

Track is a series of points.

POLYGON

public static final TrackType POLYGON

Track is a closed polygon.

ALARM_ZONE

public static final TrackType ALARM_ZONE

Trck is an alarm zone.

Method Detail

values

public static TrackType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (TrackType c : TrackType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static TrackType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getInteger

public int getInteger()

Retrieve the integer constant for this emumerated type member.

Returns:

the integer constant for this enumerated type member.

getString

public String getString()

Retrieve the name of this enumerated type member.

Returns:

the name of this enumerated type member.

toString

public String toString()

Retrieve a string representation of this enumerated type member.

Overrides:

toString in class Enum<TrackType>

Returns:

a string representation of this enumerated type member.

intToEnum

public static TrackType intToEnum(int value)
                           throws OziException

Convert the integers used by OziAPI to identify track types to the enumeration type.

Parameters:

value - integer representation of the track type.

Returns:

the enumeration corresponding to the value.

Throws:

OziException - if the track type is unrecognised.