org.josef.science.physics

Enum BritishImperialMass

java.lang.Object

java.lang.Enum<BritishImperialMass>

org.josef.science.physics.BritishImperialMass

All Implemented Interfaces:

Serializable, Comparable<BritishImperialMass>

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

Enumeration of British Imperial masses.

Version:

1.0 $Revision: 5877 $

Author:

Kees Schotanus

Enum Constant Summary

Enum Constants

Enum Constant and Description
OUNCE Ounce.
POUND Pound.
STONE Stone.

Field Summary

Fields

Modifier and Type	Field and Description
static int	OUNCES_IN_POUND Number of ounces in a pound.
static int	POUNDS_IN_STONE Number of pounds in a stone.

Method Summary

Modifier and Type	Method and Description
double	fromOunces(double mass) Converts the supplied mass in ounces to this mass.
double	fromPounds(double mass) Converts the supplied mass in pounds to this mass.
double	toOunces(double mass) Converts the supplied mass into ounces.
double	toPounds(double mass) Converts the supplied mass into pounds.
static BritishImperialMass	valueOf(String name) Returns the enum constant of this type with the specified name.
static BritishImperialMass[]	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

POUND

public static final BritishImperialMass POUND

Pound.

OUNCE

public static final BritishImperialMass OUNCE

Ounce.

STONE

public static final BritishImperialMass STONE

Stone.

Field Detail

OUNCES_IN_POUND

public static final int OUNCES_IN_POUND

Number of ounces in a pound.

See Also:

Constant Field Values

POUNDS_IN_STONE

public static final int POUNDS_IN_STONE

Number of pounds in a stone.

See Also:

Constant Field Values

Method Detail

values

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

Returns:

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

valueOf

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

toPounds

public double toPounds(double mass)

Converts the supplied mass into pounds.

Parameters:

mass - The mass to convert to pounds.

Returns:

The supplied mass converted to pounds.

fromPounds

public double fromPounds(double mass)

Converts the supplied mass in pounds to this mass.

Parameters:

mass - The mass in pounds to convert to this mass.

Returns:

The supplied mass in pounds, converted to this mass.

toOunces

public double toOunces(double mass)

Converts the supplied mass into ounces.

Parameters:

mass - The mass to convert to ounces.

Returns:

The supplied mass converted to ounces.

fromOunces

public double fromOunces(double mass)

Converts the supplied mass in ounces to this mass.

Parameters:

mass - The mass in ounces to convert to this mass.

Returns:

The supplied mass in ounces, converted to this mass.