net.maritimecloud.util.units

Enum SpeedUnit

java.lang.Object

java.lang.Enum<SpeedUnit>

net.maritimecloud.util.units.SpeedUnit

All Implemented Interfaces:

Serializable, Comparable<SpeedUnit>

public enum SpeedUnit
extends Enum<SpeedUnit>

A unit of speed.

Author:

Kasper Nielsen

Enum Constant Summary

Enum Constants

Enum Constant and Description
KILOMETERS_PER_HOUR Kilometers per hour.
KNOTS Knots.
METERS_PER_SECOND Meters Per Second.
MILES_PER_HOUR Miles Per Hour.

Method Summary

Modifier and Type	Method and Description
abstract double	toKilometersPerHour(double speed) Converts the specified speed from this speed unit to kilometers per hour.
abstract double	toKnots(double speed) Converts the specified speed from this speed unit to knots.
abstract double	toMetersPerSecond(double speed) Converts the specified speed from this speed unit to miles per hour.
abstract double	toMilesPerHour(double speed) Converts the specified speed from this speed unit to miles per hour.
static SpeedUnit	valueOf(String name) Returns the enum constant of this type with the specified name.
static SpeedUnit[]	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

KILOMETERS_PER_HOUR

public static final SpeedUnit KILOMETERS_PER_HOUR

Kilometers per hour.

KNOTS

public static final SpeedUnit KNOTS

Knots.

METERS_PER_SECOND

public static final SpeedUnit METERS_PER_SECOND

Meters Per Second.

MILES_PER_HOUR

public static final SpeedUnit MILES_PER_HOUR

Miles Per Hour.

Method Detail

values

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

Returns:

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

valueOf

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

toKilometersPerHour

public abstract double toKilometersPerHour(double speed)

Converts the specified speed from this speed unit to kilometers per hour. For example, to convert 100 meters per second to kilometers per hour: SpeedUnit.METERS_PER_SECOND.toKilometersPerHour(100).

Parameters:

speed - the speed to convert

Returns:

the converted speed

toKnots

public abstract double toKnots(double speed)

Converts the specified speed from this speed unit to knots. For example, to convert 100 meters per second to knots: SpeedUnit.METERS_PER_SECOND.toKnots(100).

Parameters:

speed - the speed to convert

Returns:

the converted speed

toMetersPerSecond

public abstract double toMetersPerSecond(double speed)

Converts the specified speed from this speed unit to miles per hour. For example, to convert 100 knots to meters per second: SpeedUnit.KNOTS.toMetersPerSecond(100).

Parameters:

speed - the speed to convert

Returns:

the converted speed

toMilesPerHour

public abstract double toMilesPerHour(double speed)

Converts the specified speed from this speed unit to miles per hour. For example, to convert 100 meters per second to miles per hour: SpeedUnit.METERS_PER_SECOND.toMilesPerHour(100).

Parameters:

speed - the speed to convert

Returns:

the converted speed