Package tech.units.indriya.unit
Class AnnotatedUnit<Q extends javax.measure.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<javax.measure.Unit<Q>>
,javax.measure.Unit<Q>
,ComparableUnit<Q>
This class represents an annotated unit.
Instances of this class are created through the AbstractUnit.annotate(String)
method.
- Since:
- 1.0
- Version:
- 1.3.2, Dezember 27, 2017
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class tech.units.indriya.AbstractUnit
AbstractUnit.Equalizer
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final AbstractUnit<Q>
Holds the actual unit.private final String
Holds the annotation.private static final long
Fields inherited from class tech.units.indriya.AbstractUnit
name, ONE, SYMBOL_TO_UNIT
-
Constructor Summary
ConstructorsConstructorDescriptionAnnotatedUnit
(AbstractUnit<Q> actualUnit, String annotation) Creates an annotated unit equivalent to the specified unit. -
Method Summary
Modifier and TypeMethodDescriptionboolean
Returns the actual unit of this annotated unit (never an annotated unit itself).Returns the annotation of this annotated unit.javax.measure.Dimension
javax.measure.UnitConverter
Returns the converter from this unit to its unscaledSystem Unit
unit.int
hashCode()
javax.measure.Unit<Q>
Returns the unscaledSI
unit from which this unit is derived.Methods inherited from class tech.units.indriya.AbstractUnit
alternate, annotate, asType, compareTo, divide, divide, divide, getActualType, getConverterTo, getConverterToAny, getName, getSystemUnit, inverse, isCompatible, isEquivalentOf, isSystemUnit, multiply, multiply, multiply, parse, pow, prefix, root, setName, setSymbol, shift, toString, transform
-
Field Details
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
actualUnit
Holds the actual unit. -
annotation
Holds the annotation.
-
-
Constructor Details
-
AnnotatedUnit
Creates an annotated unit equivalent to the specified unit.- Parameters:
actualUnit
- the unit to be annotated.annotation
- the annotation.
-
-
Method Details
-
getActualUnit
Returns the actual unit of this annotated unit (never an annotated unit itself).- Returns:
- the actual unit.
-
getAnnotation
Returns the annotation of this annotated unit.- Returns:
- the annotation.
-
getSymbol
-
getBaseUnits
- Specified by:
getBaseUnits
in interfacejavax.measure.Unit<Q extends javax.measure.Quantity<Q>>
- Specified by:
getBaseUnits
in classAbstractUnit<Q extends javax.measure.Quantity<Q>>
-
toSystemUnit
Description copied from class:AbstractUnit
Returns the unscaledSI
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 classAbstractUnit<Q extends javax.measure.Quantity<Q>>
- Returns:
- the unscaled metric unit from which this unit is derived.
-
getDimension
public javax.measure.Dimension getDimension()- Specified by:
getDimension
in interfacejavax.measure.Unit<Q extends javax.measure.Quantity<Q>>
- Specified by:
getDimension
in classAbstractUnit<Q extends javax.measure.Quantity<Q>>
-
getSystemConverter
public javax.measure.UnitConverter getSystemConverter()Description copied from class:AbstractUnit
Returns the converter from this unit to its unscaledSystem Unit
unit.- Specified by:
getSystemConverter
in classAbstractUnit<Q extends javax.measure.Quantity<Q>>
- Returns:
getConverterTo(this.toSystemUnit())
- See Also:
-
hashCode
public int hashCode()- Specified by:
hashCode
in classAbstractUnit<Q extends javax.measure.Quantity<Q>>
-
equals
- Specified by:
equals
in classAbstractUnit<Q extends javax.measure.Quantity<Q>>
-