tec.uom.se.quantity.time

Class TemporalQuantity

java.lang.Object

tec.uom.se.AbstractQuantity<javax.measure.quantity.Time>

tec.uom.se.quantity.time.TemporalQuantity

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<javax.measure.Quantity<javax.measure.quantity.Time>>, javax.measure.Quantity<javax.measure.quantity.Time>, tec.uom.lib.common.function.UnitSupplier<javax.measure.quantity.Time>, tec.uom.lib.common.function.ValueSupplier<java.lang.Number>, ComparableQuantity<javax.measure.quantity.Time>

public final class TemporalQuantity
extends AbstractQuantity<javax.measure.quantity.Time>

Class that represents TemporalUnit in Unit-API

Since:

1.0

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private java.time.temporal.TemporalAmount	amount
private static long	serialVersionUID
private java.time.temporal.TemporalUnit	timeUnit
private java.lang.Integer	value

Fields inherited from class tec.uom.se.AbstractQuantity

NONE, ONE

Constructor Summary

Constructors

Constructor and Description
TemporalQuantity(java.lang.Integer value, java.time.temporal.TemporalUnit timeUnit) creates the TemporalQuantity using TemporalUnit and Integer

Method Summary

Modifier and Type	Method and Description
ComparableQuantity<javax.measure.quantity.Time>	add(javax.measure.Quantity<javax.measure.quantity.Time> that)
java.math.BigDecimal	decimalValue(javax.measure.Unit<javax.measure.quantity.Time> unit, java.math.MathContext ctx)
ComparableQuantity<javax.measure.quantity.Time>	divide(java.lang.Number that)
ComparableQuantity<?>	divide(javax.measure.Quantity<?> that)
double	doubleValue(javax.measure.Unit<javax.measure.quantity.Time> unit)
boolean	equals(java.lang.Object obj) Compares this measure against the specified object for strict equality (same unit and same amount).
java.time.temporal.TemporalAmount	getTemporalAmount() get to TemporalAmount
java.time.temporal.TemporalUnit	getTemporalUnit() get to TemporalUnit
java.lang.Integer	getValue() get value expressed in Integer
int	hashCode() Returns the hash code for this measure.
ComparableQuantity<?>	inverse()
boolean	isBig()
ComparableQuantity<javax.measure.quantity.Time>	multiply(java.lang.Number multiplier)
ComparableQuantity<?>	multiply(javax.measure.Quantity<?> multiplier)
static TemporalQuantity	of(java.lang.Integer number, java.time.temporal.TemporalUnit timeUnit) creates the TemporalQuantity using TemporalUnit and Integer
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(java.time.temporal.TemporalUnit timeUnit)
javax.measure.Quantity<javax.measure.quantity.Time>	toQuantity() Converts the TemporalQuantity to Quantity
java.lang.String	toString() Returns the String representation of this measure.
javax.measure.Unit<javax.measure.quantity.Time>	toUnit() converts the TemporalUnit to Unit
private static javax.measure.Unit<javax.measure.quantity.Time>	toUnit(java.time.temporal.TemporalUnit timeUnit)

Methods inherited from class tec.uom.se.AbstractQuantity

asType, compareTo, divide, equals, floatValue, getUnit, intValue, inverse, isEquivalentTo, isGreaterThan, isGreaterThanOrEqualTo, isLessThan, isLessThanOrEqualTo, longValue, multiply, parse, to, to, toSI

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

timeUnit

private final java.time.temporal.TemporalUnit timeUnit

value

private final java.lang.Integer value

amount

private final java.time.temporal.TemporalAmount amount

Constructor Detail

TemporalQuantity

TemporalQuantity(java.lang.Integer value,
                 java.time.temporal.TemporalUnit timeUnit)

creates the TemporalQuantity using TemporalUnit and Integer

Parameters:

timeUnit - - time to be used

value - - value to be used

Method Detail

of

public static TemporalQuantity of(java.lang.Integer number,
                                  java.time.temporal.TemporalUnit timeUnit)

creates the TemporalQuantity using TemporalUnit and Integer

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 java.time.temporal.TemporalAmount getTemporalAmount()

get to TemporalAmount

Returns:

the TemporalAmount

getTemporalUnit

public java.time.temporal.TemporalUnit getTemporalUnit()

get to TemporalUnit

Returns:

the TemporalUnit

getValue

public java.lang.Integer getValue()

get value expressed in Integer

Specified by:

getValue in interface javax.measure.Quantity<javax.measure.quantity.Time>

Specified by:

getValue in interface tec.uom.lib.common.function.ValueSupplier<java.lang.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(java.time.temporal.TemporalUnit timeUnit)

toUnit

private static javax.measure.Unit<javax.measure.quantity.Time> toUnit(java.time.temporal.TemporalUnit timeUnit)

hashCode

public int hashCode()

Description copied from class: AbstractQuantity

Returns the hash code for this measure.

Overrides:

hashCode in class AbstractQuantity<javax.measure.quantity.Time>

Returns:

the hash code value.

equals

public boolean equals(java.lang.Object obj)

Description copied from class: AbstractQuantity

Compares this measure 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 measures 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.getValue().equals(obj.getValue())

toString

public java.lang.String toString()

Description copied from class: AbstractQuantity

Returns the String representation of this measure. The string produced for a given measure is always the same; it is not affected by locale. This means that it can be used as a canonical string representation for exchanging measure, or as a key for a Hashtable, etc. Locale-sensitive measure formatting and parsing is handled by the MeasurementFormat class and its subclasses.

Overrides:

toString in class AbstractQuantity<javax.measure.quantity.Time>

Returns:

UnitFormat.getInternational().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(java.lang.Number that)

See Also:

Quantity.divide(Number)

multiply

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

See Also:

Quantity.multiply(Quantity)

multiply

public ComparableQuantity<javax.measure.quantity.Time> multiply(java.lang.Number multiplier)

See Also:

Quantity.multiply(Number)

inverse

public ComparableQuantity<?> inverse()

See Also:

Quantity.inverse()

isBig

public boolean isBig()

Specified by:

isBig in class AbstractQuantity<javax.measure.quantity.Time>

decimalValue

public java.math.BigDecimal decimalValue(javax.measure.Unit<javax.measure.quantity.Time> unit,
                                         java.math.MathContext ctx)
                                  throws java.lang.ArithmeticException

Specified by:

decimalValue in class AbstractQuantity<javax.measure.quantity.Time>

Throws:

java.lang.ArithmeticException

doubleValue

public double doubleValue(javax.measure.Unit<javax.measure.quantity.Time> unit)
                   throws java.lang.ArithmeticException

Specified by:

doubleValue in class AbstractQuantity<javax.measure.quantity.Time>

Throws:

java.lang.ArithmeticException