org.josef.science.physics

Enum MetricMass

java.lang.Object

java.lang.Enum<MetricMass>

org.josef.science.physics.MetricMass

All Implemented Interfaces:

Serializable, Comparable<MetricMass>

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

Enumeration of metric masses.

Version:

1.0 $Revision: 6488 $

Author:

Kees Schotanus

Enum Constant Summary

Enum Constants

Enum Constant and Description
GRAM Gram.
KILO_GRAM Kilo.
MILLIGRAM Milligram.
OUNCE Ounce (ons).
POUND Pound (pond).
TON Ton.

Field Summary

Fields

Modifier and Type	Field and Description
static int	GRAMS_IN_KILO Number of grams in a kilo.
static int	GRAMS_IN_OUNCE Number of grams in an ounce.
static int	OUNCES_IN_POUND Number of ounces in a pound.
static int	POUNDS_IN_KILO Number of pounds in a kilogram.

Method Summary

Modifier and Type	Method and Description
double	fromGrams(double mass) Converts the supplied mass in grams to this mass.
double	fromKilos(double mass) Converts the supplied mass in kilo's to this mass.
double	toGrams(double mass) Converts the supplied mass into grams.
double	toKilos(double mass) Converts the supplied mass into kilo's.
static MetricMass	valueOf(String name) Returns the enum constant of this type with the specified name.
static MetricMass[]	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

TON

public static final MetricMass TON

Ton.

KILO_GRAM

public static final MetricMass KILO_GRAM

Kilo.

POUND

public static final MetricMass POUND

Pound (pond).

OUNCE

public static final MetricMass OUNCE

Ounce (ons).

GRAM

public static final MetricMass GRAM

Gram.

MILLIGRAM

public static final MetricMass MILLIGRAM

Milligram.

Field Detail

GRAMS_IN_OUNCE

public static final int GRAMS_IN_OUNCE

Number of grams in an ounce.

See Also:

Constant Field Values

GRAMS_IN_KILO

public static final int GRAMS_IN_KILO

Number of grams in a kilo.

See Also:

Constant Field Values

OUNCES_IN_POUND

public static final int OUNCES_IN_POUND

Number of ounces in a pound.

See Also:

Constant Field Values

POUNDS_IN_KILO

public static final int POUNDS_IN_KILO

Number of pounds in a kilogram.

See Also:

Constant Field Values

Method Detail

values

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

Returns:

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

valueOf

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

toKilos

public double toKilos(double mass)

Converts the supplied mass into kilo's.

Parameters:

mass - The mass to convert to kilo's.

Returns:

The supplied mass converted to kilo's.

fromKilos

public double fromKilos(double mass)

Converts the supplied mass in kilo's to this mass.

Parameters:

mass - The mass in kilo's to convert to this mass.

Returns:

The supplied mass in kilo's, converted to this mass.

toGrams

public double toGrams(double mass)

Converts the supplied mass into grams.

Parameters:

mass - The mass to convert to grams.

Returns:

The supplied mass converted to grams.

fromGrams

public double fromGrams(double mass)

Converts the supplied mass in grams to this mass.

Parameters:

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

Returns:

The supplied mass in grams, converted to this mass.