Package com.arpnetworking.metrics.mad.model

Class DefaultQuantity

java.lang.Object

com.arpnetworking.metrics.mad.model.DefaultQuantity

All Implemented Interfaces:

Quantity, Serializable, Comparable<Quantity>

public final class DefaultQuantity
extends Object
implements Quantity

Default sample implementation.

Author:

Brandon Arp (brandon dot arp at inscopemetrics dot io)

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	DefaultQuantity.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	divide(Quantity otherQuantity)	Divide this Quantity by the specified one returning the result.
boolean	equals(Object o)
Optional<Unit>	getUnit()	Access the Quantity Unit.
double	getValue()	Access the Quantity value.
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()

Methods inherited from class java.lang.Object

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

Method Details

getValue

public double getValue()

Description copied from interface: Quantity

Access the Quantity value.

Specified by:

getValue in interface Quantity

Returns:

the Quantity value

getUnit

public Optional<Unit> getUnit()

Description copied from interface: Quantity

Access the Quantity Unit.

Specified by:

getUnit in interface Quantity

Returns:

the Quantity Unit

add

public Quantity add(Quantity otherQuantity)

Description copied from interface: Quantity

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.

Specified by:

add in interface Quantity

Parameters:

otherQuantity - The other Quantity.

Returns:

The resulting sum Quantity.

subtract

public Quantity subtract(Quantity otherQuantity)

Description copied from interface: Quantity

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.

Specified by:

subtract in interface Quantity

Parameters:

otherQuantity - The other Quantity.

Returns:

The resulting difference Quantity.

multiply

public Quantity multiply(Quantity otherQuantity)

Description copied from interface: Quantity

Multiply this Quantity with the specified one returning the result.

Specified by:

multiply in interface Quantity

Parameters:

otherQuantity - The other Quantity.

Returns:

The resulting product Quantity.

divide

public Quantity divide(Quantity otherQuantity)

Description copied from interface: Quantity

Divide this Quantity by the specified one returning the result.

Specified by:

divide in interface Quantity

Parameters:

otherQuantity - The other Quantity.

Returns:

The resulting quotient Quantity.

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