Package com.arpnetworking.tsdcore.model

Class Quantity

java.lang.Object

com.arpnetworking.tsdcore.model.Quantity

All Implemented Interfaces:

Serializable, Comparable<Quantity>

public final class Quantity
extends Object
implements Comparable<Quantity>, Serializable

Represents a sample.

Author:

Brandon Arp (brandon dot arp at inscopemetrics dot com)

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	Quantity.Builder	Builder implementation for Quantity.

Method Summary

Modifier and Type	Method	Description
Quantity	add(Quantity otherQuantity)	Add this Quantity to the specified one returning the result.
int	compareTo(Quantity other)
Quantity	convertTo(Unit unit)	Convert this Quantity to one in the specified unit.
Quantity	convertTo(Optional<Unit> unit)	Convert this Quantity to one in the specified optional unit.
Quantity	divide(Quantity otherQuantity)	Divide this Quantity by the specified one returning the result.
boolean	equals(Object o)
Optional<Unit>	getUnit()
double	getValue()
int	hashCode()
Quantity	multiply(Quantity otherQuantity)	Multiply this Quantity with the specified one returning the result.
Quantity	subtract(Quantity otherQuantity)	Subtract the specified Quantity from this one returning the result.
String	toString()
static List<Quantity>	unify(Collection<Quantity> quantities)	Ensures all Quantity instances have the same (including no) Unit.

Methods inherited from class java.lang.Object

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

Method Details

getValue

public double getValue()

getUnit

public Optional<Unit> getUnit()

add

public Quantity add(Quantity otherQuantity)

Add this Quantity to the specified one returning the result. Both Quantity instances must either not have a Unit or the Unit must be of the same type.

Parameters:

otherQuantity - The other Quantity.

Returns:

The resulting sum Quantity.

subtract

public Quantity subtract(Quantity otherQuantity)

Subtract the specified Quantity from this one returning the result. Both Quantity instances must either not have a Unit or the Unit must be of the same type.

Parameters:

otherQuantity - The other Quantity.

Returns:

The resulting difference Quantity.

multiply

public Quantity multiply(Quantity otherQuantity)

Multiply this Quantity with the specified one returning the result.

Parameters:

otherQuantity - The other Quantity.

Returns:

The resulting product Quantity.

divide

public Quantity divide(Quantity otherQuantity)

Divide this Quantity by the specified one returning the result.

Parameters:

otherQuantity - The other Quantity.

Returns:

The resulting quotient Quantity.

convertTo

public Quantity convertTo(Unit unit)

Convert this Quantity to one in the specified unit. This Quantity must also have a Unit and it must be in the same domain as the provided unit.

Parameters:

unit - Unit to convert to.

Returns:

Quantity in specified unit.

convertTo

public Quantity convertTo(Optional<Unit> unit)

Convert this Quantity to one in the specified optional unit. Either this Quantity also has a Unit in the same domain as the provided unit or both units are absent.

Parameters:

unit - Optional Unit to convert to.

Returns:

Quantity in specified unit.

compareTo

public int compareTo(Quantity other)

Specified by:

compareTo in interface Comparable<Quantity>

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

unify

public static List<Quantity> unify(Collection<Quantity> quantities)

Ensures all Quantity instances have the same (including no) Unit.

Parameters:

quantities - Quantity instances to convert.

Returns:

List of Quantity instances with the same Unit (or no Unit).