NumberQuantity (Units of Measurement Reference Implementation 1.0 API)

java.lang.Object
- tec.units.ri.AbstractQuantity<Q>
- - tec.units.ri.quantity.NumberQuantity<Q>

Type Parameters:
Q - The type of the quantity.

All Implemented Interfaces:

Comparable<javax.measure.Quantity<Q>>, javax.measure.Quantity<Q>, tec.uom.lib.common.function.UnitSupplier<Q>, tec.uom.lib.common.function.ValueSupplier<Number>
```
public class NumberQuantity<Q extends javax.measure.Quantity<Q>>
extends AbstractQuantity<Q>
```
An amount of quantity, consisting of a Number and a Unit. NumberQuantity objects are immutable.

Version:

0.13, $Date: 2016-06-21 $

Author:

Werner Keil

See Also:
AbstractQuantity, Quantity

Field Summary
- Fields inherited from class tec.units.ri.AbstractQuantity
  NONE, ONE

Constructor Summary

Constructors
Constructor and Description

NumberQuantity(Number number, javax.measure.Unit<Q> unit)
Holds the maximum value stated in this quantity's unit.

Constructors
Constructor and Description
`NumberQuantity(Number number, javax.measure.Unit<Q> unit)` Holds the maximum value stated in this quantity's unit.

Method Summary

Methods
Modifier and Type	Method and Description
`protected javax.measure.Quantity<Q>`	`add(AbstractQuantity<Q> that)`
`javax.measure.Quantity<Q>`	`add(javax.measure.Quantity<Q> that)`
`javax.measure.Quantity<Q>`	`divide(Number that)`
`javax.measure.Quantity<Q>`	`divide(javax.measure.Quantity<?> that)`
`double`	`doubleValue(javax.measure.Unit<Q> unit)`
`boolean`	`equals(Object obj)` Compares this measure against the specified object for strict equality (same unit and same amount).
`Number`	`getValue()` Returns the measurement numeric value.
`protected int`	`intValue(javax.measure.Unit<Q> unit)`
`javax.measure.Quantity<Q>`	`inverse()`
`boolean`	`isExact()` Indicates if this measured quantity is exact.
`javax.measure.Quantity<Q>`	`multiply(Number that)`
`javax.measure.Quantity<?>`	`multiply(javax.measure.Quantity<?> that)`
`static <Q extends javax.measure.Quantity<Q>> AbstractQuantity<Q>`	`of(double doubleValue, javax.measure.Unit<Q> unit)` Returns the scalar quantity for the specified `double` stated in the specified unit.
`static <Q extends javax.measure.Quantity<Q>> AbstractQuantity<Q>`	`of(float floatValue, javax.measure.Unit<Q> unit)` Returns the scalar quantity for the specified `float` stated in the specified unit.
`static <Q extends javax.measure.Quantity<Q>> AbstractQuantity<Q>`	`of(int intValue, javax.measure.Unit<Q> unit)` Returns the scalar quantity for the specified `int` stated in the specified unit.
`static <Q extends javax.measure.Quantity<Q>> AbstractQuantity<Q>`	`of(long longValue, javax.measure.Unit<Q> unit)` Returns the scalar quantity for the specified `long` stated in the specified unit.
`static <Q extends javax.measure.Quantity<Q>> AbstractQuantity<Q>`	`of(short value, javax.measure.Unit<Q> unit)` Returns the scalar quantity for the specified `short` stated in the specified unit.
`static javax.measure.Quantity<?>`	`parse(CharSequence csq)` Returns the decimal quantity of unknown type corresponding to the specified representation.
`javax.measure.Quantity<Q>`	`subtract(javax.measure.Quantity<Q> that)`
`String`	`toString()` Returns the `String` representation of this quantity.

Methods inherited from class tec.units.ri.AbstractQuantity
asType, compareTo, equals, floatValue, getUnit, hashCode, longValue, to, toSI

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

- Constructor Detail
  - NumberQuantity
```
public NumberQuantity(Number number,
              javax.measure.Unit<Q> unit)
```
    Holds the maximum value stated in this quantity's unit. For inexact measures: maximum > minimum
- Method Detail
  - equals
```
public boolean equals(Object obj)
```
    Description copied from class: AbstractQuantity
    
    Compares this measure against the specified object for strict equality (same unit and same amount).
    Similarly to the BigDecimal#equals method which consider 2.0 and 2.00 as different objects because of different internal scales, measurements such as Measure.valueOf(3.0, KILOGRAM) Measure.valueOf(3, KILOGRAM) and Quantities.getQuantity("3 kg") might not be considered equals because of possible differences in their implementations.
    
    To compare measures stated using different units or using different amount implementations the compareTo or equals(Measurement, epsilon, epsilonUnit) methods should be used.
    
    Overrides:
    
    equals in class AbstractQuantity<Q extends javax.measure.Quantity<Q>>
    
    Parameters:
    obj - the object to compare with.
    
    Returns:
    this.getUnit.equals(obj.getUnit()) && this.getValue().equals(obj.getValue())
  - doubleValue
```
public double doubleValue(javax.measure.Unit<Q> unit)
```
    Specified by:
    
    doubleValue in class AbstractQuantity<Q extends javax.measure.Quantity<Q>>
  - intValue
```
protected final int intValue(javax.measure.Unit<Q> unit)
                      throws ArithmeticException
```
    Throws:
    
    ArithmeticException
  - getValue
```
public Number getValue()
```
    Description copied from class: AbstractQuantity
    
    Returns the measurement numeric value.
    
    Specified by:
    
    getValue in interface javax.measure.Quantity<Q extends javax.measure.Quantity<Q>>
    
    Specified by:
    
    getValue in interface tec.uom.lib.common.function.ValueSupplier<Number>
    
    Specified by:
    
    getValue in class AbstractQuantity<Q extends javax.measure.Quantity<Q>>
    
    Returns:
    the measurement value.
  - isExact
```
public boolean isExact()
```
    Indicates if this measured quantity is exact. An exact quantity is guaranteed exact only when stated in this quantity's unit (e.g. this.longValue()); stating the quantity in any other unit may introduce conversion errors.
    
    Returns:
    true if this quantity is exact; false otherwise.
  - add
```
protected javax.measure.Quantity<Q> add(AbstractQuantity<Q> that)
```
  - toString
```
public String toString()
```
    Description copied from class: AbstractQuantity
    
    Returns the String representation of this quantity. The string produced for a given quantity is always the same; it is not affected by locale. This means that it can be used as a canonical string representation for exchanging quantity, or as a key for a Hashtable, etc. Locale-sensitive quantity formatting and parsing is handled by the QuantityFormat class and its subclasses.
    
    Overrides:
    
    toString in class AbstractQuantity<Q extends javax.measure.Quantity<Q>>
    
    Returns:
    UnitFormat.getInternational().format(this)
  - multiply
```
public javax.measure.Quantity<?> multiply(javax.measure.Quantity<?> that)
```
  - multiply
```
public javax.measure.Quantity<Q> multiply(Number that)
```
  - divide
```
public javax.measure.Quantity<Q> divide(javax.measure.Quantity<?> that)
```
  - divide
```
public javax.measure.Quantity<Q> divide(Number that)
```
  - inverse
```
public javax.measure.Quantity<Q> inverse()
```
  - subtract
```
public javax.measure.Quantity<Q> subtract(javax.measure.Quantity<Q> that)
```
  - add
```
public javax.measure.Quantity<Q> add(javax.measure.Quantity<Q> that)
```
  - of
```
public static <Q extends javax.measure.Quantity<Q>> AbstractQuantity<Q> of(long longValue,
                                                           javax.measure.Unit<Q> unit)
```
    Returns the scalar quantity for the specified long stated in the specified unit.
    
    Parameters:
    longValue - the quantity value.
    unit - the measurement unit.
    
    Returns:
    the corresponding int quantity.
  - of
```
public static <Q extends javax.measure.Quantity<Q>> AbstractQuantity<Q> of(int intValue,
                                                           javax.measure.Unit<Q> unit)
```
    Returns the scalar quantity for the specified int stated in the specified unit.
    
    Parameters:
    intValue - the quantity value.
    unit - the measurement unit.
    
    Returns:
    the corresponding int quantity.
  - of
```
public static <Q extends javax.measure.Quantity<Q>> AbstractQuantity<Q> of(short value,
                                                           javax.measure.Unit<Q> unit)
```
    Returns the scalar quantity for the specified short stated in the specified unit.
    
    Parameters:
    value - the quantity value.
    unit - the measurement unit.
    
    Returns:
    the corresponding short quantity.
  - of
```
public static <Q extends javax.measure.Quantity<Q>> AbstractQuantity<Q> of(float floatValue,
                                                           javax.measure.Unit<Q> unit)
```
    Returns the scalar quantity for the specified float stated in the specified unit.
    
    Parameters:
    floatValue - the measurement value.
    unit - the measurement unit.
    
    Returns:
    the corresponding float quantity.
  - of
```
public static <Q extends javax.measure.Quantity<Q>> AbstractQuantity<Q> of(double doubleValue,
                                                           javax.measure.Unit<Q> unit)
```
    Returns the scalar quantity for the specified double stated in the specified unit.
    
    Parameters:
    doubleValue - the measurement value.
    unit - the measurement unit.
    
    Returns:
    the corresponding double quantity.
  - parse
```
public static javax.measure.Quantity<?> parse(CharSequence csq)
```
    Returns the decimal quantity of unknown type corresponding to the specified representation. This method can be used to parse dimensionless quantities.
    Quatity proportion = AbstractQuantity.of("0.234").asType(Dimensionless.class);
    Note: This method handles only standard unit format (UCUM based). Locale-sensitive quantity formatting and parsing are handled by the MeasurementFormat class and its subclasses.
    
    Parameters:
    csq - the decimal value and its unit (if any) separated by space(s).
    
    Returns:
    QuantityFormat.getInstance().parse(csq)

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

Field Summary

Fields inherited from class tec.units.ri.AbstractQuantity

Constructor Summary

Method Summary

Methods inherited from class tec.units.ri.AbstractQuantity

Methods inherited from class java.lang.Object

Constructor Detail

NumberQuantity

Method Detail

equals

doubleValue

intValue

getValue

isExact

add

toString

multiply

multiply

divide

divide

inverse

subtract

add

of

of

of

of

of

parse