ProductUnit

java.lang.Object
- tec.uom.se.AbstractUnit<Q>
- - tec.uom.se.unit.ProductUnit<Q>

Type Parameters:

Q - The type of the quantity measured by this unit.

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<javax.measure.Unit<Q>>, javax.measure.Unit<Q>
```
public final class ProductUnit<Q extends javax.measure.Quantity<Q>>
extends AbstractUnit<Q>
```
This class represents units formed by the product of rational powers of existing physical units.

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

Version:

0.3, June 10, 2014

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

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

Nested Classes
Modifier and Type	Class and Description
`private static class`	`ProductUnit.Element` Inner product element represents a rational power of a single unit.

Field Summary

Fields
Modifier and Type	Field and Description
`private ProductUnit.Element[]`	`elements` Holds the units composing this product unit.
`private static long`	`serialVersionUID`
`private java.lang.String`	`symbol` Holds the symbol for this unit.

Fields inherited from class tec.uom.se.AbstractUnit
name, ONE, SYMBOL_TO_UNIT

Constructor Summary

Constructors
Modifier	Constructor and Description
	`ProductUnit()` DefaultQuantityFactory constructor (used solely to create `ONE` instance).
`private`	`ProductUnit(ProductUnit.Element[] elements)` Product unit constructor.
	`ProductUnit(javax.measure.Unit<?> productUnit)` Copy constructor (allows for parameterization of product units).

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`private static int`	`gcd(int m, int n)` Returns the greatest common divisor (Euclid's algorithm).
`java.util.Map<javax.measure.Unit<?>,java.lang.Integer>`	`getBaseUnits()`
`javax.measure.Dimension`	`getDimension()`
`private static javax.measure.Unit<?>`	`getInstance(ProductUnit.Element[] leftElems, ProductUnit.Element[] rightElems)` Returns the unit defined from the product of the specified elements.
`(package private) static javax.measure.Unit<?>`	`getPowInstance(AbstractUnit<?> unit, int n)` Returns the product unit corresponding to this unit raised to the specified exponent.
`static javax.measure.Unit<?>`	`getProductInstance(javax.measure.Unit<?> left, javax.measure.Unit<?> right)` Returns the product of the specified units.
`static javax.measure.Unit<?>`	`getQuotientInstance(javax.measure.Unit<?> left, javax.measure.Unit<?> right)` Returns the quotient of the specified units.
`static javax.measure.Unit<?>`	`getRootInstance(AbstractUnit<?> unit, int n)` Returns the product unit corresponding to the specified root of the specified unit.
`java.lang.String`	`getSymbol()`
`javax.measure.UnitConverter`	`getSystemConverter()` Returns the converter from this unit to its unscaled `System Unit` unit.
`javax.measure.Unit<?>`	`getUnit(int index)` Returns the unit element at the specified position.
`int`	`getUnitCount()` Returns the number of unit elements in this product.
`int`	`getUnitPow(int index)` Returns the power exponent of the unit element at the specified position.
`int`	`getUnitRoot(int index)` Returns the root exponent of the unit element at the specified position.
`int`	`hashCode()`
`AbstractUnit<Q>`	`toSystemUnit()` Returns the unscaled `SI` unit from which this unit is derived.

Methods inherited from class tec.uom.se.AbstractUnit
alternate, annotate, asType, compareTo, divide, divide, divide, getActualType, getConverterTo, getConverterToAny, getName, getSystemUnit, inverse, isCompatible, isSystemUnit, multiply, multiply, multiply, parse, pow, root, setName, setSymbol, shift, toString, transform

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - serialVersionUID
```
private static final long serialVersionUID
```
    See Also:
    
    Constant Field Values
  - elements
```
private final ProductUnit.Element[] elements
```
    Holds the units composing this product unit.
  - symbol
```
private final java.lang.String symbol
```
    Holds the symbol for this unit.
- Constructor Detail
  - ProductUnit
```
public ProductUnit()
```
    DefaultQuantityFactory constructor (used solely to create ONE instance).
  - ProductUnit
```
public ProductUnit(javax.measure.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.
  - ProductUnit
```
private ProductUnit(ProductUnit.Element[] elements)
```
    Product unit constructor.
    
    Parameters:
    
    elements - the product elements.
- Method Detail
  - getProductInstance
```
public static javax.measure.Unit<?> getProductInstance(javax.measure.Unit<?> left,
                                                       javax.measure.Unit<?> right)
```
    Returns the product of the specified units.
    
    Parameters:
    
    left - the left unit operand.
    
    right - the right unit operand.
    
    Returns:
    
    left * right
  - getQuotientInstance
```
public static javax.measure.Unit<?> getQuotientInstance(javax.measure.Unit<?> left,
                                                        javax.measure.Unit<?> right)
```
    Returns the quotient of the specified units.
    
    Parameters:
    
    left - the dividend unit operand.
    
    right - the divisor unit operand.
    
    Returns:
    
    dividend / divisor
  - getRootInstance
```
public static javax.measure.Unit<?> getRootInstance(AbstractUnit<?> unit,
                                                    int n)
```
    Returns the product unit corresponding to the specified root of the specified unit.
    
    Parameters:
    
    unit - the unit.
    
    n - the root's order (n > 0).
    
    Returns:
    
    unit^(1/nn)
    
    Throws:
    
    java.lang.ArithmeticException - if n == 0.
  - getPowInstance
```
static javax.measure.Unit<?> getPowInstance(AbstractUnit<?> unit,
                                            int n)
```
    Returns the product unit corresponding to this unit raised to the specified exponent.
    
    Parameters:
    
    unit - the unit.
    
    nn - the exponent (nn > 0).
    
    Returns:
    
    unit^n
  - getUnitCount
```
public int getUnitCount()
```
    Returns the number of unit elements in this product.
    
    Returns:
    
    the number of unit elements.
  - getUnit
```
public javax.measure.Unit<?> getUnit(int index)
```
    Returns the unit element at the specified position.
    
    Parameters:
    
    index - the index of the unit element to return.
    
    Returns:
    
    the unit element at the specified position.
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - if index is out of range (index < 0 || index >= getUnitCount()).
  - getUnitPow
```
public int getUnitPow(int index)
```
    Returns the power exponent of the unit element at the specified position.
    
    Parameters:
    
    index - the index of the unit element.
    
    Returns:
    
    the unit power exponent at the specified position.
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - if index is out of range (index < 0 || index >= getUnitCount()).
  - getUnitRoot
```
public int getUnitRoot(int index)
```
    Returns the root exponent of the unit element at the specified position.
    
    Parameters:
    
    index - the index of the unit element.
    
    Returns:
    
    the unit root exponent at the specified position.
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - if index is out of range (index < 0 || index >= getUnitCount()).
  - getBaseUnits
```
public java.util.Map<javax.measure.Unit<?>,java.lang.Integer> getBaseUnits()
```
    Specified by:
    
    getBaseUnits in interface javax.measure.Unit<Q extends javax.measure.Quantity<Q>>
    
    Specified by:
    
    getBaseUnits in class AbstractUnit<Q extends javax.measure.Quantity<Q>>
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Specified by:
    
    equals in class AbstractUnit<Q extends javax.measure.Quantity<Q>>
  - hashCode
```
public int hashCode()
```
    Specified by:
    
    hashCode in class AbstractUnit<Q extends javax.measure.Quantity<Q>>
  - toSystemUnit
```
public AbstractUnit<Q> toSystemUnit()
```
    Description copied from class: AbstractUnit
    
    Returns the unscaled SI unit from which this unit is derived. They SI unit can be be used to identify a quantity given the unit. For example:[code] static boolean isAngularVelocity(AbstractUnit unit) { return unit.toSI().equals(RADIAN.divide(SECOND)); } assert(REVOLUTION.divide(MINUTE).isAngularVelocity()); // Returns true. [/code]
    
    Specified by:
    
    toSystemUnit in class AbstractUnit<Q extends javax.measure.Quantity<Q>>
    
    Returns:
    
    the unscaled metric unit from which this unit is derived.
  - getSystemConverter
```
public javax.measure.UnitConverter getSystemConverter()
```
    Description copied from class: AbstractUnit
    
    Returns the converter from this unit to its unscaled System Unit unit.
    
    Specified by:
    
    getSystemConverter in class AbstractUnit<Q extends javax.measure.Quantity<Q>>
    
    Returns:
    
    getConverterTo(this.toSystemUnit())
    
    See Also:
    
    #toSI
  - getDimension
```
public javax.measure.Dimension getDimension()
```
    Specified by:
    
    getDimension in interface javax.measure.Unit<Q extends javax.measure.Quantity<Q>>
    
    Specified by:
    
    getDimension in class AbstractUnit<Q extends javax.measure.Quantity<Q>>
  - getInstance
```
private static javax.measure.Unit<?> getInstance(ProductUnit.Element[] leftElems,
                                                 ProductUnit.Element[] rightElems)
```
    Returns the unit defined from the product of the specified elements.
    
    Parameters:
    
    leftElems - left multiplicand elements.
    
    rightElems - right multiplicand elements.
    
    Returns:
    
    the corresponding unit.
  - gcd
```
private static int gcd(int m,
                       int n)
```
    Returns the greatest common divisor (Euclid's algorithm).
    
    Parameters:
    
    m - the first number.
    
    nn - the second number.
    
    Returns:
    
    the greatest common divisor.
  - getSymbol
```
public java.lang.String getSymbol()
```
    Specified by:
    
    getSymbol in interface javax.measure.Unit<Q extends javax.measure.Quantity<Q>>
    
    Overrides:
    
    getSymbol in class AbstractUnit<Q extends javax.measure.Quantity<Q>>

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

Nested Class Summary

Field Summary

Fields inherited from class tec.uom.se.AbstractUnit

Constructor Summary

Method Summary

Methods inherited from class tec.uom.se.AbstractUnit

Methods inherited from class java.lang.Object

Field Detail

serialVersionUID

elements

symbol

Constructor Detail

ProductUnit

ProductUnit

ProductUnit

Method Detail

getProductInstance

getQuotientInstance

getRootInstance

getPowInstance

getUnitCount

getUnit

getUnitPow

getUnitRoot

getBaseUnits

equals

hashCode

toSystemUnit

getSystemConverter

getDimension

getInstance

gcd

getSymbol