net.sf.marineapi.nmea.util

Enum CompassPoint

java.lang.Object

java.lang.Enum<CompassPoint>

net.sf.marineapi.nmea.util.CompassPoint

All Implemented Interfaces:

Serializable, Comparable<CompassPoint>

public enum CompassPoint
extends Enum<CompassPoint>

Defines the supported compass and relative directions.

Author:

Kimmo Tuukkanen

Enum Constant Summary

Enum Constants

Enum Constant and Description
EAST East
NORTH North
SOUTH South
WEST West

Method Summary

Modifier and Type	Method and Description
char	toChar() Returns the corresponding char constant.
static CompassPoint	valueOf(char c) Get the enum corresponding to specified char.
static CompassPoint	valueOf(String name) Returns the enum constant of this type with the specified name.
static CompassPoint[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NORTH

public static final CompassPoint NORTH

North

EAST

public static final CompassPoint EAST

East

SOUTH

public static final CompassPoint SOUTH

South

WEST

public static final CompassPoint WEST

West

Method Detail

values

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

Returns:

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

valueOf

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

toChar

public char toChar()

Returns the corresponding char constant.

Returns:

Char indicator for Direction

valueOf

public static CompassPoint valueOf(char c)

Get the enum corresponding to specified char.

Parameters:

c - Char indicator for Direction

Returns:

Direction