org.josef.science.physics

Enum MetricLength

java.lang.Object

java.lang.Enum<MetricLength>

org.josef.science.physics.MetricLength

All Implemented Interfaces:

Serializable, Comparable<MetricLength>

@Status(stage=TEST,
        unitTests=ABSENT)
public enum MetricLength
extends Enum<MetricLength>

Enumeration of metric lengths.

Version:

1.0 $Revision: 6488 $

Author:

Kees Schotanus

Enum Constant Summary

Enum Constants

Enum Constant and Description
CENTIMETER Centimeter.
DECAMETER Decameter.
DECIMETER Decimeter.
HECTOMETER Hectometer.
KILOMETER Kilometer.
METER Meter.
MILLIMETER Millimeter.

Method Summary

Modifier and Type	Method and Description
double	fromKilometers(double length) Converts the supplied length in kilometers to this length.
double	fromMeters(double length) Converts the supplied length in meters to this length.
double	toKilometers(double length) Converts the supplied length into kilometers.
double	toMeters(double length) Converts the supplied length into meters.
static MetricLength	valueOf(String name) Returns the enum constant of this type with the specified name.
static MetricLength[]	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

KILOMETER

public static final MetricLength KILOMETER

Kilometer.

HECTOMETER

public static final MetricLength HECTOMETER

Hectometer.

DECAMETER

public static final MetricLength DECAMETER

Decameter.

METER

public static final MetricLength METER

Meter.

DECIMETER

public static final MetricLength DECIMETER

Decimeter.

CENTIMETER

public static final MetricLength CENTIMETER

Centimeter.

MILLIMETER

public static final MetricLength MILLIMETER

Millimeter.

Method Detail

values

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

Returns:

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

valueOf

public static MetricLength 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 length)

Converts the supplied length into kilometers.

Parameters:

length - The length to convert to kilometers.

Returns:

The supplied length converted to kilometers.

fromKilometers

public double fromKilometers(double length)

Converts the supplied length in kilometers to this length.

Parameters:

length - The length in kilometers to convert to this length.

Returns:

The supplied length in kilometers, converted to this length.

toMeters

public double toMeters(double length)

Converts the supplied length into meters.

Parameters:

length - The length to convert to meters.

Returns:

The supplied length converted to meters.

fromMeters

public double fromMeters(double length)

Converts the supplied length in meters to this length.

Parameters:

length - The length in meters to convert to this length.

Returns:

The supplied length in meters, converted to this length.