Module org.tquadrat.foundation.value

Package org.tquadrat.foundation.value

Enum Class Mass

java.lang.Object

java.lang.Enum<Mass>

org.tquadrat.foundation.value.Mass

All Implemented Interfaces:

Serializable, Comparable<Mass>, Constable, Dimension, DimensionWithLinearConversion

@ClassVersion(sourceVersion="$Id: Mass.java 1077 2023-10-14 23:00:23Z tquadrat $")
@API(status=STABLE,
     since="0.1.0")
public enum Mass
extends Enum<Mass>
implements DimensionWithLinearConversion

The various instances of masses and weights (although this is not really the same, from a physical or scientific point of view ...).

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

$Id: Mass.java 1077 2023-10-14 23:00:23Z tquadrat $

Since:

0.1.0

UML Diagram

⁠

UML Diagram for "org.tquadrat.foundation.value.Mass"

⁠

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
CARAT	A metric carat; this is defined as 0.2 g; although no unit sign is officially defined, the use of "ct" is widely accepted.
DRAM	A dram (Avoirdupois), a 1/16 of an ounce.
EARTH_MASS	The mass of our planet Earth.
GRAIN	An English grain.
GRAM	A gram.
KILOGRAM	A kilogram.
MILLIGRAM	A milligram.
OUNCE	An ounce (Avoirdupois), a 1/16 of a pound.
POUND	An imperial pound (Avoirdupois), 7000 grain.
SHORT_TON	A short ton (2000 pound avoirdupois).
SOLAR_MASS	The (estimated) mass of our sun.
STONE	A stone; although abandoned since 1985, it will still be used in some Commonwealth countries to determine the body weight.
TON	A metric ton.
TROY_OUNCE	A troy ounce (same as Apothecaries Ounce, as used for precious metal.

Field Summary

Fields

Modifier and Type	Field	Description
private final BigDecimal	m_Factor	The factor.
private final int	m_Precision	The default precision.
private final String	m_UnitSymbol	The unit string.

Fields inherited from interface org.tquadrat.foundation.value.api.DimensionWithLinearConversion

MSG_UnknownUnit

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Mass(BigDecimal factor, String unitSymbol)	Creates a new Mass instance with a default precision of zero mantissa digits.
private	Mass(BigDecimal factor, String unitSymbol, int precision)	Creates a new Mass instance.

Method Summary

Modifier and Type	Method	Description
final Mass	baseUnit()	Returns the base unit.
final BigDecimal	factor()	Returns the factor that is used to convert a value from this unit to the base unit.
static final Mass	forUnit(String unitSymbol)	Returns the Weight instance for the given unit.
final int	getPrecision()	Returns the default precision for this unit that is used when the respective value is converted to a String.
final String	unitSymbol()	Returns the unit symbol for the dimension as a single line string.
static Mass	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Mass[]	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

Methods inherited from interface org.tquadrat.foundation.value.api.Dimension

equals, name, toString, unitSymbolForPrinting

Methods inherited from interface org.tquadrat.foundation.value.api.DimensionWithLinearConversion

fromBase, toBase

Enum Constant Details

MILLIGRAM

public static final Mass MILLIGRAM

A milligram.

GRAIN

public static final Mass GRAIN

An English grain. This unit is still in use to define the mass of firearm bullets, arrow heads, or the explosives load for firearm cartridges.

CARAT

public static final Mass CARAT

A metric carat; this is defined as 0.2 g; although no unit sign is officially defined, the use of "ct" is widely accepted. That is why we use it here as well.

GRAM

public static final Mass GRAM

A gram.

DRAM

public static final Mass DRAM

A dram (Avoirdupois), a 1/16 of an ounce.

OUNCE

public static final Mass OUNCE

An ounce (Avoirdupois), a 1/16 of a pound.

TROY_OUNCE

public static final Mass TROY_OUNCE

A troy ounce (same as Apothecaries Ounce, as used for precious metal.

POUND

public static final Mass POUND

An imperial pound (Avoirdupois), 7000 grain.

KILOGRAM

public static final Mass KILOGRAM

A kilogram.

STONE

public static final Mass STONE

A stone; although abandoned since 1985, it will still be used in some Commonwealth countries to determine the body weight.

1 st = 14 lb. = 224 oz. = 3584 dr.

SHORT_TON

public static final Mass SHORT_TON

A short ton (2000 pound avoirdupois).

TON

public static final Mass TON

A metric ton.

SOLAR_MASS

@API(status=STABLE,
     since="0.3.0")
public static final Mass SOLAR_MASS

The (estimated) mass of our sun. This is often used when comparing stars.

EARTH_MASS

@API(status=STABLE,
     since="0.3.0")
public static final Mass EARTH_MASS

The mass of our planet Earth. This is often used when comparing masses of astronomical objects.

Field Details

m_Factor

private final BigDecimal m_Factor

The factor.

m_Precision

private final int m_Precision

The default precision.

m_UnitSymbol

private final String m_UnitSymbol

The unit string.

Constructor Details

Mass

private Mass(BigDecimal factor,
 String unitSymbol)

Creates a new Mass instance with a default precision of zero mantissa digits.

Parameters:

factor - The factor.

unitSymbol - The unit string.

Mass

private Mass(BigDecimal factor,
 String unitSymbol,
 int precision)

Creates a new Mass instance.

Parameters:

factor - The factor.

unitSymbol - The unit string.

precision - The default precision.

Method Details

values

public static Mass[] 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 Mass 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

baseUnit

public final Mass baseUnit()

Returns the base unit.

E.g. for length, the base unit would be Meter (m), for mass, it is Kilogram (kg), and so on.

Specified by:

baseUnit in interface Dimension

Returns:

The base unit.

factor

public final BigDecimal factor()

Returns the factor that is used to convert a value from this unit to the base unit.

For length, if you have to convert a Centimeter value to Meter, you will divide that by 100 or multiply it with a factor of 0.01.

For the base unit, the factor is 1.0.

Specified by:

factor in interface DimensionWithLinearConversion

Returns:

The factor.

See Also:

• Dimension.baseUnit()

forUnit

public static final Mass forUnit(String unitSymbol)
                          throws IllegalArgumentException

Returns the Weight instance for the given unit.

Parameters:

unitSymbol - The unit symbol.

Returns:

The respective instance.

Throws:

IllegalArgumentException - The given unit is unknown.

getPrecision

public final int getPrecision()

Returns the default precision for this unit that is used when the respective value is converted to a String.

Specified by:

getPrecision in interface Dimension

Returns:

The mantissa length for a value with this unit.

unitSymbol

public final String unitSymbol()

Returns the unit symbol for the dimension as a single line string.

For a length, this would be "m", for a speed "km/h", and for an acceleration, it could be "m/(s^2)".

Specified by:

unitSymbol in interface Dimension

Returns:

The unit.