Module org.tquadrat.foundation.value

Package org.tquadrat.foundation.value

Enum Class Length

java.lang.Object

java.lang.Enum<Length>

org.tquadrat.foundation.value.Length

All Implemented Interfaces:

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

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

The various instances of length …

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

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

Since:

0.1.0

UML Diagram

⁠

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

⁠

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
ÅNGSTRÖM	An Ångström.
ASTRONOMICAL_UNIT	An astronomical unit.
CABLE	A cable length (1/10 of a sea mile or 100 fathom).
CENTIMETER	A centimeter.
DECIMETER	A decimeter.
FATHOM	A fathom.
FOOT	A foot (12 inch).
INCH	An inch.
KILOMETER	A kilometer.
LIGHTYEAR	A light year.
METER	A meter.
MICROMETER	A mikrometer.
MILE	A mile (1760 yard).
MILLIMETER	A millimeter.
NANOMETER	A nanometer.
NAUTICAL_MILE	A nautical or sea mile.
PARSEC	A parsec, according to the definition of the IAU.
PICA	A typographical dot.
YARD	A yard (3 feet).

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

Method Summary

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

ÅNGSTRÖM

public static final Length ÅNGSTRÖM

An Ångström.

NANOMETER

public static final Length NANOMETER

A nanometer.

MICROMETER

public static final Length MICROMETER

A mikrometer.

PICA

public static final Length PICA

A typographical dot.

MILLIMETER

public static final Length MILLIMETER

A millimeter.

CENTIMETER

public static final Length CENTIMETER

A centimeter.

INCH

public static final Length INCH

An inch.

DECIMETER

public static final Length DECIMETER

A decimeter.

FOOT

public static final Length FOOT

A foot (12 inch).

YARD

public static final Length YARD

A yard (3 feet).

METER

public static final Length METER

A meter.

FATHOM

public static final Length FATHOM

A fathom.

CABLE

public static final Length CABLE

A cable length (1/10 of a sea mile or 100 fathom).

KILOMETER

public static final Length KILOMETER

A kilometer.

MILE

public static final Length MILE

A mile (1760 yard).

NAUTICAL_MILE

public static final Length NAUTICAL_MILE

A nautical or sea mile.

ASTRONOMICAL_UNIT

public static final Length ASTRONOMICAL_UNIT

An astronomical unit.

LIGHTYEAR

public static final Length LIGHTYEAR

A light year.

PARSEC

public static final Length PARSEC

A parsec, according to the definition of the IAU.

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

Length

private Length(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.

Length

private Length(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 Length[] 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 Length 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 Length 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 Length forUnit(String unitSymbol)
                            throws IllegalArgumentException

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