net.maritimecloud.util.units

Enum DistanceUnit

java.lang.Object

java.lang.Enum<DistanceUnit>

net.maritimecloud.util.units.DistanceUnit

All Implemented Interfaces:

Serializable, Comparable<DistanceUnit>

public enum DistanceUnit
extends Enum<DistanceUnit>

A distance of unit.

Author:

Kasper Nielsen

Enum Constant Summary

Enum Constants

Enum Constant and Description
KILOMETERS Kilometers as defined by the International Bureau of Weights and Measures.
METERS Meters as defined by the International Bureau of Weights and Measures.
MILES A mile defined as 1609.344 meters.
NAUTICAL_MILES A nautical mile defined as 1852 meters.

Field Summary

Fields

Modifier and Type	Field and Description
static double	METERS_TO_MILES
static double	METERS_TO_NAUTICAL_MILES

Method Summary

Modifier and Type	Method and Description
double	toKilometers(double distance) Converts the specified distance from this distance unit to kilometers.
abstract double	toMeters(double distance) Converts the specified distance from this distance unit to miles.
double	toMiles(double distance) Converts the specified distance from this distance unit to miles.
double	toNauticalMiles(double distance) Converts the specified distance from this distance unit to nautical miles.
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

KILOMETERS

public static final DistanceUnit KILOMETERS

Kilometers as defined by the International Bureau of Weights and Measures.

METERS

public static final DistanceUnit METERS

Meters as defined by the International Bureau of Weights and Measures.

MILES

public static final DistanceUnit MILES

A mile defined as 1609.344 meters.

NAUTICAL_MILES

public static final DistanceUnit NAUTICAL_MILES

A nautical mile defined as 1852 meters.

Field Detail

METERS_TO_MILES

public static final double METERS_TO_MILES

See Also:

Constant Field Values

METERS_TO_NAUTICAL_MILES

public static final double METERS_TO_NAUTICAL_MILES

See Also:

Constant Field Values

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

toKilometers

public double toKilometers(double distance)

Converts the specified distance from this distance unit to kilometers. For example, to convert 100 meters to kilometers: DistanceUnit.METERS.toKilometers(100).

Parameters:

distance - the distance to convert

Returns:

the converted distance

toMeters

public abstract double toMeters(double distance)

Converts the specified distance from this distance unit to miles. For example, to convert 100 miles to meters: DistanceUnit.MILES.toMeters(100).

Parameters:

distance - the distance to convert

Returns:

the converted distance

toMiles

public double toMiles(double distance)

Converts the specified distance from this distance unit to miles. For example, to convert 100 meters to miles: DistanceUnit.METERS.toMiles(100).

Parameters:

distance - the distance to convert

Returns:

the converted distance

toNauticalMiles

public double toNauticalMiles(double distance)

Converts the specified distance from this distance unit to nautical miles. For example, to convert 100 meters to nautical miles: DistanceUnit.METERS.toNauticalMiles(100).

Parameters:

distance - the distance to convert

Returns:

the converted distance