tech.units.indriya.quantity

Class Quantities

java.lang.Object

tech.units.indriya.quantity.Quantities

public final class Quantities
extends Object

Facade to access Quantity instances.

Since:

1.0

Version:

2.3, February 14, 2021

Author:

Werner Keil, Otavio Santana

Method Summary

Modifier and Type	Method and Description
static <Q extends javax.measure.Quantity<Q>> CompoundQuantity<Q>	getCompoundQuantity(Number[] values, javax.measure.Unit<Q>[] units) Deprecated. use getMixedQuantity(Number[], Unit[])
static <Q extends javax.measure.Quantity<Q>> CompoundQuantity<Q>	getCompoundQuantity(Number[] values, javax.measure.Unit<Q>[] units, javax.measure.Quantity.Scale scale) Deprecated. use #getMixedQuantity(Number[], Unit[], Scale)
static <Q extends javax.measure.Quantity<Q>> MixedQuantity<Q>	getMixedQuantity(Number[] values, javax.measure.Unit<Q>[] units) Returns the mixed radix values and units as MixedQuantity in the ABSOLUTE scale.
static <Q extends javax.measure.Quantity<Q>> MixedQuantity<Q>	getMixedQuantity(Number[] values, javax.measure.Unit<Q>[] units, javax.measure.Quantity.Scale scale) Returns the mixed radix values and units as MixedQuantity in the specified scale.
static javax.measure.Quantity<?>	getQuantity(CharSequence csq) Returns the scalar quantity of unknown type corresponding to the specified representation.
static <Q extends javax.measure.Quantity<Q>> javax.measure.Quantity<Q>	getQuantity(Number[] values, javax.measure.Unit<Q>... units) Returns the mixed radix values and units combined into a single quantity in the ABSOLUTE scale.
static <Q extends javax.measure.Quantity<Q>> javax.measure.Quantity<Q>	getQuantity(Number[] values, javax.measure.Unit<Q>[] units, javax.measure.Quantity.Scale scale) Returns the mixed radix values and units combined into a single quantity.
static <Q extends javax.measure.Quantity<Q>> ComparableQuantity<Q>	getQuantity(Number value, javax.measure.Unit<Q> unit) Returns the scalar quantity.
static <Q extends javax.measure.Quantity<Q>> ComparableQuantity<Q>	getQuantity(Number value, javax.measure.Unit<Q> unit, javax.measure.Quantity.Scale scale) Returns the scalar quantity.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getQuantity

public static javax.measure.Quantity<?> getQuantity(CharSequence csq)

Returns the scalar quantity of unknown type corresponding to the specified representation. This method can be used to parse mixed quantities. All of these expressions:
Quantity<Length> height = Quantities.getQuantity("1.70 m").asType(Length.class);
Quantity<Length> heightinCm = Quantities.getQuantity("170 cm").asType(Length.class);
Quantity<Length> heightMixed = Quantities.getQuantity("1 m 70 cm").asType(Length.class); are equally supported.

Note: This method handles only Locale-neutral quantity formatting and parsing are handled by the SimpleQuantityFormat class.
Due to the versatile parsing of this method recognizing both single and mixed quantities, a unit must be provided, otherwise it'll fail. If you need to parse a unit-less quantity, please use the parse() method of AbstractQuantity instead.

Parameters:

csq - the decimal value(s) and unit(s) separated by space(s).

Returns:

SimpleQuantityFormat.getInstance("n u~ ").parse(csq)

Throws:

IllegalArgumentException - if no unit part was provided to parse

getQuantity

public static <Q extends javax.measure.Quantity<Q>> ComparableQuantity<Q> getQuantity(Number value,
                                                                                      javax.measure.Unit<Q> unit,
                                                                                      javax.measure.Quantity.Scale scale)

Returns the scalar quantity. When the Number was BigDecimal or BigInteger will uses DecimalQuantity, when the Number was Double will DoubleQuantity otherwise will NumberQuantity. in the specified unit.

Parameters:

value - the measurement value.

unit - the measurement unit.

scale - the measurement scale.

Returns:

the corresponding numeric quantity.

Throws:

NullPointerException - if value, unit or scale were null

Since:

2.0

getQuantity

public static <Q extends javax.measure.Quantity<Q>> ComparableQuantity<Q> getQuantity(Number value,
                                                                                      javax.measure.Unit<Q> unit)

Returns the scalar quantity. When the Number was BigDecimal or BigInteger will uses DecimalQuantity, when the Number was Double will DoubleQuantity otherwise will NumberQuantity. in the specified unit.

Parameters:

value - the measurement value.

unit - the measurement unit.

Returns:

the corresponding numeric quantity.

Throws:

NullPointerException - when value or unit were null

getQuantity

public static <Q extends javax.measure.Quantity<Q>> javax.measure.Quantity<Q> getQuantity(Number[] values,
                                                                                          javax.measure.Unit<Q>[] units,
                                                                                          javax.measure.Quantity.Scale scale)

Returns the mixed radix values and units combined into a single quantity. When the Number was BigDecimal or BigInteger will uses DecimalQuantity, when the Number was Double will DoubleQuantity otherwise will NumberQuantity. in the specified unit.

Parameters:

values - the measurement values.

units - the measurement units.

scale - the measurement scale.

Returns:

the corresponding quantity.

Throws:

NullPointerException - if values or scale were null

IllegalArgumentException - if the size of the values array does not match that of units.

Since:

2.0

getQuantity

@SafeVarargs
public static <Q extends javax.measure.Quantity<Q>> javax.measure.Quantity<Q> getQuantity(Number[] values,
                                                                                                        javax.measure.Unit<Q>... units)

Returns the mixed radix values and units combined into a single quantity in the ABSOLUTE scale.

Parameters:

values - the measurement values.

units - the measurement units.

Returns:

the corresponding quantity.

Throws:

NullPointerException - if values or units were null

IllegalArgumentException - if the size of the values array does not match that of units.

Since:

2.0

getMixedQuantity

public static <Q extends javax.measure.Quantity<Q>> MixedQuantity<Q> getMixedQuantity(Number[] values,
                                                                                      javax.measure.Unit<Q>[] units,
                                                                                      javax.measure.Quantity.Scale scale)

Returns the mixed radix values and units as MixedQuantity in the specified scale.

Parameters:

values - the measurement values.

units - the measurement units.

scale - the measurement scale.

Returns:

the corresponding mixed quantity.

Throws:

NullPointerException - if values, units or scale were null

IllegalArgumentException - if the size of the values array does not match that of units.

Since:

2.1.2

getMixedQuantity

public static <Q extends javax.measure.Quantity<Q>> MixedQuantity<Q> getMixedQuantity(Number[] values,
                                                                                      javax.measure.Unit<Q>[] units)

Returns the mixed radix values and units as MixedQuantity in the ABSOLUTE scale.

Parameters:

values - the measurement values.

units - the measurement units.

Returns:

the corresponding mixed quantity.

Throws:

NullPointerException - if values, units or scale were null

IllegalArgumentException - if the size of the values array does not match that of units.

Since:

2.1.2

getCompoundQuantity

public static <Q extends javax.measure.Quantity<Q>> CompoundQuantity<Q> getCompoundQuantity(Number[] values,
                                                                                            javax.measure.Unit<Q>[] units,
                                                                                            javax.measure.Quantity.Scale scale)

Deprecated. use #getMixedQuantity(Number[], Unit[], Scale)

Returns the mixed radix values and units as CompoundQuantity in the specified scale.

Parameters:

values - the measurement values.

units - the measurement units.

scale - the measurement scale.

Returns:

the corresponding compound quantity.

Throws:

NullPointerException - if values, units or scale were null

IllegalArgumentException - if the size of the values array does not match that of units.

Since:

2.0

getCompoundQuantity

public static <Q extends javax.measure.Quantity<Q>> CompoundQuantity<Q> getCompoundQuantity(Number[] values,
                                                                                            javax.measure.Unit<Q>[] units)

Deprecated. use getMixedQuantity(Number[], Unit[])

Returns the mixed radix values and units as CompoundQuantity in the ABSOLUTE scale.

Parameters:

values - the measurement values.

units - the measurement units.

Returns:

the corresponding compound quantity.

Throws:

NullPointerException - if values, units or scale were null

IllegalArgumentException - if the size of the values array does not match that of units.

Since:

2.0