Module org.tquadrat.foundation.value

Package org.tquadrat.foundation.value.api

Interface Dimension

All Superinterfaces:

Serializable

All Known Subinterfaces:

DimensionWithLinearConversion

All Known Implementing Classes:

Area, DataSize, Energy, Force, Length, Mass, Power, Pressure, Speed, Temperature, Time, Volume

@ClassVersion(sourceVersion="$Id: Dimension.java 1072 2023-09-30 20:44:38Z tquadrat $")
@API(status=STABLE,
     since="0.1.0")
public interface Dimension
extends Serializable

The implementations of this interface are used to give (numerical) values a dimension and a measuring unit. So 3.1415 is just a number, but it could also stand for a length (3.1415 m), a time (3.1415 s) or even the fuel consumption of a car (3.1415 l/100 km). Depending on the dimension, different values could be equal:

1.0 m == 100.0 cm

and should be treated as such.

This interface should be implemented as enums, where the enum values are the units, and as such they should provide a method to retrieve an enum value (a unit) by the respective symbol.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

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

Since:

0.1.0

UML Diagram

⁠

UML Diagram for "org.tquadrat.foundation.value.api.Dimension"

⁠

Field Summary

Fields

Modifier and Type	Field	Description
static final String	MSG_UnknownUnit	Message: Unknown Unit.

Method Summary

Modifier and Type	Method	Description
<D extends Dimension> D	baseUnit()	Returns the base unit.
boolean	equals(Object o)
UnaryOperator<BigDecimal>	fromBase()	Returns the conversion that is used to convert a value from the base unit to this unit.
default int	getPrecision()	Returns the default precision for this unit that is used when the respective value is converted to a String.
String	name()	Returns the internal name of the dimension.
UnaryOperator<BigDecimal>	toBase()	Returns the conversion that is used to convert a value from this unit to the base unit.
String	toString()
String	unitSymbol()	Returns the unit symbol for the dimension as a single line string.
default String	unitSymbolForPrinting()	Returns the unit symbol for the dimension still as a single line string, but with special characters.

Field Details

MSG_UnknownUnit

static final String MSG_UnknownUnit

Message: Unknown Unit.

See Also:

• Constant Field Values

Method Details

baseUnit

<D extends Dimension> D 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.

Type Parameters:

D - The implementing class for the interface.

Returns:

The base unit.

equals

boolean equals(Object o)

Dimensions are equal when they are identical; therefore they should be implemented as Multitons (constants of the implementing class, without the option to create additional instances on runtime).

Overrides:

equals in class Object

fromBase

UnaryOperator<BigDecimal> fromBase()

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

Returns:

The conversion.

getPrecision

default int getPrecision()

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

Returns:

The mantissa length for a value with this unit.

toBase

UnaryOperator<BigDecimal> toBase()

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

Returns:

The conversion.

name

String name()

Returns the internal name of the dimension.

Returns:

The internal name.

toString

String toString()

Overrides:

toString in class Object

Note:

• toString() should be implemented to return the result of instead of , as it would be the default for enums.

unitSymbol

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)".

Returns:

The unit.

unitSymbolForPrinting

default String unitSymbolForPrinting()

Returns the unit symbol for the dimension still as a single line string, but with special characters.

For a length, this would still be "m", for a speed "km/h", but for an acceleration, it would be "m/s²".

For most dimensions, this is the same as the return value of unitSymbol().

Returns:

The unit beautified for printing.