Package tech.units.indriya.unit

Class TransformedUnit<Q extends javax.measure.Quantity<Q>>

java.lang.Object

tech.units.indriya.AbstractUnit<Q>

tech.units.indriya.unit.TransformedUnit<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>, tech.uom.lib.common.function.Nameable, tech.uom.lib.common.function.PrefixOperator<Q>, tech.uom.lib.common.function.SymbolSupplier, tech.uom.lib.common.function.UnitConverterSupplier

public final class TransformedUnit<Q extends javax.measure.Quantity<Q>>
extends AbstractUnit<Q>
implements tech.uom.lib.common.function.UnitConverterSupplier

This class represents the units derived from other units using converters.

Examples of transformed units: CELSIUS = KELVIN.shift(273.15); FOOT = METRE.multiply(3048).divide(10000); MILLISECOND = MILLI(SECOND);

Transformed units have no symbol. But like any other units, they may have labels attached to them (see UnitFormat.label

Instances of this class are created through the AbstractUnit.transform(javax.measure.UnitConverter) method.

Since:

1.0

Version:

2.0, March 1, 2020

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

name, ONE, SYMBOL_TO_UNIT

Constructor Summary

Constructors

Constructor	Description
TransformedUnit(String symbol, String name, javax.measure.Unit<Q> parentUnit, javax.measure.Unit<Q> sysUnit, javax.measure.UnitConverter unitConverter)	Creates a transformed unit from the specified parent and system unit.
TransformedUnit(String symbol, String name, javax.measure.Unit<Q> parentUnit, javax.measure.UnitConverter unitConverter)	Creates a transformed unit from the specified parent unit.
TransformedUnit(String symbol, javax.measure.Unit<Q> parentUnit, javax.measure.Unit<Q> sysUnit, javax.measure.UnitConverter unitConverter)	Creates a transformed unit from the specified parent and system unit.
TransformedUnit(String symbol, javax.measure.Unit<Q> parentUnit, javax.measure.UnitConverter unitConverter)	Creates a transformed unit from the specified parent unit.
TransformedUnit(javax.measure.Unit<Q> parentUnit, javax.measure.UnitConverter unitConverter)	Creates a transformed unit from the specified system unit.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
Map<? extends javax.measure.Unit<?>,Integer>	getBaseUnits()
javax.measure.UnitConverter	getConverter()	Returns the converter to the parent unit.
javax.measure.Dimension	getDimension()
javax.measure.Unit<Q>	getParentUnit()	Returns the parent unit for this unit.
javax.measure.UnitConverter	getSystemConverter()	Returns the converter from this unit to its unscaled System Unit unit.
int	hashCode()
protected javax.measure.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, divide, getActualType, getConverterTo, getConverterToAny, getName, getSymbol, getSystemUnit, internalGetConverterTo, inverse, isCompatible, isEquivalentTo, isSystemUnit, multiply, 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

TransformedUnit

public TransformedUnit(javax.measure.Unit<Q> parentUnit,
                       javax.measure.UnitConverter unitConverter)

Creates a transformed unit from the specified system unit. using the parent as symbol

Parameters:

parentUnit - the system unit from which this unit is derived.

converter - the converter to the parent units.

TransformedUnit

public TransformedUnit(String symbol,
                       String name,
                       javax.measure.Unit<Q> parentUnit,
                       javax.measure.UnitConverter unitConverter)

Creates a transformed unit from the specified parent unit.

Parameters:

symbol - the symbol to use with this transformed unit.

name - the name to use with this transformed unit.

parentUnit - the parent unit from which this unit is derived.

unitConverter - the converter to the parent units.

Since:

2.0

TransformedUnit

public TransformedUnit(String symbol,
                       javax.measure.Unit<Q> parentUnit,
                       javax.measure.UnitConverter unitConverter)

Creates a transformed unit from the specified parent unit.

Parameters:

symbol - the symbol to use with this transformed unit.

parentUnit - the parent unit from which this unit is derived.

unitConverter - the converter to the parent units.

TransformedUnit

public TransformedUnit(String symbol,
                       String name,
                       javax.measure.Unit<Q> parentUnit,
                       javax.measure.Unit<Q> sysUnit,
                       javax.measure.UnitConverter unitConverter)

Creates a transformed unit from the specified parent and system unit. using a specific symbol and name.

Parameters:

symbol - the symbol for this unit.

name - the name for this unit.

parentUnit - the parent unit from which this unit is derived.

sysUnit - the system unit which this unit is based on.

converter - the converter to the parent units.

Since:

2.0

TransformedUnit

public TransformedUnit(String symbol,
                       javax.measure.Unit<Q> parentUnit,
                       javax.measure.Unit<Q> sysUnit,
                       javax.measure.UnitConverter unitConverter)

Creates a transformed unit from the specified parent and system unit. using a specific symbol.

Parameters:

symbol - the symbol for this unit.

parentUnit - the parent unit from which this unit is derived.

sysUnit - the system unit which this unit is based on.

converter - the converter to the parent units.

Method Detail

getDimension

public javax.measure.Dimension getDimension()

Specified by:

getDimension in interface javax.measure.Unit<Q extends javax.measure.Quantity<Q>>

Specified by:

getDimension in class AbstractUnit<Q extends javax.measure.Quantity<Q>>

getSystemConverter

public javax.measure.UnitConverter getSystemConverter()

Description copied from interface: ComparableUnit

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

Specified by:

getSystemConverter in interface ComparableUnit<Q extends javax.measure.Quantity<Q>>

Returns:

getConverterTo(this.toSystemUnit())

See Also:

#toSystemUnit

getConverter

public javax.measure.UnitConverter getConverter()

Returns the converter to the parent unit.

Specified by:

getConverter in interface tech.uom.lib.common.function.UnitConverterSupplier

Returns:

the converter to the parent unit.

toSystemUnit

protected javax.measure.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 javax.measure.Quantity<Q>>

Returns:

the unscaled metric unit from which this unit is derived.

getBaseUnits

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

Specified by:

getBaseUnits in interface javax.measure.Unit<Q extends javax.measure.Quantity<Q>>

Specified by:

getBaseUnits in class AbstractUnit<Q extends javax.measure.Quantity<Q>>

hashCode

public int hashCode()

Specified by:

hashCode in class AbstractUnit<Q extends javax.measure.Quantity<Q>>

equals

public boolean equals(Object obj)

Specified by:

equals in class AbstractUnit<Q extends javax.measure.Quantity<Q>>

getParentUnit

public javax.measure.Unit<Q> getParentUnit()

Returns the parent unit for this unit. The parent unit is the untransformed unit from which this unit is derived.

Returns:

the untransformed unit from which this unit is derived.