Module org.tquadrat.foundation.value

Package org.tquadrat.foundation.value

Enum Class Volume

java.lang.Object

java.lang.Enum<Volume>

org.tquadrat.foundation.value.Volume

All Implemented Interfaces:

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

@ClassVersion(sourceVersion="$Id: Volume.java 1073 2023-10-01 11:08:51Z tquadrat $")
@API(status=STABLE,
     since="0.1.0")
public enum Volume
extends Enum<Volume>
implements DimensionWithLinearConversion

The various instances of volume …

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

$Id: Volume.java 1073 2023-10-01 11:08:51Z tquadrat $

Since:

0.1.0

UML Diagram

⁠

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

⁠

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
BARREL_OIL	A barrel as used for mineral oil.
BUCKET	A bucket ("Eimer" in German).
CENTI_LITER	A centiliter.
CUBIC_CENTIMETER	A cubic centimeter.
CUBIC_DECIMETER	A cubic decimeter.
CUBIC_FOOT	A cubic foot.
CUBIC_INCH	A cubic inch.
CUBIC_KILO_METER	A cubic kilometer.
CUBIC_METER	A cubic meter.
CUBIC_MILE	A cubic mile.
CUBIC_MILLIMETER	A cubic millimeter.
CUBIC_YARD	A cubic yard.
DECI_LITER	A deciliter.
FESTMETER	A "Festmeter"; this is used (in Germany) to specify an amount of wood.
FLUID_OUNCE_IMPERIAL	An imperial fluid ounce.
GALLON	An imperial gallon.
HEKTO_LITER	A hekto liter.
IMPERIAL_BARREL	An imperial barrel.
LITER	A liter.
MICRO_LITER	A micro liter.
MILLI_LITER	A milliliter.
PINT_LIQUID_IMPERIAL	A pint liquid imperial.
TON	A ton as used by Traveller® to specify the volume of a starship or other space going vessels or orbital installations.
US_GALLON	A US (liquid) gallon.

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	Volume(BigDecimal factor, String unitSymbol)	Creates a new Volume instance, with a default precision of zero mantissa digits.
private	Volume(BigDecimal factor, String unitSymbol, int precision)	Creates a new Volume instance.

Method Summary

Modifier and Type	Method	Description
final Volume	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 Volume	forUnit(String unitSymbol)	Returns the Volume instance for the given unit symbol.
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 Volume	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Volume[]	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

CUBIC_MILLIMETER

public static final Volume CUBIC_MILLIMETER

A cubic millimeter.

MICRO_LITER

public static final Volume MICRO_LITER

A micro liter.

CUBIC_CENTIMETER

public static final Volume CUBIC_CENTIMETER

A cubic centimeter.

MILLI_LITER

public static final Volume MILLI_LITER

A milliliter.

CENTI_LITER

public static final Volume CENTI_LITER

A centiliter.

CUBIC_INCH

public static final Volume CUBIC_INCH

A cubic inch.

FLUID_OUNCE_IMPERIAL

public static final Volume FLUID_OUNCE_IMPERIAL

An imperial fluid ounce.

DECI_LITER

public static final Volume DECI_LITER

A deciliter.

PINT_LIQUID_IMPERIAL

public static final Volume PINT_LIQUID_IMPERIAL

A pint liquid imperial.

CUBIC_DECIMETER

public static final Volume CUBIC_DECIMETER

A cubic decimeter.

LITER

public static final Volume LITER

A liter.

BUCKET

public static final Volume BUCKET

A bucket ("Eimer" in German). Obviously, this is not an official unit for a volume, but it is used quit often on a colloquial basis in Germany and other German-speaking countries to describe the amount of 10 liters.

US_GALLON

public static final Volume US_GALLON

A US (liquid) gallon.

GALLON

public static final Volume GALLON

An imperial gallon.

CUBIC_FOOT

public static final Volume CUBIC_FOOT

A cubic foot.

HEKTO_LITER

public static final Volume HEKTO_LITER

A hekto liter.

BARREL_OIL

public static final Volume BARREL_OIL

A barrel as used for mineral oil.

IMPERIAL_BARREL

public static final Volume IMPERIAL_BARREL

An imperial barrel.

CUBIC_YARD

public static final Volume CUBIC_YARD

A cubic yard.

CUBIC_METER

public static final Volume CUBIC_METER

A cubic meter.

FESTMETER

public static final Volume FESTMETER

A "Festmeter"; this is used (in Germany) to specify an amount of wood.

TON

public static final Volume TON

A ton as used by Traveller® to specify the volume of a starship or other space going vessels or orbital installations. It is defined as the volume of one metric ton or 1000 kg of liquid hydrogen (H₂) with a specific density of 71 kg/m³.

The Traveller® literature also uses a value of 13.5 m³, based on the dimensions used with ship floor plans: a square on such a plan has a side length of 1.5 m and the room height is taken as 3 m, with each square is the equivalent of half a ton (or 6.75 m³). For mapping purposes this is a valid approximation.

CUBIC_KILO_METER

public static final Volume CUBIC_KILO_METER

A cubic kilometer.

CUBIC_MILE

public static final Volume CUBIC_MILE

A cubic mile.

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

Volume

private Volume(BigDecimal factor,
 String unitSymbol)

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

Parameters:

factor - The factor.

unitSymbol - The unit symbol String.

Volume

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

Creates a new Volume instance.

Parameters:

factor - The factor.

unitSymbol - The unit symbol String.

precision - The default precision.

Method Details

values

public static Volume[] 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 Volume 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 Volume 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 Volume forUnit(String unitSymbol)
                            throws IllegalArgumentException

Returns the Volume instance for the given unit symbol.

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.