Module io.jenetics.jpx

Package io.jenetics.jpx

Enum Class Speed.Unit

java.lang.Object

java.lang.Enum<Speed.Unit>

io.jenetics.jpx.Speed.Unit

All Implemented Interfaces:

Serializable, Comparable<Speed.Unit>, Constable

Enclosing class:

Speed

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

Represents a given speed 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
KILOMETERS_PER_HOUR	Represents the speed unit kilometers per hour: km/h.
KNOTS	Represents the speed unit knots: kt.
MACH	Represents the speed unit mach: Ma.
METERS_PER_SECOND	Represents the speed unit meters per second: m/s.
MILES_PER_HOUR	Represents the speed unit miles per hour: mi/h.

Method Summary

Modifier and Type	Method	Description
double	convert(double speed, Speed.Unit sourceUnit)	Convert the given speed value of the given sourceUnit into a speed value of this speed unit.
static Speed.Unit	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Speed.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

METERS_PER_SECOND

public static final Speed.Unit METERS_PER_SECOND

Represents the speed unit meters per second: m/s.

KILOMETERS_PER_HOUR

public static final Speed.Unit KILOMETERS_PER_HOUR

Represents the speed unit kilometers per hour: km/h.

MILES_PER_HOUR

public static final Speed.Unit MILES_PER_HOUR

Represents the speed unit miles per hour: mi/h.

KNOTS

public static final Speed.Unit KNOTS

Represents the speed unit knots: kt.

MACH

public static final Speed.Unit MACH

Represents the speed unit mach: Ma.

Method Details

values

public static Speed.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 Speed.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 speed,
 Speed.Unit sourceUnit)

Convert the given speed value of the given sourceUnit into a speed value of this speed unit. The given example converts 3 knots into kilometers per hour.

final double kilometersPerHour = KILOMETERS_PER_HOUR.convert(3, KNOTS);

Parameters:

speed - the speed value

sourceUnit - the source speed unit

Returns:

the speed value of this speed unit