org.openjdk.jmc.common.unit

Interface ITypedQuantity<U extends TypedUnit<U>>

All Superinterfaces:

java.lang.Comparable<IQuantity>, IDisplayable, IItem, IQuantity

All Known Implementing Classes:

ScalarQuantity, ScalarQuantity.DoubleStored, ScalarQuantity.LongStored

public interface ITypedQuantity<U extends TypedUnit<U>>
extends IQuantity

Type parameterized extension of IQuantity. This construction exists to reduce clutter for casual users of IQuantity, while still providing type safety for internal implementations. (Proposed "self-variance" extensions to Java, in JDK 9 or beyond, may directly support this with a single interface.)

Field Summary

Fields inherited from interface org.openjdk.jmc.common.IDisplayable

AUTO, EXACT, VERBOSE

Method Summary

Modifier and Type	Method and Description
ITypedQuantity<U>	add(ITypedQuantity<LinearUnit> addend)
ITypedQuantity<U>	floorQuantize(ITypedQuantity<LinearUnit> quanta)
KindOfQuantity<U>	getType() Get the kind of this quantity.
U	getUnit()
ITypedQuantity<U>	in(U targetUnit) Get this quantity expressed in the unit targetUnit.
java.lang.String	interactiveFormat(boolean allowCustomUnit)
java.lang.String	localizedFormat(boolean useBreakingSpace, boolean allowCustomUnit)
ITypedQuantity<U>	multiply(double factor) Returns a new quantity that is this quantity multiplied with factor, if this is a linear quantity.
ITypedQuantity<U>	multiply(long factor) Returns a new quantity that is this quantity multiplied with factor, if this is a linear quantity.
ITypedQuantity<LinearUnit>	subtract(ITypedQuantity<U> subtrahend)

Methods inherited from interface org.openjdk.jmc.common.unit.IQuantity

add, clampedFloorIn, clampedIntFloorIn, clampedLongValueIn, doubleValue, doubleValueIn, in, interactiveFormat, isLinear, longValue, longValueIn, longValueIn, numberValue, numberValueIn, persistableString, ratioTo, subtract

Methods inherited from interface org.openjdk.jmc.common.IDisplayable

displayUsing

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getType

KindOfQuantity<U> getType()

Description copied from interface: IQuantity

Get the kind of this quantity.

Specified by:

getType in interface IItem

Specified by:

getType in interface IQuantity

Returns:

the type of this item

getUnit

U getUnit()

Specified by:

getUnit in interface IQuantity

Returns:

the unit in which this quantity is expressed

in

ITypedQuantity<U> in(U targetUnit)

Get this quantity expressed in the unit targetUnit. Note that as a result of this conversion, precision may be lost. Note that this method differs from IQuantity.in(IUnit) only by stricter typing.

Returns:

a quantity, with approximately the same value as this quantity, expressed in targetUnit

Throws:

java.lang.IllegalArgumentException - if targetUnit is not of the same kind of quantity

add

ITypedQuantity<U> add(ITypedQuantity<LinearUnit> addend)
               throws java.lang.IllegalArgumentException

Throws:

java.lang.IllegalArgumentException

subtract

ITypedQuantity<LinearUnit> subtract(ITypedQuantity<U> subtrahend)
                             throws java.lang.IllegalArgumentException

Throws:

java.lang.IllegalArgumentException

multiply

ITypedQuantity<U> multiply(long factor)
                    throws java.lang.UnsupportedOperationException

Description copied from interface: IQuantity

Returns a new quantity that is this quantity multiplied with factor, if this is a linear quantity. Otherwise, this operation is undefined and UnsupportedOperationException will be thrown.

Specified by:

multiply in interface IQuantity

Returns:

this quantity multiplied with factor

Throws:

java.lang.UnsupportedOperationException - if this quantity is not linear

multiply

ITypedQuantity<U> multiply(double factor)
                    throws java.lang.UnsupportedOperationException

Description copied from interface: IQuantity

Returns a new quantity that is this quantity multiplied with factor, if this is a linear quantity. Otherwise, this operation is undefined and UnsupportedOperationException will be thrown.

Specified by:

multiply in interface IQuantity

Returns:

this quantity multiplied with factor

Throws:

java.lang.UnsupportedOperationException - if this quantity is not linear

floorQuantize

ITypedQuantity<U> floorQuantize(ITypedQuantity<LinearUnit> quanta)

interactiveFormat

java.lang.String interactiveFormat(boolean allowCustomUnit)

localizedFormat

java.lang.String localizedFormat(boolean useBreakingSpace,
                                 boolean allowCustomUnit)