tec.uom.se.quantity

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

java.lang.Object

tec.uom.se.AbstractQuantity<Q>

tec.uom.se.quantity.NumberQuantity<Q>

Type Parameters:

Q - The type of the quantity.

All Implemented Interfaces:

Serializable, Comparable<javax.measure.Quantity<Q>>, javax.measure.Quantity<Q>, tec.uom.lib.common.function.UnitSupplier<Q>, tec.uom.lib.common.function.ValueSupplier<Number>, ComparableQuantity<Q>

public class NumberQuantity<Q extends javax.measure.Quantity<Q>>
extends AbstractQuantity<Q>
implements Serializable

An amount of quantity, implementation of ComparableQuantity that keep Number as possible otherwise converts to DecimalQuantity, this object is immutable.

Version:

1.0, $Date: 2016-10-02 $

Author:

otaviojava, Werner Keil

See Also:

AbstractQuantity, Quantity, ComparableQuantity, Serialized Form

Field Summary

Fields inherited from class tec.uom.se.AbstractQuantity

NONE, ONE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	NumberQuantity(Number number, javax.measure.Unit<Q> unit)

Method Summary

Modifier and Type	Method and Description
ComparableQuantity<Q>	add(javax.measure.Quantity<Q> that)
BigDecimal	decimalValue(javax.measure.Unit<Q> unit, MathContext ctx)
ComparableQuantity<Q>	divide(Number that)
ComparableQuantity<?>	divide(javax.measure.Quantity<?> that)
double	doubleValue(javax.measure.Unit<Q> unit)
Number	getValue() Returns the numeric value of the quantity.
ComparableQuantity<Q>	inverse()
boolean	isBig() Indicates if this measured amount is a big number, i.E.
ComparableQuantity<Q>	multiply(Number that)
ComparableQuantity<?>	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.
ComparableQuantity<Q>	subtract(javax.measure.Quantity<Q> that)

Methods inherited from class tec.uom.se.AbstractQuantity

asType, compareTo, divide, equals, equals, floatValue, getUnit, hashCode, intValue, inverse, isEquivalentTo, isGreaterThan, isGreaterThanOrEqualTo, isLessThan, isLessThanOrEqualTo, longValue, multiply, parse, to, to, toSI, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

NumberQuantity

protected NumberQuantity(Number number,
                         javax.measure.Unit<Q> unit)

Method Detail

doubleValue

public double doubleValue(javax.measure.Unit<Q> unit)

Specified by:

doubleValue in class AbstractQuantity<Q extends javax.measure.Quantity<Q>>

getValue

public Number getValue()

Description copied from class: AbstractQuantity

Returns the numeric value of the quantity.

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 quantity value.

isBig

public boolean isBig()

Indicates if this measured amount is a big number, i.E. BigDecimal or BigInteger. In all other cases this would be false.

Specified by:

isBig in class AbstractQuantity<Q extends javax.measure.Quantity<Q>>

Returns:

true if this quantity is big; false otherwise.

add

public ComparableQuantity<Q> add(javax.measure.Quantity<Q> that)

Specified by:

add in interface javax.measure.Quantity<Q extends javax.measure.Quantity<Q>>

Specified by:

add in interface ComparableQuantity<Q extends javax.measure.Quantity<Q>>

See Also:

Quantity.add(Quantity)

multiply

public ComparableQuantity<?> multiply(javax.measure.Quantity<?> that)

Specified by:

multiply in interface javax.measure.Quantity<Q extends javax.measure.Quantity<Q>>

Specified by:

multiply in interface ComparableQuantity<Q extends javax.measure.Quantity<Q>>

See Also:

Quantity.multiply(Quantity)

multiply

public ComparableQuantity<Q> multiply(Number that)

Specified by:

multiply in interface javax.measure.Quantity<Q extends javax.measure.Quantity<Q>>

Specified by:

multiply in interface ComparableQuantity<Q extends javax.measure.Quantity<Q>>

See Also:

Quantity.multiply(Number)

divide

public ComparableQuantity<?> divide(javax.measure.Quantity<?> that)

Specified by:

divide in interface javax.measure.Quantity<Q extends javax.measure.Quantity<Q>>

Specified by:

divide in interface ComparableQuantity<Q extends javax.measure.Quantity<Q>>

See Also:

Quantity.divide(Quantity)

divide

public ComparableQuantity<Q> divide(Number that)

Specified by:

divide in interface javax.measure.Quantity<Q extends javax.measure.Quantity<Q>>

Specified by:

divide in interface ComparableQuantity<Q extends javax.measure.Quantity<Q>>

See Also:

Quantity.divide(Number)

inverse

public ComparableQuantity<Q> inverse()

Specified by:

inverse in interface javax.measure.Quantity<Q extends javax.measure.Quantity<Q>>

Specified by:

inverse in interface ComparableQuantity<Q extends javax.measure.Quantity<Q>>

See Also:

Quantity.inverse()

decimalValue

public BigDecimal decimalValue(javax.measure.Unit<Q> unit,
                               MathContext ctx)
                        throws ArithmeticException

Specified by:

decimalValue in class AbstractQuantity<Q extends javax.measure.Quantity<Q>>

Throws:

ArithmeticException

subtract

public ComparableQuantity<Q> subtract(javax.measure.Quantity<Q> that)

Specified by:

subtract in interface javax.measure.Quantity<Q extends javax.measure.Quantity<Q>>

Specified by:

subtract in interface ComparableQuantity<Q extends javax.measure.Quantity<Q>>

See Also:

Quantity.subtract(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.