TimeUnitQuantity (Units of Measurement Reference Implementation 2.2 API)

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

All Implemented Interfaces:

Serializable, Comparable<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>
```
public final class TimeUnitQuantity
extends AbstractQuantity<javax.measure.quantity.Time>
```
Class that represents TimeUnit in Unit-API

Since:

1.0

Version:

1.2

Author:

Otavio Santana, Werner Keil, 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	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).
`TimeUnit`	`getTimeUnit()`	get to `TimeUnit`
`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 TimeUnitQuantity`	`of(Number number, TimeUnit timeUnit)`	creates the `TimeUnitQuantity` using `TimeUnit` and `Long`
`static TimeUnitQuantity`	`of(javax.measure.Quantity<javax.measure.quantity.Time> quantity)`	Creates a `TimeUnitQuantity` based a `Quantity` converted to `SI#SECOND`.
`ComparableQuantity<javax.measure.quantity.Time>`	`subtract(javax.measure.Quantity<javax.measure.quantity.Time> that)`
`TimeUnitQuantity`	`to(TimeUnit aTimeUnit)`
`javax.measure.Quantity<javax.measure.quantity.Time>`	`toQuantity()`	Converts the `TimeUnitQuantity` to `Quantity`
`String`	`toString()`	Returns the `String` representation of this quantity.
`javax.measure.Unit<javax.measure.quantity.Time>`	`toUnit()`	converts the `TimeUnit` to `Unit`

Methods inherited from class tech.units.indriya.AbstractQuantity
asType, compareTo, divide, getScale, getUnit, hasFraction, hasFraction, inverse, isEquivalentTo, isGreaterThan, isGreaterThanOrEqualTo, isLessThan, isLessThanOrEqualTo, multiply, 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 TimeUnitQuantity of(Number number,
                                  TimeUnit timeUnit)
```
    creates the TimeUnitQuantity using TimeUnit and Long
    
    Parameters:
    
    timeUnit - - time to be used
    
    value - - value to be used
    
    Since:
    
    1.0.9
  - of
```
public static TimeUnitQuantity of(javax.measure.Quantity<javax.measure.quantity.Time> quantity)
```
    Creates a TimeUnitQuantity based a Quantity converted to SI#SECOND.
    
    Parameters:
    
    quantity - - quantity to be used
    
    Returns:
    
    the TimeUnitQuantity converted be quantity in seconds.
    
    Since:
    
    1.0
  - getTimeUnit
```
public TimeUnit getTimeUnit()
```
    get to TimeUnit
    
    Returns:
    
    the TimeUnit
    
    Since:
    
    1.0
  - 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 class AbstractQuantity<javax.measure.quantity.Time>
    
    Returns:
    
    the value
    
    Since:
    
    1.0
  - toUnit
```
public javax.measure.Unit<javax.measure.quantity.Time> toUnit()
```
    converts the TimeUnit to Unit
    
    Returns:
    
    the getTimeUnit() converted to Unit
    
    Since:
    
    1.0
  - toQuantity
```
public javax.measure.Quantity<javax.measure.quantity.Time> toQuantity()
```
    Converts the TimeUnitQuantity to Quantity
    
    Returns:
    
    this class converted to Quantity
    
    Since:
    
    1.0
  - to
```
public TimeUnitQuantity to(TimeUnit 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.
    
    Since:
    
    1.0
  - 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 AbstractQuantity.isEquivalentTo(javax.measure.Quantity<Q>) 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.getScale().equals(obj.getScale() && this.getValue().equals(obj.getValue())
    
    Since:
    
    1.0
  - 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)
```
    Since:
    
    1.0.1
    
    See Also:
    
    Quantity.add(Quantity)
  - subtract
```
public ComparableQuantity<javax.measure.quantity.Time> subtract(javax.measure.Quantity<javax.measure.quantity.Time> that)
```
    Since:
    
    1.0.1
    
    See Also:
    
    Quantity.subtract(Quantity)
  - divide
```
public ComparableQuantity<?> divide(javax.measure.Quantity<?> that)
```
    Since:
    
    1.0.1
    
    See Also:
    
    Quantity.divide(Quantity)
  - divide
```
public ComparableQuantity<javax.measure.quantity.Time> divide(Number that)
```
    Since:
    
    1.0.1
    
    See Also:
    
    Quantity.divide(Number)
  - multiply
```
public ComparableQuantity<?> multiply(javax.measure.Quantity<?> that)
```
    Since:
    
    1.0.1
    
    See Also:
    
    Quantity.multiply(Quantity)
  - multiply
```
public ComparableQuantity<javax.measure.quantity.Time> multiply(Number that)
```
    Since:
    
    1.0.1
    
    See Also:
    
    Quantity.multiply(Number)
  - inverse
```
public ComparableQuantity<javax.measure.quantity.Frequency> inverse()
```
    Since:
    
    1.0.1
    
    See Also:
    
    Quantity.inverse()
  - negate
```
public javax.measure.Quantity<javax.measure.quantity.Time> negate()
```
    Since:
    
    1.0.2

Class TimeUnitQuantity

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

getTimeUnit

getValue

toUnit

toQuantity

to

hashCode

equals

toString

add

subtract

divide

divide

multiply

multiply

inverse

negate