tec.uom.se.quantity.time

Class TimeUnitQuantity

java.lang.Object

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

tec.uom.se.quantity.time.TimeUnitQuantity

All Implemented Interfaces:

Serializable, 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<Number>, ComparableQuantity<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.0.1

Author:

otaviojava, keilw

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class tec.uom.se.AbstractQuantity

AbstractQuantity.Equalizer

Field Summary

Fields inherited from class tec.uom.se.AbstractQuantity

NONE, ONE

Method Summary

Modifier and Type	Method and Description
ComparableQuantity<javax.measure.quantity.Time>	add(javax.measure.Quantity<javax.measure.quantity.Time> that)
BigDecimal	decimalValue(javax.measure.Unit<javax.measure.quantity.Time> unit, MathContext ctx)
ComparableQuantity<javax.measure.quantity.Time>	divide(Number that)
ComparableQuantity<?>	divide(javax.measure.Quantity<?> that)
double	doubleValue(javax.measure.Unit<javax.measure.quantity.Time> unit)
boolean	equals(Object obj) Compares this quantity against the specified object for strict equality (same unit and same amount).
TimeUnit	getTimeUnit() get to TimeUnit
Integer	getValue() get value expressed in Integer
int	hashCode() Returns the hash code for this quantity.
ComparableQuantity<?>	inverse()
boolean	isBig()
ComparableQuantity<javax.measure.quantity.Time>	multiply(Number multiplier)
ComparableQuantity<?>	multiply(javax.measure.Quantity<?> multiplier)
static TimeUnitQuantity	of(javax.measure.Quantity<javax.measure.quantity.Time> quantity) Creates a TimeUnitQuantity based a Quantity converted to SI#SECOND.
static TimeUnitQuantity	of(TimeUnit timeUnit, Integer number) creates the TimeUnitQuantity using TimeUnit and Integer
ComparableQuantity<javax.measure.quantity.Time>	subtract(javax.measure.Quantity<javax.measure.quantity.Time> that)
TimeUnitQuantity	to(TimeUnit timeUnit)
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 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

Method Detail

of

public static TimeUnitQuantity of(TimeUnit timeUnit,
                                  Integer number)

creates the TimeUnitQuantity using TimeUnit and Integer

Parameters:

timeUnit - - time to be used

value - - value to be used

Since:

1.0

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 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<Number>

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 timeUnit)

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 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())

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 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)

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<?> multiplier)

Since:

1.0.1

See Also:

Quantity.multiply(Quantity)

multiply

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

Since:

1.0.1

See Also:

Quantity.multiply(Number)

inverse

public ComparableQuantity<?> inverse()

Since:

1.0.1

See Also:

Quantity.inverse()

isBig

public boolean isBig()

Specified by:

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

Since:

1.0.1

decimalValue

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

Specified by:

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

Throws:

ArithmeticException

Since:

1.0.1

doubleValue

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

Specified by:

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

Throws:

ArithmeticException

Since:

1.0.1