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

java.lang.Object
  javax.measure.unit.Unit<Q>
      javax.measure.unit.BaseUnit<Q>

All Implemented Interfaces:

java.io.Serializable

public class BaseUnit<Q extends Quantity>
extends Unit<Q>

This class represents the building blocks on top of which all others units are created. Base units are typically dimensionally independent. Although, the actual unit dimension is determinate by the current model. Using the standard model, all seven SI base units are dimensionally independent.

This class defines the "standard base units" which includes SI base units and possibly others user-defined base units. It does not represent the base units of a specific SystemOfUnits.

Version:

1.0, April 15, 2009

Author:

Jean-Marie Dautelle

See Also:

Wikipedia: SI base unit, Serialized Form

Field Summary

Fields inherited from class javax.measure.unit.Unit

ONE

Constructor Summary

BaseUnit(java.lang.String symbol)
Creates a base unit having the specified symbol.

Method Summary

boolean	equals(java.lang.Object that) Indicates if the specified unit can be considered equals to the one specified.
UnitConverter	getConverterTo(Unit<Q> unit) Returns a converter of numeric values from this unit to another unit.
java.lang.String	getSymbol() Returns the unique symbol for this base unit.
int	hashCode() Returns the hash code for this unit.
Unit<Q>	toSI() Returns the standard unit from which this unit is derived.

Methods inherited from class javax.measure.unit.Unit

alternate, asType, compound, divide, divide, divide, getDimension, inverse, isCompatible, isSI, plus, pow, root, times, times, times, toString, transform, valueOf

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseUnit

public BaseUnit(java.lang.String symbol)

Creates a base unit having the specified symbol.

Parameters:

symbol - the symbol of this base unit.

Throws:

java.lang.IllegalArgumentException - if the specified symbol is associated to a different unit.

Method Detail

getSymbol

public final java.lang.String getSymbol()

Returns the unique symbol for this base unit.

Returns:

this base unit symbol.

equals

public boolean equals(java.lang.Object that)

Description copied from class: Unit

Indicates if the specified unit can be considered equals to the one specified.

Specified by:

equals in class Unit<Q extends Quantity>

Parameters:

that - the object to compare to.

Returns:

true if this unit is considered equal to that unit; false otherwise.

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.

toSI

public Unit<Q> toSI()

Description copied from class: Unit

Returns the standard unit from which this unit is derived. The SI unit identifies the "type" of quantity for which this unit is employed. For example:

     boolean isAngularVelocity(Unit<?> u) {
         return u.toSI().equals(RADIAN.divide(SECOND));
     }
     assert(REVOLUTION.divide(MINUTE).isAngularVelocity());
 

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

Specified by:

toSI in class Unit<Q extends Quantity>

Returns:

the system unit this unit is derived from.

getConverterTo

public final UnitConverter getConverterTo(Unit<Q> unit)

Description copied from class: Unit

Returns a converter of numeric values from this unit to another unit. As a minimum unit sub-classes should be able to provide a unit converter to their associated standard unit.

Overrides:

getConverterTo in class Unit<Q extends Quantity>

Parameters:

unit - the unit to which to convert the numeric values.

Returns:

the converter from this unit to that unit.