Package tech.units.indriya

Interface ComparableQuantity<Q extends javax.measure.Quantity<Q>>

Type Parameters:

Q -

All Superinterfaces:

Comparable<javax.measure.Quantity<Q>>, javax.measure.Quantity<Q>, tech.uom.lib.common.function.QuantityConverter<Q>, Serializable

All Known Implementing Classes:

AbstractQuantity, NumberQuantity, TemporalQuantity, TimeUnitQuantity

public interface ComparableQuantity<Q extends javax.measure.Quantity<Q>>
extends javax.measure.Quantity<Q>, Comparable<javax.measure.Quantity<Q>>, tech.uom.lib.common.function.QuantityConverter<Q>, Serializable

Quantity specialized for the Java SE platform. It extends Quantity with Comparable and Serializable

Since:

1.0

Version:

1.1, July 2, 2019

Author:

otaviojava, werner

Nested Class Summary

Nested classes/interfaces inherited from interface javax.measure.Quantity

javax.measure.Quantity.Scale

Method Summary

Modifier and Type	Method	Description
ComparableQuantity<Q>	add(javax.measure.Quantity<Q> that)
<T extends javax.measure.Quantity<T>> ComparableQuantity<T>	asType(Class<T> type)
ComparableQuantity<Q>	divide(Number that)
ComparableQuantity<?>	divide(javax.measure.Quantity<?> that)
<T extends javax.measure.Quantity<T>,E extends javax.measure.Quantity<E>> ComparableQuantity<E>	divide(javax.measure.Quantity<T> that, Class<E> asTypeQuantity)	Multiply and cast the ComparableQuantity
ComparableQuantity<?>	inverse()
<T extends javax.measure.Quantity<T>> ComparableQuantity<T>	inverse(Class<T> quantityClass)	invert and already cast to defined quantityClass
boolean	isEquivalentTo(javax.measure.Quantity<Q> that)	Compares two instances of Quantity <Q>, doing the conversion of unit if necessary.
boolean	isGreaterThan(javax.measure.Quantity<Q> that)	Compares two instances of .
boolean	isGreaterThanOrEqualTo(javax.measure.Quantity<Q> that)	Compares two instances of , doing the conversion of unit if necessary.
boolean	isLessThan(javax.measure.Quantity<Q> that)	Compares two instances of , doing the conversion of unit if necessary.
boolean	isLessThanOrEqualTo(javax.measure.Quantity<Q> that)	Compares two instances of , doing the conversion of unit if necessary.
ComparableQuantity<Q>	multiply(Number multiplier)
ComparableQuantity<?>	multiply(javax.measure.Quantity<?> multiplier)
<T extends javax.measure.Quantity<T>,E extends javax.measure.Quantity<E>> ComparableQuantity<E>	multiply(javax.measure.Quantity<T> that, Class<E> asTypeQuantity)	Divide and cast the ComparableQuantity
ComparableQuantity<Q>	subtract(javax.measure.Quantity<Q> that)
ComparableQuantity<Q>	to(javax.measure.Unit<Q> unit)

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface javax.measure.Quantity

getScale, getUnit, getValue, negate, toSystemUnit

Method Detail

add

ComparableQuantity<Q> add(javax.measure.Quantity<Q> that)

Specified by:

add in interface javax.measure.Quantity<Q extends javax.measure.Quantity<Q>>

See Also:

Quantity.add(Quantity)

subtract

ComparableQuantity<Q> subtract(javax.measure.Quantity<Q> that)

Specified by:

subtract in interface javax.measure.Quantity<Q extends javax.measure.Quantity<Q>>

See Also:

Quantity.subtract(Quantity)

divide

ComparableQuantity<?> divide(javax.measure.Quantity<?> that)

Specified by:

divide in interface javax.measure.Quantity<Q extends javax.measure.Quantity<Q>>

See Also:

Quantity.divide(Quantity)

divide

ComparableQuantity<Q> divide(Number that)

Specified by:

divide in interface javax.measure.Quantity<Q extends javax.measure.Quantity<Q>>

See Also:

Quantity.divide(Number)

multiply

ComparableQuantity<?> multiply(javax.measure.Quantity<?> multiplier)

Specified by:

multiply in interface javax.measure.Quantity<Q extends javax.measure.Quantity<Q>>

See Also:

Quantity.multiply(Quantity)

multiply

ComparableQuantity<Q> multiply(Number multiplier)

Specified by:

multiply in interface javax.measure.Quantity<Q extends javax.measure.Quantity<Q>>

See Also:

Quantity.multiply(Number)

inverse

ComparableQuantity<?> inverse()

Specified by:

inverse in interface javax.measure.Quantity<Q extends javax.measure.Quantity<Q>>

See Also:

Quantity.inverse()

inverse

<T extends javax.measure.Quantity<T>> ComparableQuantity<T> inverse(Class<T> quantityClass)

invert and already cast to defined quantityClass

Parameters:

quantityClass - Quantity to be converted

See Also:

Quantity.inverse(), Quantity.asType(Class)

to

ComparableQuantity<Q> to(javax.measure.Unit<Q> unit)

Specified by:

to in interface javax.measure.Quantity<Q extends javax.measure.Quantity<Q>>

Specified by:

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

See Also:

Quantity.to(Unit)

asType

<T extends javax.measure.Quantity<T>> ComparableQuantity<T> asType(Class<T> type)
                                                            throws ClassCastException

Specified by:

asType in interface javax.measure.Quantity<Q extends javax.measure.Quantity<Q>>

Throws:

ClassCastException

See Also:

Quantity.asType(Class)

isGreaterThan

boolean isGreaterThan(javax.measure.Quantity<Q> that)

Compares two instances of . Conversion of unit can happen if necessary

Parameters:

that - the quantity<Q> to be compared with this instance.

Returns:

true if that > this.

Throws:

NullPointerException - if the that is null

isGreaterThanOrEqualTo

boolean isGreaterThanOrEqualTo(javax.measure.Quantity<Q> that)

Compares two instances of , doing the conversion of unit if necessary.

Parameters:

that - the quantity<Q> to be compared with this instance.

Returns:

true if that >= this.

Throws:

NullPointerException - if the that is null

isLessThan

boolean isLessThan(javax.measure.Quantity<Q> that)

Compares two instances of , doing the conversion of unit if necessary.

Parameters:

that - the quantity<Q> to be compared with this instance.

Returns:

true if that < this.

Throws:

NullPointerException - if the quantity is null

isLessThanOrEqualTo

boolean isLessThanOrEqualTo(javax.measure.Quantity<Q> that)

Compares two instances of , doing the conversion of unit if necessary.

Parameters:

that - the quantity<Q> to be compared with this instance.

Returns:

true if that < this.

Throws:

NullPointerException - if the quantity is null

isEquivalentTo

boolean isEquivalentTo(javax.measure.Quantity<Q> that)

Compares two instances of Quantity <Q>, doing the conversion of unit if necessary.

Parameters:

that - the quantity<Q> to be compared with this instance.

Returns:

true if that < this.

Throws:

NullPointerException - if the quantity is null

See Also:

Cambridge Dictionary: equivalent, LEXICO: equivalent

divide

<T extends javax.measure.Quantity<T>,E extends javax.measure.Quantity<E>> ComparableQuantity<E> divide(javax.measure.Quantity<T> that,
                                                                                                             Class<E> asTypeQuantity)

Multiply and cast the ComparableQuantity

Parameters:

that - quantity to be multiplied

asTypeQuantity - quantity to be converted

Returns:

the QuantityOperations multiplied and converted

Throws:

NullPointerException

See Also:

Quantity.divide(Quantity), Quantity.asType(Class)

multiply

<T extends javax.measure.Quantity<T>,E extends javax.measure.Quantity<E>> ComparableQuantity<E> multiply(javax.measure.Quantity<T> that,
                                                                                                               Class<E> asTypeQuantity)

Divide and cast the ComparableQuantity

Parameters:

that - quantity to be divided

asTypeQuantity - quantity to be converted

Returns:

the QuantityOperations multiplied and converted

Throws:

NullPointerException

See Also:

QuantityOperations, QuantityOperations#of(Quantity, Class), Quantity.asType(Class), Quantity.multiply(Quantity)