javax.units
Class TransformedUnit

Object
  Unit
      DerivedUnit
          TransformedUnit

All Implemented Interfaces:

Serializable

public class TransformedUnit

extends DerivedUnit

This class represents a unit derived from another unit using a Converter.

Examples of transformed units:

         CELSIUS = KELVIN.add(273.15); // Use label from unit database.
         MILLISECOND = SECOND.multiply(1e-3); // Use label from unit database.
     

Transformed units have no intrinsic symbol. But like any other units, they may have labels attached to them:

         FOOT = UnitFormat.label(METER.multiply(0.3048), "ft");
         CENTIMETER = UnitFormat.label(METER.multiply(0.01), "cm");
         CALENDAR_YEAR = UnitFormat.label(DAY.multiply(365), "year");
     

or aliases:

         UnitFormat.alias(KELVIN.add(273.15), "Celsius");
         UnitFormat.alias(METER.multiply(0.01), "centimeter");
         UnitFormat.alias(METER.multiply(0.01), "centimetre");
     

See Also:

Unit.add(double), Unit.multiply(double), UnitFormat, Serialized Form

Field Summary

Fields inherited from class Unit

ONE

Method Summary

boolean	equals(Object that) Indicates if this unit is equal to the object specified.
static Unit	getInstance(Unit parent, Converter toParent) Returns the unit derived from the specified unit using the specified converter.
Unit	getSystemUnit() Returns the system unit for this unit.

Methods inherited from class Unit

add, alternate, appendTo, divide, getConverterTo, getDimension, getInstance, getInstances, hashCode, isCompatible, isSystemUnit, multiply, multiply, pow, readResolve, root, searchSymbol, toString, valueOf

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getInstance

public static Unit getInstance(Unit parent,
                               Converter toParent)

Returns the unit derived from the specified unit using the specified converter.

Parameters:

parent - the unit from which this unit is derived.

toParent - the converter to the parent unit.

Returns:

the corresponding derived unit.

getSystemUnit

public Unit getSystemUnit()

Description copied from class: Unit

Returns the system unit for this unit. The system unit identifies the nature of the quantity being measured using this unit.

Note: Having the same system units is not sufficient to ensure that a converter exists between the two units (e.g. °C/m and K/m).

Specified by:

getSystemUnit in class Unit

Returns:

the system unit for this unit.

See Also:

Unit.isSystemUnit()

equals

public boolean equals(Object that)

Description copied from class: Unit

Indicates if this unit is equal to the object specified. Units are unique and immutable, therefore users might want to use == to test for equality.

Specified by:

equals in class Unit

Parameters:

that - the object to compare for equality.

Returns:

true if this unit and the specified object are considered equal; false otherwise.