Package tech.units.indriya.unit

Class AnnotatedUnit<Q extends Quantity<Q>>

java.lang.Object

tech.units.indriya.AbstractUnit<Q>

tech.units.indriya.unit.AnnotatedUnit<Q>

Type Parameters:

Q - The type of the quantity measured by this unit.

All Implemented Interfaces:

Serializable, Comparable<Unit<Q>>, Unit<Q>, tech.uom.lib.common.function.Nameable, tech.uom.lib.common.function.PrefixOperator<Q>, tech.uom.lib.common.function.SymbolSupplier

public final class AnnotatedUnit<Q extends Quantity<Q>>
extends AbstractUnit<Q>

This class represents an annotated unit.

Instances of this class are created through the of(Unit, String) method.

Since:

1.0

Version:

1.5, March 30, 2019

Author:

Jean-Marie Dautelle, Werner Keil

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class tech.units.indriya.AbstractUnit

AbstractUnit.Equalizer

Field Summary

Fields inherited from class tech.units.indriya.AbstractUnit

ONE, scale, SYMBOL_TO_UNIT

Constructor Summary

Constructors

Constructor	Description
AnnotatedUnit(Unit<Q> actualUnit, String annotation)	Creates an annotated unit equivalent to the specified unit.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
Unit<Q>	getActualUnit()	Returns the actual unit of this annotated unit (never an annotated unit itself).
String	getAnnotation()	Returns the annotation of this annotated unit.
Map<? extends Unit<?>,Integer>	getBaseUnits()
Dimension	getDimension()
String	getSymbol()
UnitConverter	getSystemConverter()	Returns the converter from this unit to its unscaled System Unit unit.
int	hashCode()
static <Q extends Quantity<Q>> AnnotatedUnit<Q>	of(Unit<Q> actualUnit, String annotation)	Creates an annotated unit equivalent to the specified unit.
Unit<Q>	toSystemUnit()	Returns the unscaled SI unit from which this unit is derived.

Methods inherited from class tech.units.indriya.AbstractUnit

alternate, annotate, asType, compareTo, divide, divide, divide, getActualType, getConverterTo, getConverterTo, getConverterToAny, getConverterToAny, getName, getSystemUnit, internalGetConverterTo, inverse, isCompatible, isEquivalentTo, isSystemUnit, multiply, multiply, multiply, parse, pow, prefix, root, setName, setSymbol, shift, shift, toString, transform

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AnnotatedUnit

public AnnotatedUnit(Unit<Q> actualUnit,
                     String annotation)

Creates an annotated unit equivalent to the specified unit.

Parameters:

actualUnit - the unit to be annotated.

annotation - the annotation.

Method Detail

getActualUnit

public Unit<Q> getActualUnit()

Returns the actual unit of this annotated unit (never an annotated unit itself).

Returns:

the actual unit.

getAnnotation

public String getAnnotation()

Returns the annotation of this annotated unit.

Returns:

the annotation.

getSymbol

public String getSymbol()

Specified by:

getSymbol in interface tech.uom.lib.common.function.SymbolSupplier

Specified by:

getSymbol in interface Unit<Q extends Quantity<Q>>

Overrides:

getSymbol in class AbstractUnit<Q extends Quantity<Q>>

getBaseUnits

public Map<? extends Unit<?>,Integer> getBaseUnits()

Specified by:

getBaseUnits in interface Unit<Q extends Quantity<Q>>

Specified by:

getBaseUnits in class AbstractUnit<Q extends Quantity<Q>>

toSystemUnit

public Unit<Q> toSystemUnit()

Description copied from class: AbstractUnit

Returns the unscaled SI unit from which this unit is derived. The SI unit can be be used to identify a quantity given the unit. For example: static boolean isAngularVelocity(AbstractUnit unit) { return unit.toSystemUnit().equals(RADIAN.divide(SECOND)); } assert(REVOLUTION.divide(MINUTE).isAngularVelocity()); // Returns true.

Specified by:

toSystemUnit in class AbstractUnit<Q extends Quantity<Q>>

Returns:

the unscaled metric unit from which this unit is derived.

getDimension

public Dimension getDimension()

Specified by:

getDimension in interface Unit<Q extends Quantity<Q>>

Specified by:

getDimension in class AbstractUnit<Q extends Quantity<Q>>

getSystemConverter

public UnitConverter getSystemConverter()

Description copied from class: AbstractUnit

Returns the converter from this unit to its unscaled System Unit unit.

Specified by:

getSystemConverter in class AbstractUnit<Q extends Quantity<Q>>

Returns:

getConverterTo(this.toSystemUnit())

See Also:

AbstractUnit.toSystemUnit()

hashCode

public int hashCode()

Specified by:

hashCode in class AbstractUnit<Q extends Quantity<Q>>

equals

public boolean equals(Object obj)

Specified by:

equals in class AbstractUnit<Q extends Quantity<Q>>

of

public static <Q extends Quantity<Q>> AnnotatedUnit<Q> of(Unit<Q> actualUnit,
                                                          String annotation)

Creates an annotated unit equivalent to the specified unit.

Parameters:

actualUnit - the unit to be annotated.

annotation - the annotation.

Returns:

the annotated unit.