Module org.tquadrat.foundation.value

Package org.tquadrat.foundation.value

Enum Class Temperature

java.lang.Object

java.lang.Enum<Temperature>

org.tquadrat.foundation.value.Temperature

All Implemented Interfaces:

Serializable, Comparable<Temperature>, Constable, Dimension

@ClassVersion(sourceVersion="$Id: Temperature.java 1072 2023-09-30 20:44:38Z tquadrat $")
@API(status=STABLE,
     since="0.1.0")
public enum Temperature
extends Enum<Temperature>
implements Dimension

The various instances of temperature …

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

$Id: Temperature.java 1072 2023-09-30 20:44:38Z tquadrat $

Since:

0.1.0

UML Diagram

⁠

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

⁠

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
CELSIUS	Celsius.
DELISLE	Delisle.
FAHRENHEIT	Fahrenheit
KELVIN	Kelvin.
NEWTON	Newton.
RANKINE	Rankine.
REAUMUR	Réaumur.
RØMER	Rømer.

Field Summary

Fields

Modifier and Type	Field	Description
private final UnaryOperator<BigDecimal>	m_FromKelvin	The conversion for the given value from Kelvin to this unit.
private final int	m_Precision	The default precision.
private final UnaryOperator<BigDecimal>	m_ToKelvin	The conversion for the given value from this unit to Kelvin.
private final String	m_UnitSymbol	The unit string.

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

MSG_UnknownUnit

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Temperature(UnaryOperator<BigDecimal> fromKelvin, UnaryOperator<BigDecimal> toKelvin, String unitSymbol)	Creates a new Temperatur instance, with a default precision of zero mantissa digits.
private	Temperature(UnaryOperator<BigDecimal> fromKelvin, UnaryOperator<BigDecimal> toKelvin, String unitSymbol, int precision)	Creates a new Temperatur instance.

Method Summary

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

Enum Constant Details

KELVIN

public static final Temperature KELVIN

Kelvin.

CELSIUS

public static final Temperature CELSIUS

Celsius.

FAHRENHEIT

public static final Temperature FAHRENHEIT

Fahrenheit

RANKINE

public static final Temperature RANKINE

Rankine.

DELISLE

public static final Temperature DELISLE

Delisle.

REAUMUR

public static final Temperature REAUMUR

Réaumur.

NEWTON

public static final Temperature NEWTON

Newton.

Yes, there is really a unit "Newton" for temperatures! It was introduced by Isaac Newton at the beginning of the 18^th century, but was not well established.

RØMER

public static final Temperature RØMER

Rømer.

Field Details

m_FromKelvin

private final UnaryOperator<BigDecimal> m_FromKelvin

The conversion for the given value from Kelvin to this unit.

m_ToKelvin

private final UnaryOperator<BigDecimal> m_ToKelvin

The conversion for the given value from this unit to Kelvin.

m_Precision

private final int m_Precision

The default precision.

m_UnitSymbol

private final String m_UnitSymbol

The unit string.

Constructor Details

Temperature

private Temperature(UnaryOperator<BigDecimal> fromKelvin,
 UnaryOperator<BigDecimal> toKelvin,
 String unitSymbol)

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

Parameters:

fromKelvin - The conversion from Kelvin.

toKelvin - The conversion to Kelvin.

unitSymbol - The unit symbol String.

Temperature

private Temperature(UnaryOperator<BigDecimal> fromKelvin,
 UnaryOperator<BigDecimal> toKelvin,
 String unitSymbol,
 int precision)

Creates a new Temperatur instance.

Parameters:

fromKelvin - The conversion from Kelvin.

toKelvin - The conversion to Kelvin.

unitSymbol - The unit symbol String.

precision - The default precision.

Method Details

values

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

fromBase

public final UnaryOperator<BigDecimal> fromBase()

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

Specified by:

fromBase in interface Dimension

Returns:

The conversion.

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.

toBase

public final UnaryOperator<BigDecimal> toBase()

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

Specified by:

toBase in interface Dimension

Returns:

The conversion.

toString

public final String toString()

Specified by:

toString in interface Dimension

Overrides:

toString in class Enum<Temperature>

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.

forUnit

public static final Temperature forUnit(String unitSymbol)
                                 throws IllegalArgumentException

Returns the Temperature instance for the given unit symbol.

Parameters:

unitSymbol - The unit symbol.

Returns:

The respective instance.

Throws:

IllegalArgumentException - The given unit is unknown.