Enum Class Hemisphere

java.lang.Object

java.lang.Enum<Hemisphere>

org.deltava.beans.navdata.Hemisphere

All Implemented Interfaces:

Serializable, Comparable<Hemisphere>, Constable

public enum Hemisphere
extends Enum<Hemisphere>

An enumeration to store lat/long conversion factors for Hemispheres on the Earth.

Since:

2.6

Version:

11.2

Author:

Luke

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
E
N
S
W

Method Summary

Modifier and Type	Method	Description
int	getLatitudeFactor()	Returns the latitude conversion factor.
int	getLongitudeFactor()	Returns the longitude conversion factror.
static boolean	isDirection(char c)	Returns whether a character is a valid direction.
static Hemisphere	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Hemisphere[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

N

public static final Hemisphere N

E

public static final Hemisphere E

W

public static final Hemisphere W

S

public static final Hemisphere S

Method Details

values

public static Hemisphere[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static Hemisphere valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

getLatitudeFactor

public int getLatitudeFactor()

Returns the latitude conversion factor.

Returns:

the conversion factor

getLongitudeFactor

public int getLongitudeFactor()

Returns the longitude conversion factror.

Returns:

the conversion factor

isDirection

public static boolean isDirection(char c)

Returns whether a character is a valid direction.

Parameters:

c - a char

Returns:

TRUE if a valid direction, otherwise FALSE