Module io.jenetics.jpx

Package io.jenetics.jpx

Enum Class Length.Unit

java.lang.Object

java.lang.Enum<Length.Unit>

io.jenetics.jpx.Length.Unit

All Implemented Interfaces:

Serializable, Comparable<Length.Unit>, Constable

Enclosing class:

Length

public static enum Length.Unit
extends Enum<Length.Unit>

Represents a given length unit.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CABLE	Represents a cable: ≙ 185.3184 m.
FATHOM	Represents a fathom: ≙ 1.853184 m.
FOOT	Represents a foot: ≙ 0.3048 m.
INCH	Represents an inch: ≙ 0.0254 m.
KILOMETER	Represents a kilometer: ≙ 1,000 m.
METER	Represents a meter.
MILE	Represents a statute mile: ≙ 1,609.344 m.
NAUTICAL_MILE	Represents a nautical mile: ≙ 1,853.184 m.
YARD	Represents a yard: ≙ 0.9144 m.

Method Summary

Modifier and Type	Method	Description
double	convert(double length, Length.Unit sourceUnit)	Convert the given length value of the given sourceUnit into a length value of this length unit.
static Length.Unit	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Length.Unit[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

METER

public static final Length.Unit METER

Represents a meter.

KILOMETER

public static final Length.Unit KILOMETER

Represents a kilometer: ≙ 1,000 m.

INCH

public static final Length.Unit INCH

Represents an inch: ≙ 0.0254 m.

FOOT

public static final Length.Unit FOOT

Represents a foot: ≙ 0.3048 m.

YARD

public static final Length.Unit YARD

Represents a yard: ≙ 0.9144 m.

MILE

public static final Length.Unit MILE

Represents a statute mile: ≙ 1,609.344 m.

FATHOM

public static final Length.Unit FATHOM

Represents a fathom: ≙ 1.853184 m.

CABLE

public static final Length.Unit CABLE

Represents a cable: ≙ 185.3184 m.

NAUTICAL_MILE

public static final Length.Unit NAUTICAL_MILE

Represents a nautical mile: ≙ 1,853.184 m.

Method Details

values

public static Length.Unit[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static Length.Unit valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

convert

public double convert(double length,
 Length.Unit sourceUnit)

Convert the given length value of the given sourceUnit into a length value of this length unit. The given example converts 3 inches into yards.

final double yards = YARD.convert(3, INCH);

Parameters:

length - the length value

sourceUnit - the source length unit

Returns:

the speed value of this length unit