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

java.lang.Object
  javax.measure.unit.Unit<Q>
      javax.measure.unit.DerivedUnit<Q>
          javax.measure.unit.ProductUnit<Q>

All Implemented Interfaces:

java.io.Serializable

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

This class represents units formed by the product of rational powers of existing units.

This class maintains the canonical form of this product (simplest form after factorization). For example: METRE.pow(2).divide(METRE) returns METRE.

Version:

1.0, April 15, 2009

Author:

Jean-Marie Dautelle

See Also:

Unit.times(Unit), Unit.divide(Unit), Unit.pow(int), Unit.root(int), Serialized Form

Field Summary

Fields inherited from class javax.measure.unit.Unit

ONE

Constructor Summary

ProductUnit(Unit<?> productUnit)
Copy constructor (allows for parameterization of product units).

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.
Unit<? extends Quantity>	getUnit(int index) Returns the unit at the specified position.
int	getUnitCount() Returns the number of units in this product.
int	getUnitPow(int index) Returns the power exponent of the unit at the specified position.
int	getUnitRoot(int index) Returns the root exponent of the unit at the specified position.
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

ProductUnit

public ProductUnit(Unit<?> productUnit)

Copy constructor (allows for parameterization of product units).

Parameters:

productUnit - the product unit source.

Throws:

java.lang.ClassCastException - if the specified unit is not a product unit.

Method Detail

getUnitCount

public int getUnitCount()

Returns the number of units in this product.

Returns:

the number of units being multiplied.

getUnit

public Unit<? extends Quantity> getUnit(int index)

Returns the unit at the specified position.

Parameters:

index - the index of the unit to return.

Returns:

the unit at the specified position.

Throws:

java.lang.IndexOutOfBoundsException - if index is out of range (index < 0 || index >= size()).

getUnitPow

public int getUnitPow(int index)

Returns the power exponent of the unit at the specified position.

Parameters:

index - the index of the unit to return.

Returns:

the unit power exponent at the specified position.

Throws:

java.lang.IndexOutOfBoundsException - if index is out of range (index < 0 || index >= size()).

getUnitRoot

public int getUnitRoot(int index)

Returns the root exponent of the unit at the specified position.

Parameters:

index - the index of the unit to return.

Returns:

the unit root exponent at the specified position.

Throws:

java.lang.IndexOutOfBoundsException - if index is out of range (index < 0 || index >= size()).

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.