org.jscience.physics.units
Class ProductUnit<Q extends Quantity>

java.lang.Object
  org.jscience.physics.units.Unit<Q>
      org.jscience.physics.units.DerivedUnit<Q>
          org.jscience.physics.units.ProductUnit<Q>

All Implemented Interfaces:

java.io.Serializable

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

This class represents a product unit. Product units are 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: METER.pow(2).divide(METER) returns METER.

Version:

1.1, May 24, 2005

Author:

Jean-Marie Dautelle

See Also:

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

Nested Class Summary

static class

ProductUnit.Element Inner product element represents a rational power of a single unit.

Field Summary

Fields inherited from class org.jscience.physics.units.Unit

ONE

Method Summary

protected boolean	equalsImpl(java.lang.Object that) Indicates if the specified unit can be considered equals to the one specified (for unicity purpose).
ProductUnit.Element	get(int index) Returns the product element at the specified position.
protected Unit<Q>	getParentUnitImpl() Returns the parent units this unit is derived from.
protected int	hashCodeImpl() Returns the hash code for this unit (calculated only once as units are unique).
int	size() Returns the number of units in this product.
protected Converter	toParentUnitImpl() Returns the converter to the parent unit.

Methods inherited from class org.jscience.physics.units.Unit

alias, alternate, compound, divide, equals, getBaseUnits, getConverterTo, getDimension, getInstance, getInstances, getParentUnit, hashCode, inverse, isCompatible, label, plus, pow, readResolve, root, times, times, toBaseUnits, toParentUnit, toString, toText, transform, valueOf

Methods inherited from class java.lang.Object

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

Method Detail

size

public int size()

Returns the number of units in this product.

Returns:

the number of units being multiplied.

get

public ProductUnit.Element get(int index)

Returns the product element at the specified position.

Parameters:

index - the index of the element to return.

Returns:

the element at the specified position.

Throws:

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

equalsImpl

protected boolean equalsImpl(java.lang.Object that)

Description copied from class: Unit

Indicates if the specified unit can be considered equals to the one specified (for unicity purpose).

Specified by:

equalsImpl in class Unit<Q extends Quantity>

Returns:

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

hashCodeImpl

protected int hashCodeImpl()

Description copied from class: Unit

Returns the hash code for this unit (calculated only once as units are unique).

Specified by:

hashCodeImpl in class Unit<Q extends Quantity>

Returns:

this unit hashcode value.

getParentUnitImpl

protected Unit<Q> getParentUnitImpl()

Description copied from class: Unit

Returns the parent units this unit is derived from.

Specified by:

getParentUnitImpl in class Unit<Q extends Quantity>

Returns:

the parent unit or this if this unit is a base unit or a product of base units.

toParentUnitImpl

protected Converter toParentUnitImpl()

Description copied from class: Unit

Returns the converter to the parent unit.

Specified by:

toParentUnitImpl in class Unit<Q extends Quantity>

Returns:

the converter to Unit.getParentUnitImpl()