Package tech.units.indriya.quantity
Class NumberQuantity<Q extends javax.measure.Quantity<Q>>
java.lang.Object
tech.units.indriya.AbstractQuantity<Q>
tech.units.indriya.quantity.NumberQuantity<Q>
- Type Parameters:
Q
- The type of the quantity.
- All Implemented Interfaces:
Serializable
,Comparable<javax.measure.Quantity<Q>>
,javax.measure.Quantity<Q>
,ComparableQuantity<Q>
,tech.uom.lib.common.function.QuantityConverter<Q>
,tech.uom.lib.common.function.UnitSupplier<Q>
,tech.uom.lib.common.function.ValueSupplier<Number>
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.- Since:
- 1.0
- Version:
- 1.0.1, $Date: 2017-05-28 $
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class tech.units.indriya.AbstractQuantity
AbstractQuantity.Equalizer
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final boolean
Indicates if this quantity is big.private static final long
private final Number
Fields inherited from class tech.units.indriya.AbstractQuantity
NONE, ONE
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
NumberQuantity
(Number number, javax.measure.Unit<Q> unit) -
Method Summary
Modifier and TypeMethodDescriptiondecimalValue
(javax.measure.Unit<Q> unit) divide
(javax.measure.Quantity<?> that) double
doubleValue
(javax.measure.Unit<Q> unit) boolean
Compares this quantity against the specified object for strict equality (same unit and same amount).getValue()
Returns the numeric value of the quantity.inverse()
boolean
isBig()
Indicates if this measured amount is a big number, i.E.multiply
(javax.measure.Quantity<?> that) static <Q extends javax.measure.Quantity<Q>>
AbstractQuantity<Q>of
(byte value, javax.measure.Unit<Q> unit) Returns the scalar quantity for the specifiedbyte
stated in the specified unit.static <Q extends javax.measure.Quantity<Q>>
AbstractQuantity<Q>of
(double doubleValue, javax.measure.Unit<Q> unit) Returns the scalar quantity for the specifieddouble
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 specifiedfloat
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 specifiedint
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 specifiedlong
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 specifiedshort
stated in the specified unit.private DecimalQuantity<Q>
Methods inherited from class tech.units.indriya.AbstractQuantity
asType, compareTo, divide, equals, floatValue, getUnit, hasFraction, hasFraction, hashCode, intValue, inverse, isEquivalentOf, isGreaterThan, isGreaterThanOrEqualTo, isLessThan, isLessThanOrEqualTo, longValue, multiply, parse, to, toString
-
Field Details
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
value
-
isBig
private final boolean isBigIndicates if this quantity is big.
-
-
Constructor Details
-
NumberQuantity
-
-
Method Details
-
doubleValue
- Specified by:
doubleValue
in classAbstractQuantity<Q extends javax.measure.Quantity<Q>>
-
getValue
Description copied from class:AbstractQuantity
Returns the numeric value of the quantity.- Specified by:
getValue
in interfacejavax.measure.Quantity<Q extends javax.measure.Quantity<Q>>
- Specified by:
getValue
in interfacetech.uom.lib.common.function.ValueSupplier<Q extends javax.measure.Quantity<Q>>
- Specified by:
getValue
in classAbstractQuantity<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 classAbstractQuantity<Q extends javax.measure.Quantity<Q>>
- Returns:
true
if this quantity is big;false
otherwise.
-
add
-
multiply
-
multiply
-
divide
-
divide
-
inverse
-
decimalValue
- Specified by:
decimalValue
in classAbstractQuantity<Q extends javax.measure.Quantity<Q>>
- Throws:
ArithmeticException
-
subtract
-
toDecimalQuantity
-
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 specifiedlong
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 specifiedint
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 specifiedshort
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(byte value, javax.measure.Unit<Q> unit) Returns the scalar quantity for the specifiedbyte
stated in the specified unit.- Parameters:
value
- the quantity value.unit
- the measurement unit.- Returns:
- the corresponding
byte
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 specifiedfloat
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 specifieddouble
stated in the specified unit.- Parameters:
doubleValue
- the measurement value.unit
- the measurement unit.- Returns:
- the corresponding
double
quantity.
-
equals
Description copied from class:AbstractQuantity
Compares this quantity against the specified object for strict equality (same unit and same amount).Similarly to the
BigDecimal.equals(java.lang.Object)
method which consider 2.0 and 2.00 as different objects because of different internal scales, quantities such asQuantities.getQuantity(3.0, KILOGRAM)
Quantities.getQuantity(3, KILOGRAM)
andQuantities.getQuantity("3 kg")
might not be considered equals because of possible differences in their implementations.To compare quantities stated using different units or using different amount implementations the
compareTo
orequals(Quantity, epsilon, epsilonUnit)
methods should be used.- Overrides:
equals
in classAbstractQuantity<Q extends javax.measure.Quantity<Q>>
- Parameters:
obj
- the object to compare with.- Returns:
this.getUnit.equals(obj.getUnit()) && this.getValue().equals(obj.getValue())
-