Package tech.units.indriya.quantity

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

java.lang.Object

tech.units.indriya.quantity.CompoundQuantity<Q>

Type Parameters:

Q - The type of the quantity.

All Implemented Interfaces:

Serializable, tech.uom.lib.common.function.QuantityConverter<Q>

public class CompoundQuantity<Q extends javax.measure.Quantity<Q>>
extends Object
implements tech.uom.lib.common.function.QuantityConverter<Q>, Serializable

This class represents multi-radix quantities (like "1 hour, 5 min, 30 sec" or "6 ft, 3 in").

Version:

1.6, June 25, 2019

Author:

Werner Keil, Andi Huber

See Also:

Free Dictionary: Compound Quantity, Your Dictionary: Compound Number, Serialized Form

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CompoundQuantity(List<javax.measure.Quantity<Q>> quantities)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)	Indicates if this mixed quantity is considered equal to the specified object (both are mixed units with same composing units in the same order).
List<javax.measure.Quantity<Q>>	getQuantities()	Gets quantities in this CompoundQuantity.
List<javax.measure.Unit<Q>>	getUnits()	Gets the list of units in this CompoundQuantity.
int	hashCode()
static <Q extends javax.measure.Quantity<Q>> CompoundQuantity<Q>	of(List<javax.measure.Quantity<Q>> quantities)
static <Q extends javax.measure.Quantity<Q>> CompoundQuantity<Q>	of(javax.measure.Quantity<Q>... quantities)
javax.measure.Quantity<Q>	to(javax.measure.Unit<Q> unit)	Returns the sum of all quantity values in this CompoundQuantity converted into another (compatible) unit.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

CompoundQuantity

protected CompoundQuantity(List<javax.measure.Quantity<Q>> quantities)

Parameters:

quantities - - the list of quantities to construct this CompoundQuantity.

Method Detail

of

@SafeVarargs
public static <Q extends javax.measure.Quantity<Q>> CompoundQuantity<Q> of(javax.measure.Quantity<Q>... quantities)

Type Parameters:

Q -

Parameters:

quantities -

Returns:

a CompoundQuantity with the specified quantities

Throws:

IllegalArgumentException - if given quantities is null or empty or contains any null values or contains quantities of mixed scale

of

public static <Q extends javax.measure.Quantity<Q>> CompoundQuantity<Q> of(List<javax.measure.Quantity<Q>> quantities)

Type Parameters:

Q -

Parameters:

quantities -

Returns:

a CompoundQuantity with the specified quantities

Throws:

IllegalArgumentException - if given quantities is null or empty or contains any null values or contains quantities of mixed scale

getUnits

public List<javax.measure.Unit<Q>> getUnits()

Gets the list of units in this CompoundQuantity.

This list can be used in conjunction with getQuantities() to access the entire quantity.

Returns:

a list containing the units, not null

getQuantities

public List<javax.measure.Quantity<Q>> getQuantities()

Gets quantities in this CompoundQuantity.

Returns:

a list containing the quantities, not null

toString

public String toString()

Overrides:

toString in class Object

to

public javax.measure.Quantity<Q> to(javax.measure.Unit<Q> unit)

Returns the sum of all quantity values in this CompoundQuantity converted into another (compatible) unit.

Specified by:

to in interface tech.uom.lib.common.function.QuantityConverter<Q extends javax.measure.Quantity<Q>>

Parameters:

unit - the Unit unit in which the returned quantity is stated.

Returns:

the sum of all quantities in this CompoundQuantity or a new quantity stated in the specified unit.

Throws:

ArithmeticException - if the result is inexact and the quotient has a non-terminating decimal expansion.

equals

public boolean equals(Object obj)

Indicates if this mixed quantity is considered equal to the specified object (both are mixed units with same composing units in the same order).

Overrides:

equals in class Object

Parameters:

obj - the object to compare for equality.

Returns:

true if this and obj are considered equal; falseotherwise.

hashCode

public int hashCode()

Overrides:

hashCode in class Object