Units of Measurement Reference Implementation 2.2.2 · tech.units.indriya.quantity.time.TemporalQuantity

Modifier and Type	Field and Description
private final Object	$lock1
private transient TemporalAmount	amount
private static final long	serialVersionUID Hides tech.units.indriya.AbstractQuantity.serialVersionUID.
private final TemporalUnit	timeUnit
private final Number	value

Access	Constructor and Description
pack-priv	TemporalQuantity(Number - value to be used value, TemporalUnit - time to be used timeUnit) creates the `TemporalQuantity` using `TemporalUnit` and `Number`

Method Summary

Modifier and Type	Method and Description
public ComparableQuantity<Time>	add(Quantity<Time> the `Quantity` to be added. that) Implements tech.units.indriya.ComparableQuantity.add. Returns the sum of this `Quantity` with the one specified.
private ComparableQuantity<Time>	applyMultiplicativeNumberOperation(Number that, BinaryOperator<Number> valueOperator)
private ComparableQuantity<?>	applyMultiplicativeQuantityOperation(Quantity<?> that, BinaryOperator<Number> valueOperator, BinaryOperator<Unit<?>> unitOperator)
private static <R extends Quantity<R>> Number	convertedQuantityValue(Quantity<R> that, Unit<R> unit)
public ComparableQuantity<?>	divide(Quantity<?> the `Quantity` divisor. that) Implements tech.units.indriya.ComparableQuantity.divide. Returns the quotient of this `Quantity` divided by the `Quantity` specified.
public ComparableQuantity<Time>	divide(Number the `Number` divisor. that) Implements tech.units.indriya.ComparableQuantity.divide. Returns the quotient of this `Quantity` divided by the `Number` specified.
public boolean	equals(Object the object to compare with. obj) Overrides tech.units.indriya.AbstractQuantity.equals. Compares this quantity against the specified object for strict equality (same unit and same amount).
public TemporalAmount	Returns: the TemporalAmount getTemporalAmount() Returns the `TemporalAmount` of this `TemporalQuantity`, which may involve rounding or truncation.
public TemporalUnit	Returns: the TemporalUnit getTemporalUnit() get to `TemporalUnit`
public Number	Returns: the value getValue() Implements abstract tech.units.indriya.AbstractQuantity.getValue. Implements javax.measure.Quantity.getValue, tech.uom.lib.common.function.ValueSupplier.getValue. get value expressed in `Number`
public int	hashCode() Overrides tech.units.indriya.AbstractQuantity.hashCode. Returns the hash code for this quantity.
public ComparableQuantity<Frequency>	inverse() Implements tech.units.indriya.ComparableQuantity.inverse. Returns a `Quantity` that is the multiplicative inverse of this `Quantity`, having reciprocal value and reciprocal unit as given by `this.getUnit().inverse()`.
public ComparableQuantity<?>	multiply(Quantity<?> the `Quantity` multiplicand. that) Implements tech.units.indriya.ComparableQuantity.multiply. Returns the product of this `Quantity` with the one specified.
public ComparableQuantity<Time>	multiply(Number the `Number` multiplicand. that) Implements tech.units.indriya.ComparableQuantity.multiply. Returns the product of this `Quantity` with the `Number` value specified.
public Quantity<Time>	negate() Implements javax.measure.Quantity.negate. Returns a `Quantity` whose value is `(-this.getValue())`.
public static TemporalQuantity	of(Number number, TemporalUnit - time to be used timeUnit) creates the `TemporalQuantity` using `TemporalUnit` and `Number`
public static TemporalQuantity	Returns: the `TemporalQuantity` converted be quantity in seconds. of(Quantity<Time> - quantity to be used quantity) Creates a `TemporalQuantity` based a `Quantity<Time>` converted to `Units#SECOND`.
private static <R extends Quantity<R>> Number	quantityValue(Quantity<R> that)
public ComparableQuantity<Time>	subtract(Quantity<Time> the `Quantity` to be subtracted. that) Implements tech.units.indriya.ComparableQuantity.subtract. Returns the difference between this `Quantity` and the one specified.
public TemporalQuantity	to(TemporalUnit aTimeUnit)
public Quantity<Time>	Returns: this class converted to Quantity toQuantity() Converts the `TemporalQuantity` to `Quantity<Time>`
public String	toString() Overrides tech.units.indriya.AbstractQuantity.toString. Returns the `String` representation of this quantity.
public Unit<Time>	Returns: the `TemporalQuantity#getTemporalUnit()` converted to Unit toUnit() converts the `TemporalUnit` to `Unit`
private static Unit<Time>	toUnit(TemporalUnit timeUnit)

Inherited from tech.units.indriya.AbstractQuantity:: asType compareTo divide getScale getUnit hasFraction hasFraction inverse isEquivalentTo isGreaterThan isGreaterThanOrEqualTo isLessThan isLessThanOrEqualTo multiply parse to

$lock1	back to summary
private final Object $lock1

amount	back to summary
private transient TemporalAmount amount

serialVersionUID	back to summary
private static final long serialVersionUID Hides tech.units.indriya.AbstractQuantity.serialVersionUID.

timeUnit	back to summary
private final TemporalUnit timeUnit

value	back to summary
private final Number value

TemporalQuantity	back to summary
pack-priv TemporalQuantity(Number value, TemporalUnit timeUnit) creates the `TemporalQuantity` using `TemporalUnit` and `Number` Parameters value:Number - value to be used timeUnit:TemporalUnit - time to be used

Method Detail

add back to summary

add	back to summary
public ComparableQuantity<Time> add(Quantity<Time> that) Implements tech.units.indriya.ComparableQuantity.add. Doc from javax.measure.Quantity.add. Returns the sum of this `Quantity` with the one specified. The result shall be as if this quantity and the given addend were converted to system unit before to be added, and the result converted back to the unit of this quantity or any other compatible unit at implementation choice. Parameters that:Quantity<Time> the `Quantity` to be added. Returns:ComparableQuantity<Time> `this + addend`. Annotations @Override

public ComparableQuantity<Time> add(Quantity<Time> that)

Implements tech.units.indriya.ComparableQuantity.add.

Doc from javax.measure.Quantity.add.

Returns the sum of this Quantity with the one specified. The result shall be as if this quantity and the given addend were converted to system unit before to be added, and the result converted back to the unit of this quantity or any other compatible unit at implementation choice.

Parameters

that:Quantity<Time>: the Quantity to be added.

Returns:ComparableQuantity<Time>

this + addend.

Annotations

@Override

applyMultiplicativeNumberOperation	back to summary
private ComparableQuantity<Time> applyMultiplicativeNumberOperation(Number that, BinaryOperator<Number> valueOperator)

applyMultiplicativeQuantityOperation	back to summary
private ComparableQuantity<?> applyMultiplicativeQuantityOperation(Quantity<?> that, BinaryOperator<Number> valueOperator, BinaryOperator<Unit<?>> unitOperator)

convertedQuantityValue	back to summary
private static <R extends Quantity<R>> Number convertedQuantityValue(Quantity<R> that, Unit<R> unit)

divide back to summary

divide	back to summary
public ComparableQuantity<?> divide(Quantity<?> that) Implements tech.units.indriya.ComparableQuantity.divide. Doc from javax.measure.Quantity.divide. Returns the quotient of this `Quantity` divided by the `Quantity` specified. The result shall be as if this quantity and the given divisor were converted to system unit before to be divided, and the result converted back to the unit of this quantity or any other compatible unit at implementation choice. Parameters that:Quantity<?> the `Quantity` divisor. Returns:ComparableQuantity<?> `this / divisor`. Annotations @Override

public ComparableQuantity<?> divide(Quantity<?> that)

Implements tech.units.indriya.ComparableQuantity.divide.

Doc from javax.measure.Quantity.divide.

Returns the quotient of this Quantity divided by the Quantity specified. The result shall be as if this quantity and the given divisor were converted to system unit before to be divided, and the result converted back to the unit of this quantity or any other compatible unit at implementation choice.

Parameters

that:Quantity<?>: the Quantity divisor.

Returns:ComparableQuantity<?>

this / divisor.

Annotations

@Override

divide back to summary

divide	back to summary
public ComparableQuantity<Time> divide(Number that) Implements tech.units.indriya.ComparableQuantity.divide. Doc from javax.measure.Quantity.divide. Returns the quotient of this `Quantity` divided by the `Number` specified. The result shall be as if this quantity was converted to system unit before to be divided, and the result converted back to the unit of this quantity or any other compatible unit at implementation choice. Parameters that:Number the `Number` divisor. Returns:ComparableQuantity<Time> `this / divisor`. Annotations @Override

public ComparableQuantity<Time> divide(Number that)

Implements tech.units.indriya.ComparableQuantity.divide.

Doc from javax.measure.Quantity.divide.

Returns the quotient of this Quantity divided by the Number specified. The result shall be as if this quantity was converted to system unit before to be divided, and the result converted back to the unit of this quantity or any other compatible unit at implementation choice.

Parameters

that:Number: the Number divisor.

Returns:ComparableQuantity<Time>

this / divisor.

Annotations

@Override

equals back to summary

equals	back to summary
public boolean equals(Object obj) Overrides tech.units.indriya.AbstractQuantity.equals. Doc from tech.units.indriya.AbstractQuantity.equals. Compares this quantity against the specified object for strict equality (same unit and same amount). Similarly to the `BigDecimal#equals` 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 `isEquivalentTo` methods should be used. Parameters obj:Object the object to compare with. Returns:boolean `this.getUnit.equals(obj.getUnit()) && this.getScale().equals(obj.getScale() && this.getValue().equals(obj.getValue())` Annotations @Override

public boolean equals(Object obj)

Overrides tech.units.indriya.AbstractQuantity.equals.

Doc from tech.units.indriya.AbstractQuantity.equals.

Compares this quantity against the specified object for strict equality (same unit and same amount).

Similarly to the BigDecimal#equals 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 isEquivalentTo methods should be used.

Parameters

obj:Object: the object to compare with.

Returns:boolean

this.getUnit.equals(obj.getUnit()) && this.getScale().equals(obj.getScale() && this.getValue().equals(obj.getValue())

Annotations

@Override

getTemporalAmount back to summary

getTemporalAmount	back to summary
public TemporalAmount getTemporalAmount() Returns the `TemporalAmount` of this `TemporalQuantity`, which may involve rounding or truncation. Returns:TemporalAmount the TemporalAmount Exceptions ArithmeticException: when the `value` of this `TemporalQuantity` cannot be converted to long

public TemporalAmount getTemporalAmount()

Returns the TemporalAmount of this TemporalQuantity, which may involve rounding or truncation.

Returns:TemporalAmount

the TemporalAmount

Exceptions

ArithmeticException:: when the value of this TemporalQuantity cannot be converted to long

getTemporalUnit back to summary

getTemporalUnit	back to summary
public TemporalUnit getTemporalUnit() get to `TemporalUnit` Returns:TemporalUnit the TemporalUnit

public TemporalUnit getTemporalUnit()

get to TemporalUnit

Returns:TemporalUnit: the TemporalUnit

getValue back to summary

getValue	back to summary
public Number getValue() Implements abstract tech.units.indriya.AbstractQuantity.getValue. Implements javax.measure.Quantity.getValue, tech.uom.lib.common.function.ValueSupplier.getValue. get value expressed in `Number` Returns:Number the value

public Number getValue()

Implements abstract tech.units.indriya.AbstractQuantity.getValue.

Implements javax.measure.Quantity.getValue, tech.uom.lib.common.function.ValueSupplier.getValue.

get value expressed in Number

Returns:Number: the value

hashCode	back to summary
public int hashCode() Overrides tech.units.indriya.AbstractQuantity.hashCode. Doc from tech.units.indriya.AbstractQuantity.hashCode. Returns the hash code for this quantity. Returns:int the hash code value. Annotations @Override

hashCode

back to summary

public int hashCode()

Overrides tech.units.indriya.AbstractQuantity.hashCode.

Doc from tech.units.indriya.AbstractQuantity.hashCode.

Returns the hash code for this quantity.

Returns:int

the hash code value.

Annotations

@Override

inverse back to summary

inverse	back to summary
public ComparableQuantity<Frequency> inverse() Implements tech.units.indriya.ComparableQuantity.inverse. Doc from javax.measure.Quantity.inverse. Returns a `Quantity` that is the multiplicative inverse of this `Quantity`, having reciprocal value and reciprocal unit as given by `this.getUnit().inverse()`. Returns:ComparableQuantity<Frequency> reciprocal `Quantity` Annotations @Override

public ComparableQuantity<Frequency> inverse()

Implements tech.units.indriya.ComparableQuantity.inverse.

Doc from javax.measure.Quantity.inverse.

Returns a Quantity that is the multiplicative inverse of this Quantity, having reciprocal value and reciprocal unit as given by this.getUnit().inverse().

Returns:ComparableQuantity<Frequency>

reciprocal Quantity

Annotations

@Override

multiply back to summary

multiply	back to summary
public ComparableQuantity<?> multiply(Quantity<?> that) Implements tech.units.indriya.ComparableQuantity.multiply. Doc from javax.measure.Quantity.multiply. Returns the product of this `Quantity` with the one specified. The result shall be as if this quantity and the given multiplicand were converted to system unit before to be multiplied, and the result converted back to the unit of this quantity or any other compatible unit at implementation choice. Parameters that:Quantity<?> the `Quantity` multiplicand. Returns:ComparableQuantity<?> `this * multiplicand`. Annotations @Override

public ComparableQuantity<?> multiply(Quantity<?> that)

Implements tech.units.indriya.ComparableQuantity.multiply.

Doc from javax.measure.Quantity.multiply.

Returns the product of this Quantity with the one specified. The result shall be as if this quantity and the given multiplicand were converted to system unit before to be multiplied, and the result converted back to the unit of this quantity or any other compatible unit at implementation choice.

Parameters

that:Quantity<?>: the Quantity multiplicand.

Returns:ComparableQuantity<?>

this * multiplicand.

Annotations

@Override

multiply back to summary

multiply	back to summary
public ComparableQuantity<Time> multiply(Number that) Implements tech.units.indriya.ComparableQuantity.multiply. Doc from javax.measure.Quantity.multiply. Returns the product of this `Quantity` with the `Number` value specified. The result shall be as if this quantity was converted to system unit before to be multiplied, and the result converted back to the unit of this quantity or any other compatible unit at implementation choice. Parameters that:Number the `Number` multiplicand. Returns:ComparableQuantity<Time> `this * multiplicand`. Annotations @Override

public ComparableQuantity<Time> multiply(Number that)

Implements tech.units.indriya.ComparableQuantity.multiply.

Doc from javax.measure.Quantity.multiply.

Returns the product of this Quantity with the Number value specified. The result shall be as if this quantity was converted to system unit before to be multiplied, and the result converted back to the unit of this quantity or any other compatible unit at implementation choice.

Parameters

that:Number: the Number multiplicand.

Returns:ComparableQuantity<Time>

this * multiplicand.

Annotations

@Override

negate back to summary

negate	back to summary
public Quantity<Time> negate() Implements javax.measure.Quantity.negate. Doc from javax.measure.Quantity.negate. Returns a `Quantity` whose value is `(-this.getValue())`. Returns:Quantity<Time> `-this`. Annotations @Override Since 1.0.2

public Quantity<Time> negate()

Implements javax.measure.Quantity.negate.

Doc from javax.measure.Quantity.negate.

Returns a Quantity whose value is (-this.getValue()).

Returns:Quantity<Time>

-this.

Annotations

@Override

Since

1.0.2

of back to summary

of	back to summary
public static TemporalQuantity of(Number number, TemporalUnit timeUnit) creates the `TemporalQuantity` using `TemporalUnit` and `Number` Parameters timeUnit:TemporalUnit - time to be used

public static TemporalQuantity of(Number number, TemporalUnit timeUnit)

creates the TemporalQuantity using TemporalUnit and Number

Parameters

timeUnit:TemporalUnit: - time to be used

of back to summary

of	back to summary
public static TemporalQuantity of(Quantity<Time> quantity) Creates a `TemporalQuantity` based a `Quantity<Time>` converted to `Units#SECOND`. Parameters quantity:Quantity<Time> - quantity to be used Returns:TemporalQuantity the `TemporalQuantity` converted be quantity in seconds.

public static TemporalQuantity of(Quantity<Time> quantity)

Creates a TemporalQuantity based a Quantity<Time> converted to Units#SECOND.

Parameters

quantity:Quantity<Time>: - quantity to be used

Returns:TemporalQuantity

the TemporalQuantity converted be quantity in seconds.

quantityValue	back to summary
private static <R extends Quantity<R>> Number quantityValue(Quantity<R> that)

subtract back to summary

subtract	back to summary
public ComparableQuantity<Time> subtract(Quantity<Time> that) Implements tech.units.indriya.ComparableQuantity.subtract. Doc from javax.measure.Quantity.subtract. Returns the difference between this `Quantity` and the one specified. The result shall be as if this quantity and the given subtrahend were converted to system unit before to be subtracted, and the result converted back to the unit of this quantity or any other compatible unit at implementation choice. Parameters that:Quantity<Time> the `Quantity` to be subtracted. Returns:ComparableQuantity<Time> `this - subtrahend`. Annotations @Override

public ComparableQuantity<Time> subtract(Quantity<Time> that)

Implements tech.units.indriya.ComparableQuantity.subtract.

Doc from javax.measure.Quantity.subtract.

Returns the difference between this Quantity and the one specified. The result shall be as if this quantity and the given subtrahend were converted to system unit before to be subtracted, and the result converted back to the unit of this quantity or any other compatible unit at implementation choice.

Parameters

that:Quantity<Time>: the Quantity to be subtracted.

Returns:ComparableQuantity<Time>

this - subtrahend.

Annotations

@Override

to	back to summary
public TemporalQuantity to(TemporalUnit aTimeUnit)

toQuantity back to summary

toQuantity	back to summary
public Quantity<Time> toQuantity() Converts the `TemporalQuantity` to `Quantity<Time>` Returns:Quantity<Time> this class converted to Quantity

public Quantity<Time> toQuantity()

Converts the TemporalQuantity to Quantity<Time>

Returns:Quantity<Time>: this class converted to Quantity

toString back to summary

toString	back to summary
public String toString() Overrides tech.units.indriya.AbstractQuantity.toString. Doc from tech.units.indriya.AbstractQuantity.toString. 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. Returns:String `SimpleQuantityFormat.getInstance().format(this)` Annotations @Override

public String toString()

Overrides tech.units.indriya.AbstractQuantity.toString.

Doc from tech.units.indriya.AbstractQuantity.toString.

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.

Returns:String

SimpleQuantityFormat.getInstance().format(this)

Annotations

@Override

toUnit back to summary

toUnit	back to summary
public Unit<Time> toUnit() converts the `TemporalUnit` to `Unit` Returns:Unit<Time> the `TemporalQuantity#getTemporalUnit()` converted to Unit

public Unit<Time> toUnit()

converts the TemporalUnit to Unit

Returns:Unit<Time>: the TemporalQuantity#getTemporalUnit() converted to Unit

toUnit	back to summary
private static Unit<Time> toUnit(TemporalUnit timeUnit)

public final Class TemporalQuantity

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail