prajna.data

Enum LengthUnit

java.lang.Object

java.lang.Enum<LengthUnit>

prajna.data.LengthUnit

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<LengthUnit>, Unit

public enum LengthUnit
extends java.lang.Enum<LengthUnit>
implements Unit

Implementation of a Units class for Linear measure, e.g., for length or distance. The base length unit is the Meter.

Author:

Edward Swing

Enum Constant Summary

Enum Constants

Enum Constant and Description
CENTIMETER
FOOT
KILOMETER
METER
MILE
MILLIMETER
NAUTICAL_MILE

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getAbbreviation() Get the abbreviation for the unit
double	getConvertFactor() Get the conversion factor for this unit.
static LengthUnit	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static LengthUnit[]	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

CENTIMETER

public static final LengthUnit CENTIMETER

FOOT

public static final LengthUnit FOOT

KILOMETER

public static final LengthUnit KILOMETER

MILE

public static final LengthUnit MILE

MILLIMETER

public static final LengthUnit MILLIMETER

METER

public static final LengthUnit METER

NAUTICAL_MILE

public static final LengthUnit NAUTICAL_MILE

Method Detail

values

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

Returns:

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

valueOf

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

getAbbreviation

public java.lang.String getAbbreviation()

Get the abbreviation for the unit

Specified by:

getAbbreviation in interface Unit

Returns:

the abbreviation

getConvertFactor

public double getConvertFactor()

Get the conversion factor for this unit.

Specified by:

getConvertFactor in interface Unit

Returns:

the conversion factor