Top Description Fields Constructors Methods
tech.units.indriya.unit

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

extends AbstractUnit<Q extends Quantity<Q>>
implements UnitConverterSupplier
Class Inheritance
All Implemented Interfaces
tech.uom.lib.common.function.UnitConverterSupplier
Type Parameters
<Q>
The type of the quantity measured by this unit.
Imports
java.util.Map, .Objects, javax.measure.Dimension, .Quantity, .Unit, .UnitConverter, tech.units.indriya.AbstractUnit, 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 method.

Authors
Jean-Marie Dautelle, Werner Keil
Since
1.0
Version
2.0, March 1, 2020

Field Summary

Modifier and TypeField and Description
private final UnitConverter
converter

Holds the converter to the parent unit.

private final AbstractUnit<Q>
parentUnit

Holds the parent unit.

private static final long
serialVersionUID

Hides tech.units.indriya.AbstractUnit.serialVersionUID.

private final Unit<Q>
systemUnit

Holds the system unit.

Inherited from tech.units.indriya.AbstractUnit:
ONEscaleSYMBOL_TO_UNIT

Constructor Summary

AccessConstructor and Description
public
TransformedUnit(Unit<Q>
the system unit from which this unit is derived.
parentUnit, UnitConverter unitConverter)

Creates a transformed unit from the specified system unit.

public
TransformedUnit(String
the symbol to use with this transformed unit.
symbol, String
the name to use with this transformed unit.
name, Unit<Q>
the parent unit from which this unit is derived.
parentUnit, UnitConverter
the converter to the parent units.
unitConverter)

Creates a transformed unit from the specified parent unit.

public
TransformedUnit(String
the symbol to use with this transformed unit.
symbol, Unit<Q>
the parent unit from which this unit is derived.
parentUnit, UnitConverter
the converter to the parent units.
unitConverter)

Creates a transformed unit from the specified parent unit.

public
TransformedUnit(String
the symbol for this unit.
symbol, String
the name for this unit.
name, Unit<Q>
the parent unit from which this unit is derived.
parentUnit, Unit<Q>
the system unit which this unit is based on.
sysUnit, UnitConverter unitConverter)

Creates a transformed unit from the specified parent and system unit.

public
TransformedUnit(String
the symbol for this unit.
symbol, Unit<Q>
the parent unit from which this unit is derived.
parentUnit, Unit<Q>
the system unit which this unit is based on.
sysUnit, UnitConverter unitConverter)

Creates a transformed unit from the specified parent and system unit.

Method Summary

Modifier and TypeMethod 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 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 UnitConverter

Returns:

the converter to the parent unit.
getConverter()

Implements tech.uom.lib.common.function.UnitConverterSupplier.getConverter.

Returns the converter to the parent unit.

public Dimension
getDimension()

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

Implements javax.measure.Unit.getDimension.

Returns the dimension of this unit.

public Unit<Q>

Returns:

the untransformed unit from which this unit is derived.
getParentUnit()

Returns the parent unit for 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.

protected Unit<Q>
toSystemUnit()

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

Returns the unscaled SI unit from which this unit is derived.

Inherited from tech.units.indriya.AbstractUnit:
alternateannotateasTypecompareTodividedividedividegetActualTypegetConverterTogetConverterTogetConverterToAnygetConverterToAnygetNamegetSymbolgetSystemUnitinternalGetConverterToinverseisCompatibleisEquivalentToisSystemUnitmultiplymultiplymultiplyparsepowprefixrootsetNamesetSymbolshiftshifttoStringtransform

Field Detail

converterback to summary
private final UnitConverter converter

Holds the converter to the parent unit.

parentUnitback to summary
private final AbstractUnit<Q> parentUnit

Holds the parent unit.

serialVersionUIDback to summary
private static final long serialVersionUID

Hides tech.units.indriya.AbstractUnit.serialVersionUID.

systemUnitback to summary
private final Unit<Q> systemUnit

Holds the system unit.

Constructor Detail

TransformedUnitback to summary
public TransformedUnit(Unit<Q> parentUnit, UnitConverter unitConverter)

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

Parameters
parentUnit:Unit<Q>

the system unit from which this unit is derived.

TransformedUnitback to summary
public TransformedUnit(String symbol, String name, Unit<Q> parentUnit, UnitConverter unitConverter)

Creates a transformed unit from the specified parent unit.

Parameters
symbol:String

the symbol to use with this transformed unit.

name:String

the name to use with this transformed unit.

parentUnit:Unit<Q>

the parent unit from which this unit is derived.

unitConverter:UnitConverter

the converter to the parent units.

Since
2.0
TransformedUnitback to summary
public TransformedUnit(String symbol, Unit<Q> parentUnit, UnitConverter unitConverter)

Creates a transformed unit from the specified parent unit.

Parameters
symbol:String

the symbol to use with this transformed unit.

parentUnit:Unit<Q>

the parent unit from which this unit is derived.

unitConverter:UnitConverter

the converter to the parent units.

TransformedUnitback to summary
public TransformedUnit(String symbol, String name, Unit<Q> parentUnit, Unit<Q> sysUnit, UnitConverter unitConverter)

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

Parameters
symbol:String

the symbol for this unit.

name:String

the name for this unit.

parentUnit:Unit<Q>

the parent unit from which this unit is derived.

sysUnit:Unit<Q>

the system unit which this unit is based on.

Since
2.0
TransformedUnitback to summary
public TransformedUnit(String symbol, Unit<Q> parentUnit, Unit<Q> sysUnit, UnitConverter unitConverter)

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

Parameters
symbol:String

the symbol for this unit.

parentUnit:Unit<Q>

the parent unit from which this unit is derived.

sysUnit:Unit<Q>

the system unit which this unit is based on.

Method Detail

equalsback 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
getBaseUnitsback 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
getConverterback to summary
public UnitConverter getConverter()

Implements tech.uom.lib.common.function.UnitConverterSupplier.getConverter.

Returns the converter to the parent unit.

Returns:UnitConverter

the converter to the parent unit.

Annotations
@Override
getDimensionback 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
getParentUnitback to summary
public Unit<Q> getParentUnit()

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

Returns:Unit<Q>

the untransformed unit from which this unit is derived.

getSystemConverterback 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
hashCodeback 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
toSystemUnitback to summary
protected 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