JScience v4.3

javax.measure.unit
Class AlternateUnit<Q extends Quantity>

java.lang.Object
  extended by javax.measure.unit.Unit<Q>
      extended by javax.measure.unit.DerivedUnit<Q>
          extended by javax.measure.unit.AlternateUnit<Q>
All Implemented Interfaces:
java.io.Serializable

public final class AlternateUnit<Q extends Quantity>
extends DerivedUnit<Q>

This class represents the units used in expressions to distinguish between quantities of a different nature but of the same dimensions.

Instances of this class are created through the Unit.alternate(String) method.

Version:
4.2, August 26, 2007
Author:
Jean-Marie Dautelle
See Also:
Serialized Form

Field Summary
 
Fields inherited from class javax.measure.unit.Unit
ONE
 
Method Summary
 boolean equals(java.lang.Object that)
          Indicates if this alternate unit is considered equals to the specified object (both are alternate units with equal symbol, equal base units and equal converter to base units).
 Unit<? super Q> getParent()
          Returns the parent unit from which this alternate unit is derived (a system unit itself).
 Unit<? super Q> getStandardUnit()
          Returns the base unit, alternate unit or product of base units and alternate units this unit is derived from.
 java.lang.String getSymbol()
          Returns the symbol for this alternate unit.
 int hashCode()
          Returns the hash code for this unit.
 UnitConverter toStandardUnit()
          Returns the converter from this unit to its system unit.
 
Methods inherited from class javax.measure.unit.Unit
alternate, asType, compound, divide, divide, divide, getConverterTo, getDimension, inverse, isCompatible, isStandardUnit, plus, pow, root, times, times, times, toString, transform, valueOf
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Method Detail

getSymbol

public final java.lang.String getSymbol()
Returns the symbol for this alternate unit.

Returns:
this alternate unit symbol.

getParent

public final Unit<? super Q> getParent()
Returns the parent unit from which this alternate unit is derived (a system unit itself).

Returns:
the parent of the alternate unit.

getStandardUnit

public final Unit<? super Q> getStandardUnit()
Description copied from class: Unit
Returns the base unit, alternate unit or product of base units and alternate units this unit is derived from. The standard unit identifies the "type" of quantity for which this unit is employed. For example:
    boolean isAngularVelocity(Unit<?> u) {
       return u.getStandardUnit().equals(RADIAN.divide(SECOND));
    }
    assert(REVOLUTION.divide(MINUTE).isAngularVelocity());  
 

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

Specified by:
getStandardUnit in class Unit<Q extends Quantity>
Returns:
the system unit this unit is derived from.

toStandardUnit

public final UnitConverter toStandardUnit()
Description copied from class: Unit
Returns the converter from this unit to its system unit.

Specified by:
toStandardUnit in class Unit<Q extends Quantity>
Returns:
this.getConverterTo(this.getSystemUnit())

equals

public boolean equals(java.lang.Object that)
Indicates if this alternate unit is considered equals to the specified object (both are alternate units with equal symbol, equal base units and equal converter to base units).

Specified by:
equals in class Unit<Q extends Quantity>
Parameters:
that - the object to compare for equality.
Returns:
true if this and that are considered equals; falseotherwise.

hashCode

public int hashCode()
Description copied from class: Unit
Returns the hash code for this unit.

Specified by:
hashCode in class Unit<Q extends Quantity>
Returns:
this unit hashcode value.

JScience v4.3

Copyright © 2006 JScience.