Package com.arpnetworking.metrics.mad.model

Interface Quantity

All Superinterfaces:

Comparable<Quantity>, Serializable

All Known Implementing Classes:

DefaultQuantity

public interface Quantity
extends Comparable<Quantity>, Serializable

Represents a sample.

Author:

Brandon Arp (brandon dot arp at inscopemetrics dot io)

Method Summary

Modifier and Type	Method	Description
Quantity	add(Quantity otherQuantity)	Add this Quantity to the specified one returning the result.
Quantity	divide(Quantity otherQuantity)	Divide this Quantity by the specified one returning the result.
Optional<Unit>	getUnit()	Access the Quantity Unit.
double	getValue()	Access the Quantity value.
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.

Methods inherited from interface java.lang.Comparable

compareTo

Method Details

getValue

double getValue()

Access the Quantity value.

Returns:

the Quantity value

getUnit

Optional<Unit> getUnit()

Access the Quantity Unit.

Returns:

the Quantity Unit

add

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

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

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

Quantity divide(Quantity otherQuantity)

Divide this Quantity by the specified one returning the result.

Parameters:

otherQuantity - The other Quantity.

Returns:

The resulting quotient Quantity.