net.sf.marineapi.nmea.util
Enum RouteType

java.lang.Object
  extended by java.lang.Enum<RouteType>
      extended by net.sf.marineapi.nmea.util.RouteType
All Implemented Interfaces:
Serializable, Comparable<RouteType>

public enum RouteType
extends Enum<RouteType>

Defines the supported route types.

Version:
$Revision: 18 $
Author:
Kimmo Tuukkanen
See Also:
RTESentence

Enum Constant Summary
ACTIVE
          Active route: complete, all waypoints in route order.
WORKING
          Working route: the waypoint you just left, the waypoint you're heading to and then all the rest.
 
Method Summary
 char toChar()
          Get the corresponding char indicator of enum.
 RouteType valueOf(char ch)
          Get the char indicator corresponding to enum.
static RouteType valueOf(String name)
          Returns the enum constant of this type with the specified name.
static RouteType[] values()
          Returns an array containing the constants of this enum type, in the order they're declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

ACTIVE

public static final RouteType ACTIVE
Active route: complete, all waypoints in route order.


WORKING

public static final RouteType WORKING
Working route: the waypoint you just left, the waypoint you're heading to and then all the rest.

Method Detail

values

public static final RouteType[] values()
Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:
for(RouteType c : RouteType.values())
        System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they're declared

valueOf

public static RouteType 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

toChar

public char toChar()
Get the corresponding char indicator of enum.

Returns:
Char

valueOf

public RouteType valueOf(char ch)
Get the char indicator corresponding to enum.

Parameters:
ch - Char
Returns:
ReturnType corresponding to specified char.


Copyright (C) 2010-2011 Java Marine API author(s). All Rights Reserved.