Package tech.units.indriya.unit
Class AlternateUnit<Q extends javax.measure.Quantity<Q>>
java.lang.Object
tech.units.indriya.AbstractUnit<Q>
tech.units.indriya.unit.AlternateUnit<Q>
- All Implemented Interfaces:
Serializable
,Comparable<javax.measure.Unit<Q>>
,javax.measure.Unit<Q>
,ComparableUnit<Q>
This class represents units used in expressions to distinguish between quantities of a different nature but of the same dimensions.
- Since:
- 1.0
- Version:
- 1.3.1, August 06, 2017
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class tech.units.indriya.AbstractUnit
AbstractUnit.Equalizer
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final javax.measure.Unit<?>
Holds the parent unit (a system unit).private static final long
private final String
Holds the symbol for this unit.Fields inherited from class tech.units.indriya.AbstractUnit
name, ONE, SYMBOL_TO_UNIT
-
Constructor Summary
ConstructorsConstructorDescriptionAlternateUnit
(javax.measure.Unit<?> parentUnit, String symbol) Creates an alternate unit for the specified system unit identified by the specified name and symbol. -
Method Summary
Modifier and TypeMethodDescriptionboolean
javax.measure.Dimension
javax.measure.Unit<?>
Returns the parent unit of this alternate unit, always a system unit and never an alternate unit.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:
-
parentUnit
private final javax.measure.Unit<?> parentUnitHolds the parent unit (a system unit). -
symbol
Holds the symbol for this unit.
-
-
Constructor Details
-
AlternateUnit
Creates an alternate unit for the specified system unit identified by the specified name and symbol.- Parameters:
parent
- the system unit from which this alternate unit is derived.symbol
- the symbol for this alternate unit.- Throws:
IllegalArgumentException
- if the specified parent unit is not ansystem unit
-
-
Method Details
-
getParentUnit
public javax.measure.Unit<?> getParentUnit()Returns the parent unit of this alternate unit, always a system unit and never an alternate unit.- Returns:
- the parent unit.
-
getSymbol
-
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:
-
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.
-
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>>
-
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>>
-