net.sf.marineapi.nmea.util
Enum Direction

java.lang.Object
  java.lang.Enum<Direction>
      net.sf.marineapi.nmea.util.Direction

All Implemented Interfaces:

Serializable, Comparable<Direction>

public enum Direction
extends Enum<Direction>

Defines the relative directions, e.g. "left" and "right".

Version:

$Revision: 35 $

Author:

Kimmo Tuukkanen

Enum Constant Summary

LEFT
Left

RIGHT
Right

Method Summary

char	toChar() Returns the corresponding char constant.
static Direction	valueOf(char c) Get the enum corresponding to specified char.
static Direction	valueOf(String name) Returns the enum constant of this type with the specified name.
static Direction[]	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

LEFT

public static final Direction LEFT

Left

RIGHT

public static final Direction RIGHT

Right

Method Detail

values

public static final Direction[] 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(Direction c : Direction.values())
        System.out.println(c);

Returns:

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

valueOf

public static Direction 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()

Returns the corresponding char constant.

Returns:

Char indicator for Direction

valueOf

public static Direction valueOf(char c)

Get the enum corresponding to specified char.

Parameters:

c - Char indicator for Direction

Returns:

Direction