TemporalQuantity (Units of Measurement Reference Implementation 2.1.3 API)

java.lang.Object
- tech.units.indriya.AbstractQuantity<javax.measure.quantity.Time>
- - tech.units.indriya.quantity.time.TemporalQuantity

All Implemented Interfaces:

Serializable, Comparable<javax.measure.Quantity<javax.measure.quantity.Time>>, javax.measure.Quantity<javax.measure.quantity.Time>, ComparableQuantity<javax.measure.quantity.Time>, tech.uom.lib.common.function.QuantityConverter<javax.measure.quantity.Time>, tech.uom.lib.common.function.UnitSupplier<javax.measure.quantity.Time>, tech.uom.lib.common.function.ValueSupplier<Number>
```
public final class TemporalQuantity
extends AbstractQuantity<javax.measure.quantity.Time>
```
Class that represents TemporalUnit in Unit-API

Since:

1.0

Version:

1.3, Jun 4, 2019

Author:

Werner Keil, Filip van Laenen, Andi Huber

See Also:

Serialized Form

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

Field Summary
- Fields inherited from class tech.units.indriya.AbstractQuantity
  NONE, ONE

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ComparableQuantity<javax.measure.quantity.Time>`	`add(javax.measure.Quantity<javax.measure.quantity.Time> that)`
`ComparableQuantity<javax.measure.quantity.Time>`	`divide(Number that)`
`ComparableQuantity<?>`	`divide(javax.measure.Quantity<?> that)`
`boolean`	`equals(Object obj)` Compares this quantity against the specified object for strict equality (same unit and same amount).
`TemporalAmount`	`getTemporalAmount()` Returns the `TemporalAmount` of this `TemporalQuantity`, which may involve rounding or truncation.
`TemporalUnit`	`getTemporalUnit()` get to `TemporalUnit`
`Number`	`getValue()` get value expressed in `Number`
`int`	`hashCode()` Returns the hash code for this quantity.
`ComparableQuantity<javax.measure.quantity.Frequency>`	`inverse()`
`ComparableQuantity<javax.measure.quantity.Time>`	`multiply(Number that)`
`ComparableQuantity<?>`	`multiply(javax.measure.Quantity<?> that)`
`javax.measure.Quantity<javax.measure.quantity.Time>`	`negate()`
`static TemporalQuantity`	`of(Number number, TemporalUnit timeUnit)` creates the `TemporalQuantity` using `TemporalUnit` and `Number`
`static TemporalQuantity`	`of(javax.measure.Quantity<javax.measure.quantity.Time> quantity)` Creates a `TemporalQuantity` based a `Quantity` converted to `Units.SECOND`.
`ComparableQuantity<javax.measure.quantity.Time>`	`subtract(javax.measure.Quantity<javax.measure.quantity.Time> that)`
`TemporalQuantity`	`to(TemporalUnit aTimeUnit)`
`javax.measure.Quantity<javax.measure.quantity.Time>`	`toQuantity()` Converts the `TemporalQuantity` to `Quantity`
`String`	`toString()` Returns the `String` representation of this quantity.
`javax.measure.Unit<javax.measure.quantity.Time>`	`toUnit()` converts the `TemporalUnit` to `Unit`

Methods inherited from class tech.units.indriya.AbstractQuantity
asType, compareTo, divide, getScale, getUnit, hasFraction, hasFraction, inverse, isEquivalentTo, isGreaterThan, isGreaterThanOrEqualTo, isLessThan, isLessThanOrEqualTo, multiply, numberSystem, parse, to

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface javax.measure.Quantity
toSystemUnit

- Method Detail
  - of
```
public static TemporalQuantity of(Number number,
                                  TemporalUnit timeUnit)
```
    creates the TemporalQuantity using TemporalUnit and Number
    
    Parameters:
    
    value - - value to be used
    
    timeUnit - - time to be used
  - of
```
public static TemporalQuantity of(javax.measure.Quantity<javax.measure.quantity.Time> quantity)
```
    Creates a TemporalQuantity based a Quantity converted to Units.SECOND.
    
    Parameters:
    
    quantity - - quantity to be used
    
    Returns:
    
    the TemporalQuantity converted be quantity in seconds.
  - getTemporalAmount
```
public TemporalAmount getTemporalAmount()
```
    Returns the TemporalAmount of this TemporalQuantity, which may involve rounding or truncation.
    
    Returns:
    
    the TemporalAmount
    
    Throws:
    
    ArithmeticException - when the value of this TemporalQuantity cannot be converted to long
  - getTemporalUnit
```
public TemporalUnit getTemporalUnit()
```
    get to TemporalUnit
    
    Returns:
    
    the TemporalUnit
  - getValue
```
public Number getValue()
```
    get value expressed in Number
    
    Specified by:
    
    getValue in interface javax.measure.Quantity<javax.measure.quantity.Time>
    
    Specified by:
    
    getValue in interface tech.uom.lib.common.function.ValueSupplier<Number>
    
    Specified by:
    
    getValue in class AbstractQuantity<javax.measure.quantity.Time>
    
    Returns:
    
    the value
  - toUnit
```
public javax.measure.Unit<javax.measure.quantity.Time> toUnit()
```
    converts the TemporalUnit to Unit
    
    Returns:
    
    the getTemporalUnit() converted to Unit
  - toQuantity
```
public javax.measure.Quantity<javax.measure.quantity.Time> toQuantity()
```
    Converts the TemporalQuantity to Quantity
    
    Returns:
    
    this class converted to Quantity
  - to
```
public TemporalQuantity to(TemporalUnit aTimeUnit)
```
  - hashCode
```
public int hashCode()
```
    Description copied from class: AbstractQuantity
    
    Returns the hash code for this quantity.
    
    Overrides:
    
    hashCode in class AbstractQuantity<javax.measure.quantity.Time>
    
    Returns:
    
    the hash code value.
  - equals
```
public boolean equals(Object obj)
```
    Description copied from class: AbstractQuantity
    
    Compares this quantity against the specified object for strict equality (same unit and same amount).
    Similarly to the BigDecimal.equals(java.lang.Object) method which consider 2.0 and 2.00 as different objects because of different internal scales, quantities such as Quantities.getQuantity(3.0, KILOGRAM) Quantities.getQuantity(3, KILOGRAM) and Quantities.getQuantity("3 kg") might not be considered equals because of possible differences in their implementations.
    
    To compare quantities stated using different units or using different amount implementations the compareTo or equals(Quantity, epsilon, epsilonUnit) methods should be used.
    
    Overrides:
    
    equals in class AbstractQuantity<javax.measure.quantity.Time>
    
    Parameters:
    
    obj - the object to compare with.
    
    Returns:
    
    this.getUnit.equals(obj.getUnit()) && this.getLevel().equals(obj.getLevel() && this.getValue().equals(obj.getValue())
  - toString
```
public String toString()
```
    Description copied from class: AbstractQuantity
    
    Returns the String representation of this quantity. The string produced for a given quantity is always the same; it is not affected by locale. This means that it can be used as a canonical string representation for exchanging quantity, or as a key for a Hashtable, etc. Locale-sensitive quantity formatting and parsing is handled by the QuantityFormat implementations and its subclasses.
    
    Overrides:
    
    toString in class AbstractQuantity<javax.measure.quantity.Time>
    
    Returns:
    
    SimpleQuantityFormat.getInstance().format(this)
  - add
```
public ComparableQuantity<javax.measure.quantity.Time> add(javax.measure.Quantity<javax.measure.quantity.Time> that)
```
    See Also:
    
    Quantity.add(Quantity)
  - subtract
```
public ComparableQuantity<javax.measure.quantity.Time> subtract(javax.measure.Quantity<javax.measure.quantity.Time> that)
```
    See Also:
    
    Quantity.subtract(Quantity)
  - divide
```
public ComparableQuantity<?> divide(javax.measure.Quantity<?> that)
```
    See Also:
    
    Quantity.divide(Quantity)
  - divide
```
public ComparableQuantity<javax.measure.quantity.Time> divide(Number that)
```
    See Also:
    
    Quantity.divide(Number)
  - multiply
```
public ComparableQuantity<?> multiply(javax.measure.Quantity<?> that)
```
    See Also:
    
    Quantity.multiply(Quantity)
  - multiply
```
public ComparableQuantity<javax.measure.quantity.Time> multiply(Number that)
```
    See Also:
    
    Quantity.multiply(Number)
  - inverse
```
public ComparableQuantity<javax.measure.quantity.Frequency> inverse()
```
    See Also:
    
    Quantity.inverse()
  - negate
```
public javax.measure.Quantity<javax.measure.quantity.Time> negate()
```
    Since:
    
    1.0.2

Class TemporalQuantity

Nested Class Summary

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

Field Summary

Fields inherited from class tech.units.indriya.AbstractQuantity

Method Summary

Methods inherited from class tech.units.indriya.AbstractQuantity

Methods inherited from class java.lang.Object

Methods inherited from interface javax.measure.Quantity

Method Detail

of

of

getTemporalAmount

getTemporalUnit

getValue

toUnit

toQuantity

to

hashCode

equals

toString

add

subtract

divide

divide

multiply

multiply

inverse

negate