Module org.tquadrat.foundation.value

Package org.tquadrat.foundation.value

Enum Class Power

java.lang.Object

java.lang.Enum<Power>

org.tquadrat.foundation.value.Power

All Implemented Interfaces:

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

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

The various instances of power …

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

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

Since:

0.3.0

UML Diagram

⁠

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

⁠

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
ERG_PER_SECOND	An erg per second.
GIGAWATT	A giga Watt.
HORSE_POWER	A 'horsepower'.
KILOWATT	A kilo Watt.
MEGAWATT	A kilo Watt.
MICROWATT	A micro Watt.
MILLIWATT	A milli Watt.
TERAWATT	A Tera Watt.
WATT	A Watt.

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

Method Summary

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

ERG_PER_SECOND

public static final Power ERG_PER_SECOND

An erg per second.

This is the unit of power in the CGS unit system.

MICROWATT

public static final Power MICROWATT

A micro Watt.

MILLIWATT

public static final Power MILLIWATT

A milli Watt.

WATT

public static final Power WATT

A Watt.

HORSE_POWER

public static final Power HORSE_POWER

A 'horsepower'.

KILOWATT

public static final Power KILOWATT

A kilo Watt.

MEGAWATT

public static final Power MEGAWATT

A kilo Watt.

GIGAWATT

public static final Power GIGAWATT

A giga Watt.

TERAWATT

public static final Power TERAWATT

A Tera Watt.

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

Power

private Power(BigDecimal factor,
 String unitSymbol)

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

Parameters:

factor - The factor.

unitSymbol - The unit symbol String.

Power

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

Creates a new Power instance.

Parameters:

factor - The factor.

unitSymbol - The unit symbol String.

precision - The default precision.

Method Details

values

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

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