org.josef.science.physics

Enum BritishImperialLength

java.lang.Object

java.lang.Enum<BritishImperialLength>

org.josef.science.physics.BritishImperialLength

All Implemented Interfaces:

Serializable, Comparable<BritishImperialLength>

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

Enumeration of British Imperial lengths.

Version:

1.0 $Revision: 6488 $

Author:

Kees Schotanus

Enum Constant Summary

Enum Constants

Enum Constant and Description
FOOT Foot.
INCH Inch.
MILE Mile.
YARD Yard.

Field Summary

Fields

Modifier and Type	Field and Description
static int	FEET_IN_YARD Number of feet in a yard.
static int	INCHES_IN_FOOT Number of inches in a foot.
static int	YARDS_IN_MILE Number of yard in a mile.

Method Summary

Modifier and Type	Method and Description
double	fromMiles(double length) Converts the supplied length in miles to this length.
double	fromYards(double length) Converts the supplied length in yards to this length.
double	toMiles(double length) Converts the supplied length into miles.
double	toYards(double length) Converts the supplied length into yards.
static BritishImperialLength	valueOf(String name) Returns the enum constant of this type with the specified name.
static BritishImperialLength[]	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

MILE

public static final BritishImperialLength MILE

Mile.

YARD

public static final BritishImperialLength YARD

Yard.

FOOT

public static final BritishImperialLength FOOT

Foot.

INCH

public static final BritishImperialLength INCH

Inch.

Field Detail

INCHES_IN_FOOT

public static final int INCHES_IN_FOOT

Number of inches in a foot.

See Also:

Constant Field Values

FEET_IN_YARD

public static final int FEET_IN_YARD

Number of feet in a yard.

See Also:

Constant Field Values

YARDS_IN_MILE

public static final int YARDS_IN_MILE

Number of yard in a mile.

See Also:

Constant Field Values

Method Detail

values

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

Returns:

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

valueOf

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

toMiles

public double toMiles(double length)

Converts the supplied length into miles.

Parameters:

length - The length to convert to miles.

Returns:

The supplied length converted to miles.

fromMiles

public double fromMiles(double length)

Converts the supplied length in miles to this length.

Parameters:

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

Returns:

The supplied length in miles, converted to this length.

toYards

public double toYards(double length)

Converts the supplied length into yards.

Parameters:

length - The length to convert to yards.

Returns:

The supplied length converted to yards.

fromYards

public double fromYards(double length)

Converts the supplied length in yards to this length.

Parameters:

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

Returns:

The supplied length in yards, converted to this length.