Module org.tquadrat.foundation.value

Package org.tquadrat.foundation.value

Enum Class Energy

java.lang.Object

java.lang.Enum<Energy>

org.tquadrat.foundation.value.Energy

All Implemented Interfaces:

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

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

The various instances of energy …

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

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

Since:

0.3.0

UML Diagram

⁠

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

⁠

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
BETHE	A bethe.
BTU	A British Thermal Unit (BTU).
CALORIE	A calorie.
ELECTRONVOLT	An electron volt.
ERG	An erg.
FOE	A foe (or a 'bethe').
GIGAJOULE	A Giga Joule.
JOULE	A Joule.
KILOCALORIE	A kilo calorie.
KILOGRAM_TNT	The energy equivalent of one kg TNT
KILOJOULE	A kilo Joule.
KILOPONDMETER	A kilopond meter.
KILOTON_TNT	The energy equivalent of one thousand tons of TNT
KILOWATT_HOUR	A kilo Watt per hour.
MEGAJOULE	A Mega Joule.
MEGATON_TNT	The energy equivalent of one million tons of TNT
QUAD	A quad.
TERAJOULE	A Mega Joule.

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

Method Summary

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

ELECTRONVOLT

public static final Energy ELECTRONVOLT

An electron volt.

ERG

public static final Energy ERG

An erg.

JOULE

public static final Energy JOULE

A Joule.

CALORIE

public static final Energy CALORIE

A calorie.

KILOJOULE

public static final Energy KILOJOULE

A kilo Joule.

BTU

public static final Energy BTU

A British Thermal Unit (BTU).

KILOCALORIE

public static final Energy KILOCALORIE

A kilo calorie.

KILOPONDMETER

public static final Energy KILOPONDMETER

A kilopond meter.

MEGAJOULE

public static final Energy MEGAJOULE

A Mega Joule.

KILOWATT_HOUR

public static final Energy KILOWATT_HOUR

A kilo Watt per hour.

KILOGRAM_TNT

public static final Energy KILOGRAM_TNT

The energy equivalent of one kg TNT. This is usually used to rate the power of (nuclear) bombs or other explosives.

GIGAJOULE

public static final Energy GIGAJOULE

A Giga Joule.

TERAJOULE

public static final Energy TERAJOULE

A Mega Joule.

KILOTON_TNT

public static final Energy KILOTON_TNT

The energy equivalent of one thousand tons of TNT. This is usually used to rate the power of (nuclear) bombs or other explosives.

MEGATON_TNT

public static final Energy MEGATON_TNT

The energy equivalent of one million tons of TNT. This is usually used to rate the power of (nuclear) bombs or other explosives.

QUAD

public static final Energy QUAD

A quad.

FOE

public static final Energy FOE

A foe (or a 'bethe').

A foe is used to express the large amount of energy released by a supernova. An acronym for "[ten to the power of] fifty-one ergs", the term was introduced by Gerald E. Brown of Stony Brook University in his work with Hans Bethe, because "it came up often enough in our work".

Without mentioning the foe, Steven Weinberg proposed in 2006 "a new unit called the bethe (B)" with the same value, to "replace" it.

This unit of measure is convenient because a supernova typically releases about one foe of observable energy in a very short period (which can be measured in seconds).

BETHE

public static final Energy BETHE

A bethe.

This is the same as foe.

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

Energy

private Energy(BigDecimal factor,
 String unitSymbol)

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

Parameters:

factor - The factor.

unitSymbol - The unit symbol String.

Energy

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

Creates a new Length instance.

Parameters:

factor - The factor.

unitSymbol - The unit symbol String.

precision - The default precision.

Method Details

values

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

Returns the Energy 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.