org.openjdk.jmc.common.unit

Class TypedUnit<U extends TypedUnit<U>>

java.lang.Object

org.openjdk.jmc.common.unit.TypedUnit<U>

All Implemented Interfaces:

IUnit

Direct Known Subclasses:

LinearUnit, TimestampUnit

public abstract class TypedUnit<U extends TypedUnit<U>>
extends java.lang.Object
implements IUnit

Type parameterized extension of IUnit. This construction exists to reduce clutter for casual users of IUnit, 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.)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	TypedUnit.UnitSelector<U extends TypedUnit<U>>

Field Summary

Fields inherited from interface org.openjdk.jmc.common.unit.IUnit

EMPTY_STRING_ARRAY

Constructor Summary

Constructors

Constructor and Description
TypedUnit()

Method Summary

Modifier and Type	Method and Description
protected abstract ITypedQuantity<U>	add(long numericalAugend, LinearUnit addendUnit, long numericalAddend)
protected ITypedQuantity<U>	addPossiblyIntegral(long numericalAugend, IScalarAffineTransform addendValueTransform, long numericalAddend)
protected abstract ITypedQuantity<U>	floorQuantize(double numericalValue, ITypedQuantity<LinearUnit> quanta)
protected abstract ITypedQuantity<U>	floorQuantize(long numericalValue, ITypedQuantity<LinearUnit> quanta)
abstract KindOfQuantity<U>	getContentType() Get the kind of quantity of this unit.
protected abstract U	getScaledUnit(LinearUnit deltaUnit) Return a unit with the same origin (if absolute) as this unit, but with the given deltaUnit as its delta unit.
protected abstract java.lang.Class<U>	getUnitClass() Get the typed Class object of the actual TypedUnit subclass U.
protected abstract java.lang.String	localizedFormatFor(java.lang.Number numericalValue, boolean useBreakingSpace, boolean allowCustomUnit)
protected abstract java.lang.String	persistableStringFor(java.lang.Number numericalValue)
abstract ITypedQuantity<U>	quantity(double numericalValue) Create a quantity expressed in this unit and with a numerical quantity value equal to numericalValue.
abstract ITypedQuantity<U>	quantity(long numericalValue) Create a quantity expressed in this unit and with a numerical quantity value equal to numericalValue.
ITypedQuantity<U>	quantity(java.lang.Number value) Create a quantity expressed in this unit and with a numerical quantity value equal to numericalValue.
protected abstract ITypedQuantity<LinearUnit>	subtractSame(long numericalMinuend, U subtrahendUnit, long numericalSubtrahend)
IScalarAffineTransform	valueTransformTo(IUnit targetUnit) Get a transform for transforming numerical quantity values expressed in this unit to numerical quantity values expressed in targetUnit.
abstract IScalarAffineTransform	valueTransformTo(U targetUnit) Get a transform for transforming numerical quantity values expressed in this unit to numerical quantity values expressed in targetUnit.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getAltLocalizedNames, getAppendableSuffix, getDeltaUnit, getIdentifier, getLocalizedDescription, getLocalizedSymbol, isLinear

Constructor Detail

TypedUnit

public TypedUnit()

Method Detail

getUnitClass

protected abstract java.lang.Class<U> getUnitClass()

Get the typed Class object of the actual TypedUnit subclass U. This method is intended to simplify generic code, written in TypedUnit, to go from loosely typed arguments into stricter parameterized arguments.

getScaledUnit

protected abstract U getScaledUnit(LinearUnit deltaUnit)

Return a unit with the same origin (if absolute) as this unit, but with the given deltaUnit as its delta unit. Linear units will return deltaUnit.

Throws:

java.lang.IllegalArgumentException - if deltaUnit is of the wrong kind, although linear units are not guaranteed to verify this here

getContentType

public abstract KindOfQuantity<U> getContentType()

Description copied from interface: IUnit

Get the kind of quantity of this unit.

Specified by:

getContentType in interface IUnit

quantity

public ITypedQuantity<U> quantity(java.lang.Number value)

Description copied from interface: IUnit

Create a quantity expressed in this unit and with a numerical quantity value equal to numericalValue.

Specified by:

quantity in interface IUnit

quantity

public abstract ITypedQuantity<U> quantity(long numericalValue)

Description copied from interface: IUnit

Create a quantity expressed in this unit and with a numerical quantity value equal to numericalValue.

Specified by:

quantity in interface IUnit

quantity

public abstract ITypedQuantity<U> quantity(double numericalValue)

Description copied from interface: IUnit

Create a quantity expressed in this unit and with a numerical quantity value equal to numericalValue.

Specified by:

quantity in interface IUnit

valueTransformTo

public IScalarAffineTransform valueTransformTo(IUnit targetUnit)

Description copied from interface: IUnit

Get a transform for transforming numerical quantity values expressed in this unit to numerical quantity values expressed in targetUnit. This method is typically only used internally by the quantity implementations.

Specified by:

valueTransformTo in interface IUnit

valueTransformTo

public abstract IScalarAffineTransform valueTransformTo(U targetUnit)

Get a transform for transforming numerical quantity values expressed in this unit to numerical quantity values expressed in targetUnit. This method is typically only used internally by the quantity implementations. Note that this method differs from valueTransformTo(IUnit) only by stricter typing.

Throws:

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

addPossiblyIntegral

protected final ITypedQuantity<U> addPossiblyIntegral(long numericalAugend,
                                                      IScalarAffineTransform addendValueTransform,
                                                      long numericalAddend)

add

protected abstract ITypedQuantity<U> add(long numericalAugend,
                                         LinearUnit addendUnit,
                                         long numericalAddend)

subtractSame

protected abstract ITypedQuantity<LinearUnit> subtractSame(long numericalMinuend,
                                                           U subtrahendUnit,
                                                           long numericalSubtrahend)

floorQuantize

protected abstract ITypedQuantity<U> floorQuantize(long numericalValue,
                                                   ITypedQuantity<LinearUnit> quanta)

floorQuantize

protected abstract ITypedQuantity<U> floorQuantize(double numericalValue,
                                                   ITypedQuantity<LinearUnit> quanta)

localizedFormatFor

protected abstract java.lang.String localizedFormatFor(java.lang.Number numericalValue,
                                                       boolean useBreakingSpace,
                                                       boolean allowCustomUnit)

persistableStringFor

protected abstract java.lang.String persistableStringFor(java.lang.Number numericalValue)