Class AbstractUnit<Q extends javax.measure.Quantity<Q>>
- All Implemented Interfaces:
Serializable
,Comparable<javax.measure.Unit<Q>>
,javax.measure.Unit<Q>
,ComparableUnit<Q>
- Direct Known Subclasses:
AlternateUnit
,AnnotatedUnit
,BaseUnit
,ProductUnit
,TransformedUnit
The class represents units founded on the seven SI base units for seven base quantities assumed to be mutually independent.
For all physics units, unit conversions are symmetrical:
u1.getConverterTo(u2).equals(u2.getConverterTo(u1).inverse())
.
Non-physical units (e.g. currency units) for which conversion is not
symmetrical should have their own separate class hierarchy and are considered
distinct (e.g. financial units), although they can always be combined with
physics units (e.g. "€/Kg", "$/h").
- Since:
- 1.0
- Version:
- 1.2, April 11, 2018
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprotected static final class
Utility class for number comparison and equality -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected String
Holds the name.static final javax.measure.Unit<javax.measure.quantity.Dimensionless>
Holds the dimensionless unitONE
.private static final long
private String
Holds the symbol.Holds the unique symbols collection (base units or alternate units). -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionfinal javax.measure.Unit<Q>
javax.measure.Unit<Q>
Annotates the specified unit.final <T extends javax.measure.Quantity<T>>
AbstractUnit<T>Casts this unit to a parameterized unit of specified nature or throw a ClassCastException if the dimension of the specified quantity and this unit's dimension do not match (regardless whether or not the dimensions are independent or not).int
Compares this unit to the specified unit.(package private) static javax.measure.UnitConverter
converterOf
(double factor) final javax.measure.Unit<Q>
divide
(double divisor) Returns the result of dividing this unit by the specified divisor.final javax.measure.Unit<?>
divide
(javax.measure.Unit<?> that) Returns the quotient of this unit with the one specified.protected final javax.measure.Unit<?>
divide
(AbstractUnit<?> that) Returns the quotient of this physical unit with the one specified.abstract boolean
protected Type
final javax.measure.UnitConverter
getConverterTo
(javax.measure.Unit<Q> that) final javax.measure.UnitConverter
getConverterToAny
(javax.measure.Unit<?> that) abstract javax.measure.Dimension
getName()
abstract javax.measure.UnitConverter
Returns the converter from this unit to its unscaledSystem Unit
unit.final javax.measure.Unit<Q>
Returns the system unit (unscaled SI unit) from which this unit is derived.abstract int
hashCode()
private final javax.measure.UnitConverter
internalGetConverterTo
(javax.measure.Unit<Q> that, boolean useEquals) private final boolean
internalIsCompatible
(javax.measure.Unit<?> that, boolean checkEquals) Internal helper for isCompatiblefinal javax.measure.Unit<?>
inverse()
Returns the inverse of this physical unit.final boolean
isCompatible
(javax.measure.Unit<?> that) Indicates if this unit is compatible with the unit specified.boolean
isEquivalentOf
(javax.measure.Unit<Q> that) Compares two instances of, doing the conversion of unit if necessary.
private static boolean
isLongValue
(double value) boolean
Indicates if this unit belongs to the set of coherent SI units (unscaled SI units).final javax.measure.Unit<Q>
multiply
(double factor) final javax.measure.Unit<?>
multiply
(javax.measure.Unit<?> that) Returns the product of this unit with the one specified.protected final javax.measure.Unit<?>
multiply
(AbstractUnit<?> that) Returns the product of this physical unit with the one specified.static javax.measure.Unit<?>
parse
(CharSequence charSequence) Returns the abstract unit represented by the specified characters as per default format.final javax.measure.Unit<?>
pow
(int n) Returns a unit equals to this unit raised to an exponent.final javax.measure.Unit<?>
root
(int n) Returns a unit equals to the given root of this unit.protected void
protected void
final javax.measure.Unit<Q>
shift
(double offset) toString()
Returns the standard representation of this physics unit.protected abstract javax.measure.Unit<Q>
Returns the unscaledSI
unit from which this unit is derived.final javax.measure.Unit<Q>
transform
(javax.measure.UnitConverter operation)
-
Field Details
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
ONE
public static final javax.measure.Unit<javax.measure.quantity.Dimensionless> ONEHolds the dimensionless unitONE
. -
name
Holds the name. -
symbol
Holds the symbol. -
SYMBOL_TO_UNIT
Holds the unique symbols collection (base units or alternate units).
-
-
Constructor Details
-
AbstractUnit
protected AbstractUnit()Default constructor.
-
-
Method Details
-
getActualType
-
isSystemUnit
public boolean isSystemUnit()Indicates if this unit belongs to the set of coherent SI units (unscaled SI units). The base and coherent derived units of the SI form a coherent set, designated the set of coherent SI units. The word coherent is used here in the following sense: when coherent units are used, equations between the numerical values of quantities take exactly the same form as the equations between the quantities themselves. Thus if only units from a coherent set are used, conversion factors between units are never required.- Specified by:
isSystemUnit
in interfaceComparableUnit<Q extends javax.measure.Quantity<Q>>
- Returns:
equals(toSystemUnit())
-
toSystemUnit
Returns the unscaledSI
unit from which this unit is derived. The SI unit can be be used to identify a quantity given the unit. For example:static boolean isAngularVelocity(AbstractUnit<?> unit) { return unit.toSystemUnit().equals(RADIAN.divide(SECOND)); } assert(REVOLUTION.divide(MINUTE).isAngularVelocity()); // Returns true.
- Returns:
- the unscaled metric unit from which this unit is derived.
-
getSystemConverter
public abstract javax.measure.UnitConverter getSystemConverter()Returns the converter from this unit to its unscaledSystem Unit
unit.- Returns:
getConverterTo(this.toSystemUnit())
- See Also:
-
annotate
Annotates the specified unit. Annotation does not change the unit semantic. Annotations are often written between curly braces behind units. For example:
Unit
Note: Annotation of system units are not considered themselves as system units.PERCENT_VOL = ((AbstractUnit)Units.PERCENT).annotate("vol"); // "%{vol}" Unit KG_TOTAL = ((AbstractUnit)Units.KILOGRAM).annotate("total"); // "kg{total}" Unit RED_BLOOD_CELLS = ((AbstractUnit)Units.ONE).annotate("RBC"); // "{RBC}" - Parameters:
annotation
- the unit annotation.- Returns:
- the annotated unit.
-
parse
Returns the abstract unit represented by the specified characters as per default format. Locale-sensitive unit parsing could be handled usingLocalUnitFormat
in subclasses of AbstractUnit.Note: The standard format supports dimensionless units.
AbstractUnit
PERCENT = AbstractUnit.parse("100").inverse().asType(Dimensionless.class); - Parameters:
charSequence
- the character sequence to parse.- Returns:
SimpleUnitFormat.getInstance().parse(csq, new ParsePosition(0))
- Throws:
javax.measure.format.ParserException
- if the specified character sequence cannot be correctly parsed (e.g. not UCUM compliant).
-
toString
Returns the standard representation of this physics unit. The string produced for a given unit is always the same; it is not affected by the locale. It can be used as a canonical string representation for exchanging units, or as a key for a Hashtable, etc. Locale-sensitive unit parsing could be handled usingLocalUnitFormat
in subclasses of AbstractUnit. -
getSystemUnit
Returns the system unit (unscaled SI unit) from which this unit is derived. They can be be used to identify a quantity given the unit. For example:
static boolean isAngularVelocity(AbstractUnit<?> unit) {
return unit.getSystemUnit().equals(RADIAN.divide(SECOND));
}
assert(REVOLUTION.divide(MINUTE).isAngularVelocity()); // Returns true. -
isCompatible
public final boolean isCompatible(javax.measure.Unit<?> that) Indicates if this unit is compatible with the unit specified. To be compatible both units must be physics units having the same fundamental dimension. -
asType
Casts this unit to a parameterized unit of specified nature or throw a ClassCastException if the dimension of the specified quantity and this unit's dimension do not match (regardless whether or not the dimensions are independent or not).- Specified by:
asType
in interfacejavax.measure.Unit<Q extends javax.measure.Quantity<Q>>
- Parameters:
type
- the quantity class identifying the nature of the unit.- Throws:
ClassCastException
- if the dimension of this unit is different from the SI dimension of the specified type.- See Also:
-
getBaseUnits
-
getDimension
public abstract javax.measure.Dimension getDimension() -
setName
-
getName
-
getSymbol
-
setSymbol
-
getConverterTo
public final javax.measure.UnitConverter getConverterTo(javax.measure.Unit<Q> that) throws javax.measure.UnconvertibleException -
getConverterToAny
public final javax.measure.UnitConverter getConverterToAny(javax.measure.Unit<?> that) throws javax.measure.IncommensurableException, javax.measure.UnconvertibleException -
alternate
-
transform
-
shift
-
multiply
-
internalIsCompatible
private final boolean internalIsCompatible(javax.measure.Unit<?> that, boolean checkEquals) Internal helper for isCompatible -
internalGetConverterTo
private final javax.measure.UnitConverter internalGetConverterTo(javax.measure.Unit<Q> that, boolean useEquals) throws javax.measure.UnconvertibleException - Throws:
javax.measure.UnconvertibleException
-
isLongValue
private static boolean isLongValue(double value) -
converterOf
static javax.measure.UnitConverter converterOf(double factor) -
multiply
public final javax.measure.Unit<?> multiply(javax.measure.Unit<?> that) Returns the product of this unit with the one specified.Note: If the specified unit (that) is not a physical unit, then
that.multiply(this)
is returned. -
multiply
Returns the product of this physical unit with the one specified.- Parameters:
that
- the physical unit multiplicand.- Returns:
this * that
-
inverse
public final javax.measure.Unit<?> inverse()Returns the inverse of this physical unit. -
divide
Returns the result of dividing this unit by the specified divisor. If the factor is an integer value, the division is exact. For example:QUART = GALLON_LIQUID_US.divide(4); // Exact definition.
-
divide
public final javax.measure.Unit<?> divide(javax.measure.Unit<?> that) Returns the quotient of this unit with the one specified. -
divide
Returns the quotient of this physical unit with the one specified.- Parameters:
that
- the physical unit divisor.- Returns:
this.multiply(that.inverse())
-
root
public final javax.measure.Unit<?> root(int n) Returns a unit equals to the given root of this unit.- Specified by:
root
in interfacejavax.measure.Unit<Q extends javax.measure.Quantity<Q>>
- Parameters:
n
- the root's order.- Returns:
- the result of taking the given root of this unit.
- Throws:
ArithmeticException
- ifn == 0
or if this operation would result in an unit with a fractional exponent.
-
pow
public final javax.measure.Unit<?> pow(int n) Returns a unit equals to this unit raised to an exponent. -
prefix
-
compareTo
Compares this unit to the specified unit. The default implementation compares the name and symbol of both this unit and the specified unit.- Specified by:
compareTo
in interfaceComparable<Q extends javax.measure.Quantity<Q>>
- Returns:
- a negative integer, zero, or a positive integer as this unit is less than, equal to, or greater than the specified unit.
-
isEquivalentOf
Description copied from interface:ComparableUnit
Compares two instances of, doing the conversion of unit if necessary.
- Specified by:
isEquivalentOf
in interfaceComparableUnit<Q extends javax.measure.Quantity<Q>>
- Parameters:
that
- theUnit<Q>
to be compared with this instance.- Returns:
true
ifthat < this
.
-
equals
-
hashCode
public abstract int hashCode()
-