Module org.tquadrat.foundation.value

Package org.tquadrat.foundation.value

Enum Class Area

java.lang.Object

java.lang.Enum<Area>

org.tquadrat.foundation.value.Area

All Implemented Interfaces:

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

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

The various instances of area …

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

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

Since:

0.1.0

UML Diagram

⁠

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

⁠

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
ACRE	An acre.
AR	An Ar (a unit for areas, used in the EU and Switzerland).
HEKTAR	A hektar (a unit for areas, used in the EU and Switzerland).
MORGEN	A %quot;Morgen", an ancient unit for areas that was used in Germany (and is still used sometimes).
SQUARE_CENTIMETER	A square centimeter.
SQUARE_FOOT	A square foot (144 square inch).
SQUARE_INCH	A square inch.
SQUARE_KILOMETER	A square kilometer.
SQUARE_METER	A square_meter.
SQUARE_MILE	A square mile (1760 yard).
SQUARE_MILLIMETER	A square millimeter.
SQUARE_YARD	A square yard (9 square 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	Area(BigDecimal factor, String unitSymbol)	Creates a new Area instance, with a default precision of zero mantissa digits.
private	Area(BigDecimal factor, String unitSymbol, int precision)	Creates a new Area instance.

Method Summary

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

SQUARE_MILLIMETER

public static final Area SQUARE_MILLIMETER

A square millimeter.

SQUARE_CENTIMETER

public static final Area SQUARE_CENTIMETER

A square centimeter.

SQUARE_INCH

public static final Area SQUARE_INCH

A square inch.

SQUARE_FOOT

public static final Area SQUARE_FOOT

A square foot (144 square inch).

SQUARE_YARD

public static final Area SQUARE_YARD

A square yard (9 square feet).

SQUARE_METER

public static final Area SQUARE_METER

A square_meter.

AR

public static final Area AR

An Ar (a unit for areas, used in the EU and Switzerland). It is 100 square meter.

MORGEN

public static final Area MORGEN

A %quot;Morgen", an ancient unit for areas that was used in Germany (and is still used sometimes). It is 25 ar, 2500 square meter or ¼ ha.

ACRE

public static final Area ACRE

An acre.

HEKTAR

public static final Area HEKTAR

A hektar (a unit for areas, used in the EU and Switzerland). It is 100 a or 10000 square meter.

SQUARE_KILOMETER

public static final Area SQUARE_KILOMETER

A square kilometer.

SQUARE_MILE

public static final Area SQUARE_MILE

A square mile (1760 yard).

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

Area

private Area(BigDecimal factor,
 String unitSymbol)

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

Parameters:

factor - The factor.

unitSymbol - The unit symbol String.

Area

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

Creates a new Area instance.

Parameters:

factor - The factor.

unitSymbol - The unit symbol String.

precision - The default precision.

Method Details

values

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

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