Units of Measurement Reference Implementation 2.2.2 · tech.units.indriya.unit.AnnotatedUnit

Modifier and Type	Field and Description
private final Unit<Q>	actualUnit Holds the actual unit.
private final String	annotation Holds the annotation.
private static final long	serialVersionUID Hides tech.units.indriya.AbstractUnit.serialVersionUID.

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

Method Summary

Modifier and Type	Method and Description
public boolean	equals(Object the reference object with which to compare. obj) Implements abstract tech.units.indriya.AbstractUnit.equals. Indicates whether some other object is "equal to" this one.
public Unit<Q>	Returns: the actual unit. getActualUnit() Returns the actual unit of this annotated unit (never an annotated unit itself).
public String	Returns: the annotation. getAnnotation() Returns the annotation of this annotated unit.
public Map<? extends Unit<?>, Integer>	getBaseUnits() Implements abstract tech.units.indriya.AbstractUnit.getBaseUnits. Implements javax.measure.Unit.getBaseUnits. Returns the base units and their exponent whose product is this unit, or `null` if this unit is a base unit (not a product of existing units).
public Dimension	getDimension() Implements abstract tech.units.indriya.AbstractUnit.getDimension. Implements javax.measure.Unit.getDimension. Returns the dimension of this unit.
public String	getSymbol() Overrides tech.units.indriya.AbstractUnit.getSymbol. Implements javax.measure.Unit.getSymbol, tech.uom.lib.common.function.SymbolSupplier.getSymbol. Returns the symbol (if any) of this unit.
public UnitConverter	getSystemConverter() Implements abstract tech.units.indriya.AbstractUnit.getSystemConverter. Returns the converter from this unit to its unscaled `System Unit` unit.
public int	hashCode() Implements abstract tech.units.indriya.AbstractUnit.hashCode. Returns a hash code value for this object.
public static <Q extends Quantity<Q>> AnnotatedUnit<Q>	Returns: the annotated unit. of(Unit<Q> the unit to be annotated. actualUnit, String the annotation. annotation) Creates an annotated unit equivalent to the specified unit.
public Unit<Q>	toSystemUnit() Implements abstract tech.units.indriya.AbstractUnit.toSystemUnit. Returns the unscaled `SI` unit from which this unit is derived.

actualUnit	back to summary
private final Unit<Q> actualUnit Holds the actual unit.

annotation	back to summary
private final String annotation Holds the annotation.

serialVersionUID	back to summary
private static final long serialVersionUID Hides tech.units.indriya.AbstractUnit.serialVersionUID.

AnnotatedUnit	back to summary
public AnnotatedUnit(Unit<Q> actualUnit, String annotation) Creates an annotated unit equivalent to the specified unit. Parameters actualUnit:Unit<Q> the unit to be annotated. annotation:String the annotation.

Method Detail

equals back to summary

equals	back to summary
public boolean equals(Object obj) Implements abstract tech.units.indriya.AbstractUnit.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters obj:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object obj)

Implements abstract tech.units.indriya.AbstractUnit.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

obj:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

getActualUnit	back to summary
public Unit<Q> getActualUnit() Returns the actual unit of this annotated unit (never an annotated unit itself). Returns:Unit<Q> the actual unit.

getActualUnit

back to summary

public Unit<Q> getActualUnit()

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

Returns:Unit<Q>: the actual unit.

getAnnotation	back to summary
public String getAnnotation() Returns the annotation of this annotated unit. Returns:String the annotation.

getAnnotation

back to summary

public String getAnnotation()

Returns the annotation of this annotated unit.

Returns:String: the annotation.

getBaseUnits back to summary

getBaseUnits	back to summary
public Map<? extends Unit<?>, Integer> getBaseUnits() Implements abstract tech.units.indriya.AbstractUnit.getBaseUnits. Implements javax.measure.Unit.getBaseUnits. Doc from javax.measure.Unit.getBaseUnits. Returns the base units and their exponent whose product is this unit, or `null` if this unit is a base unit (not a product of existing units). Returns:Map<? extends Unit<?>, Integer> the base units and their exponent making up this unit. Annotations @Override

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

Implements abstract tech.units.indriya.AbstractUnit.getBaseUnits.

Implements javax.measure.Unit.getBaseUnits.

Doc from javax.measure.Unit.getBaseUnits.

Returns the base units and their exponent whose product is this unit, or null if this unit is a base unit (not a product of existing units).

Returns:Map<? extends Unit<?>, Integer>

the base units and their exponent making up this unit.

Annotations

@Override

getDimension back to summary

getDimension	back to summary
public Dimension getDimension() Implements abstract tech.units.indriya.AbstractUnit.getDimension. Implements javax.measure.Unit.getDimension. Doc from javax.measure.Unit.getDimension. Returns the dimension of this unit. Two units `u1` and `u2` are compatible if and only if `u1.getDimension().equals(u2.getDimension())`. Returns:Dimension the dimension of this unit. Annotations @Override

public Dimension getDimension()

Implements abstract tech.units.indriya.AbstractUnit.getDimension.

Implements javax.measure.Unit.getDimension.

Doc from javax.measure.Unit.getDimension.

Returns the dimension of this unit. Two units u1 and u2 are compatible if and only if u1.getDimension().equals(u2.getDimension()).

Returns:Dimension

the dimension of this unit.

Annotations

@Override

getSymbol back to summary

getSymbol	back to summary
public String getSymbol() Overrides tech.units.indriya.AbstractUnit.getSymbol. Implements javax.measure.Unit.getSymbol, tech.uom.lib.common.function.SymbolSupplier.getSymbol. Doc from javax.measure.Unit.getSymbol. Returns the symbol (if any) of this unit. This method returns `null` if this unit has no specific symbol associated with. Returns:String this unit symbol, or `null` if this unit has not specific symbol associated with (e.g. product of units). Annotations @Override

public String getSymbol()

Overrides tech.units.indriya.AbstractUnit.getSymbol.

Implements javax.measure.Unit.getSymbol, tech.uom.lib.common.function.SymbolSupplier.getSymbol.

Doc from javax.measure.Unit.getSymbol.

Returns the symbol (if any) of this unit. This method returns null if this unit has no specific symbol associated with.

Returns:String

this unit symbol, or null if this unit has not specific symbol associated with (e.g. product of units).

Annotations

@Override

getSystemConverter back to summary

getSystemConverter	back to summary
public UnitConverter getSystemConverter() Implements abstract tech.units.indriya.AbstractUnit.getSystemConverter. Doc from tech.units.indriya.AbstractUnit.getSystemConverter. Returns the converter from this unit to its unscaled `System Unit` unit. Returns:UnitConverter `getConverterTo(this.toSystemUnit())` Annotations @Override

public UnitConverter getSystemConverter()

Implements abstract tech.units.indriya.AbstractUnit.getSystemConverter.

Doc from tech.units.indriya.AbstractUnit.getSystemConverter.

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

Returns:UnitConverter

getConverterTo(this.toSystemUnit())

Annotations

@Override

hashCode back to summary

hashCode	back to summary
public int hashCode() Implements abstract tech.units.indriya.AbstractUnit.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object Annotations @Override

public int hashCode()

Implements abstract tech.units.indriya.AbstractUnit.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object

Annotations

@Override

of	back to summary
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:Unit<Q> the unit to be annotated. annotation:String the annotation. Returns:AnnotatedUnit<Q> the annotated unit.

back to summary

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:Unit<Q>: the unit to be annotated.
annotation:String: the annotation.

Returns:AnnotatedUnit<Q>

the annotated unit.

toSystemUnit back to summary

toSystemUnit	back to summary
public Unit<Q> toSystemUnit() Implements abstract tech.units.indriya.AbstractUnit.toSystemUnit. Doc from tech.units.indriya.AbstractUnit.toSystemUnit. 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.` Returns:Unit<Q> the unscaled metric unit from which this unit is derived. Annotations @Override

public Unit<Q> toSystemUnit()

Implements abstract tech.units.indriya.AbstractUnit.toSystemUnit.

Doc from tech.units.indriya.AbstractUnit.toSystemUnit.

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.

Returns:Unit<Q>

the unscaled metric unit from which this unit is derived.

Annotations

@Override

public final Class AnnotatedUnit<Q extends Quantity<Q>>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail