net.degreedays.geo

Enum DistanceUnit

java.lang.Object

java.lang.Enum<DistanceUnit>

net.degreedays.geo.DistanceUnit

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<DistanceUnit>

public enum DistanceUnit
extends java.lang.Enum<DistanceUnit>

Defines the units of distance measurement with enum constants to represent metres, kilometres, feet, and miles.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FEET For the imperial unit the foot (ft).
KILOMETRES For the metric unit the kilometre (km); 1 kilometre = 1000 metres.
METRES For the SI base unit of length, the metre (m).
MILES For the imperial unit the mile (mi); 1 mile = 5280 feet.

Method Summary

Modifier and Type	Method and Description
java.lang.String	toString() Returns a non-null, non-empty string representation of this object for logging and debugging purposes.
static DistanceUnit	valueOf(java.lang.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

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

METRES

public static final DistanceUnit METRES

For the SI base unit of length, the metre (m).

KILOMETRES

public static final DistanceUnit KILOMETRES

For the metric unit the kilometre (km); 1 kilometre = 1000 metres.

FEET

public static final DistanceUnit FEET

For the imperial unit the foot (ft).

MILES

public static final DistanceUnit MILES

For the imperial unit the mile (mi); 1 mile = 5280 feet.

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(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

toString

public java.lang.String toString()

Returns a non-null, non-empty string representation of this object for logging and debugging purposes.

The exact details of the representation are unspecified and subject to change.

Overrides:

toString in class java.lang.Enum<DistanceUnit>