Type Parameters:

Q - the quantity type

All Superinterfaces:

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

All Known Implementing Classes:

AbstractQuantity, NumberQuantity, TemporalQuantity, TimeUnitQuantity
```
public interface ComparableQuantity<Q extends Quantity<Q>>
extends Quantity<Q>, Comparable<Quantity<Q>>, tech.uom.lib.common.function.QuantityConverter<Q>, Serializable
```
Quantity that adapts Comparable to the Quantity interface. For use in other quantities, when supposed to work on Comparables. It extends Quantity with Comparable and Serializable

Since:

1.0

Version:

2.6, November 14, 2024

Author:

otaviojava, werner

See Also:

Quantity

Nested Class Summary
- Nested classes/interfaces inherited from interface javax.measure.Quantity
  Quantity.Scale

Method Summary

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

Methods inherited from interface java.lang.Comparable
compareTo

Methods inherited from interface javax.measure.Quantity
getScale, getUnit, getValue, isEquivalentTo, negate, toSystemUnit

- Method Detail
  - add
```
ComparableQuantity<Q> add(Quantity<Q> that)
```
    Specified by:
    
    add in interface Quantity<Q extends Quantity<Q>>
    
    See Also:
    
    Quantity.add(Quantity)
  - subtract
```
ComparableQuantity<Q> subtract(Quantity<Q> that)
```
    Specified by:
    
    subtract in interface Quantity<Q extends Quantity<Q>>
    
    See Also:
    
    Quantity.subtract(Quantity)
  - divide
```
ComparableQuantity<?> divide(Quantity<?> that)
```
    Specified by:
    
    divide in interface Quantity<Q extends Quantity<Q>>
    
    See Also:
    
    Quantity.divide(Quantity)
  - divide
```
ComparableQuantity<Q> divide(Number that)
```
    Specified by:
    
    divide in interface Quantity<Q extends Quantity<Q>>
    
    See Also:
    
    Quantity.divide(Number)
  - multiply
```
ComparableQuantity<?> multiply(Quantity<?> multiplier)
```
    Specified by:
    
    multiply in interface Quantity<Q extends Quantity<Q>>
    
    See Also:
    
    Quantity.multiply(Quantity)
  - multiply
```
ComparableQuantity<Q> multiply(Number multiplier)
```
    Specified by:
    
    multiply in interface Quantity<Q extends Quantity<Q>>
    
    See Also:
    
    Quantity.multiply(Number)
  - inverse
```
ComparableQuantity<?> inverse()
```
    Specified by:
    
    inverse in interface Quantity<Q extends Quantity<Q>>
    
    See Also:
    
    Quantity.inverse()
  - inverse
```
<T extends 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(Unit<Q> unit)
```
    Specified by:
    
    to in interface Quantity<Q extends Quantity<Q>>
    
    Specified by:
    
    to in interface tech.uom.lib.common.function.QuantityConverter<Q extends Quantity<Q>>
    
    See Also:
    
    Quantity.to(Unit)
  - asType
```
<T extends Quantity<T>> ComparableQuantity<T> asType(Class<T> type)
                                              throws ClassCastException
```
    Specified by:
    
    asType in interface Quantity<Q extends Quantity<Q>>
    
    Throws:
    
    ClassCastException
    
    See Also:
    
    Quantity.asType(Class)
  - isGreaterThan
```
boolean isGreaterThan(Quantity<Q> that)
```
    Compares two instances of Quantity. Conversion of unit can happen if necessary
    
    Parameters:
    
    that - the quantity<Q> to be compared with this instance.
    
    Returns:
    
    true if this > that.
    
    Throws:
    
    NullPointerException - if the that is null
  - isGreaterThanOrEqualTo
```
boolean isGreaterThanOrEqualTo(Quantity<Q> that)
```
    Compares two instances of Quantity, converting the unit if necessary.
    
    Parameters:
    
    that - the quantity<Q> to be compared with this instance.
    
    Returns:
    
    true if this >= that.
    
    Throws:
    
    NullPointerException - if the that is null
  - isLessThan
```
boolean isLessThan(Quantity<Q> that)
```
    Compares two instances of Quantity, converting the unit if necessary.
    
    Parameters:
    
    that - the quantity<Q> to be compared with this instance.
    
    Returns:
    
    true if this < that.
    
    Throws:
    
    NullPointerException - if the quantity is null
  - isLessThanOrEqualTo
```
boolean isLessThanOrEqualTo(Quantity<Q> that)
```
    Compares two instances of Quantity, converting the unit if necessary.
    
    Parameters:
    
    that - the quantity<Q> to be compared with this instance.
    
    Returns:
    
    true if this <= that.
    
    Throws:
    
    NullPointerException - if the quantity is null
  - divide
```
<T extends Quantity<T>,E extends Quantity<E>> ComparableQuantity<E> divide(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 Quantity<T>,E extends Quantity<E>> ComparableQuantity<E> multiply(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)

Interface ComparableQuantity<Q extends Quantity<Q>>

Nested Class Summary

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

Method Summary

Methods inherited from interface java.lang.Comparable

Methods inherited from interface javax.measure.Quantity

Method Detail

add

subtract

divide

divide

multiply

multiply

inverse

inverse

to

asType

isGreaterThan

isGreaterThanOrEqualTo

isLessThan

isLessThanOrEqualTo

divide

multiply