Module com.appslandia.common

Package com.appslandia.common.geo

Enum DistanceUnit

java.lang.Object

java.lang.Enum<DistanceUnit>

com.appslandia.common.geo.DistanceUnit

All Implemented Interfaces:

Serializable, Comparable<DistanceUnit>

public enum DistanceUnit
extends Enum<DistanceUnit>

Author:

Loc Ha

Enum Constant Summary

Enum Constants

Enum Constant	Description
KILOMETER
METER
MILE
NAUTICAL_MILE

Method Summary

Modifier and Type	Method	Description
double	convert(double distance, DistanceUnit distUnit)
String	symbol()
double	unitInMeter()
static DistanceUnit	valueOf(String name)	Returns the enum constant of this type with the specified name.
static DistanceUnit[]	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

METER

public static final DistanceUnit METER

KILOMETER

public static final DistanceUnit KILOMETER

MILE

public static final DistanceUnit MILE

NAUTICAL_MILE

public static final DistanceUnit NAUTICAL_MILE

Method Detail

values

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

Returns:

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

valueOf

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

convert

public double convert(double distance,
                      DistanceUnit distUnit)

symbol

public String symbol()

unitInMeter

public double unitInMeter()