A unit such as length, mass, volume, currency, etc. A unit is coupled with a numeric amount to produce a Measure. MeasureUnit objects are immutable. All subclasses must guarantee that. (However, subclassing is discouraged.)
enumMeasureUnit.Complexity
Enumeration for unit complexity.
enumMeasureUnit.MeasurePrefix
Enumeration for SI and binary prefixes, e.g. "kilo-", "nano-", "mebi-".
Fields | |
|---|---|
public
static
final
MeasureUnit |
ACRE
Constant for unit of area: acre |
public
static
final
MeasureUnit |
ACRE_FOOT
Constant for unit of volume: acre-foot |
public
static
final
MeasureUnit |
AMPERE
Constant for unit of electric: ampere |
public
static
final
MeasureUnit |
ARC_MINUTE
Constant for unit of angle: arc-minute |
public
static
final
MeasureUnit |
ARC_SECOND
Constant for unit of angle: arc-second |
public
static
final
MeasureUnit |
ASTRONOMICAL_UNIT
Constant for unit of length: astronomical-unit |
public
static
final
MeasureUnit |
ATMOSPHERE
Constant for unit of pressure: atmosphere |
public
static
final
MeasureUnit |
BIT
Constant for unit of digital: bit |
public
static
final
MeasureUnit |
BUSHEL
Constant for unit of volume: bushel |
public
static
final
MeasureUnit |
BYTE
Constant for unit of digital: byte |
public
static
final
MeasureUnit |
CALORIE
Constant for unit of energy: calorie |
public
static
final
MeasureUnit |
CANDELA
Constant for unit of light: candela |
public
static
final
MeasureUnit |
CARAT
Constant for unit of mass: carat |
public
static
final
MeasureUnit |
CELSIUS
Constant for unit of temperature: celsius |
public
static
final
MeasureUnit |
CENTILITER
Constant for unit of volume: centiliter |
public
static
final
MeasureUnit |
CENTIMETER
Constant for unit of length: centimeter |
public
static
final
MeasureUnit |
CENTURY
Constant for unit of duration: century |
public
static
final
MeasureUnit |
CUBIC_CENTIMETER
Constant for unit of volume: cubic-centimeter |
public
static
final
MeasureUnit |
CUBIC_FOOT
Constant for unit of volume: cubic-foot |
public
static
final
MeasureUnit |
CUBIC_INCH
Constant for unit of volume: cubic-inch |
public
static
final
MeasureUnit |
CUBIC_KILOMETER
Constant for unit of volume: cubic-kilometer |
public
static
final
MeasureUnit |
CUBIC_METER
Constant for unit of volume: cubic-meter |
public
static
final
MeasureUnit |
CUBIC_MILE
Constant for unit of volume: cubic-mile |
public
static
final
MeasureUnit |
CUBIC_YARD
Constant for unit of volume: cubic-yard |
public
static
final
MeasureUnit |
CUP
Constant for unit of volume: cup |
public
static
final
MeasureUnit |
CUP_METRIC
Constant for unit of volume: cup-metric |
public
static
final
TimeUnit |
DAY
Constant for unit of duration: day |
public
static
final
MeasureUnit |
DECADE
Constant for unit of duration: decade |
public
static
final
MeasureUnit |
DECILITER
Constant for unit of volume: deciliter |
public
static
final
MeasureUnit |
DECIMETER
Constant for unit of length: decimeter |
public
static
final
MeasureUnit |
DEGREE
Constant for unit of angle: degree |
public
static
final
MeasureUnit |
DOT
Constant for unit of graphics: dot |
public
static
final
MeasureUnit |
DOT_PER_CENTIMETER
Constant for unit of graphics: dot-per-centimeter |
public
static
final
MeasureUnit |
DOT_PER_INCH
Constant for unit of graphics: dot-per-inch |
public
static
final
MeasureUnit |
EM
Constant for unit of graphics: em |
public
static
final
MeasureUnit |
FAHRENHEIT
Constant for unit of temperature: fahrenheit |
public
static
final
MeasureUnit |
FATHOM
Constant for unit of length: fathom |
public
static
final
MeasureUnit |
FLUID_OUNCE
Constant for unit of volume: fluid-ounce |
public
static
final
MeasureUnit |
FOODCALORIE
Constant for unit of energy: foodcalorie |
public
static
final
MeasureUnit |
FOOT
Constant for unit of length: foot |
public
static
final
MeasureUnit |
FURLONG
Constant for unit of length: furlong |
public
static
final
MeasureUnit |
GALLON
Constant for unit of volume: gallon |
public
static
final
MeasureUnit |
GALLON_IMPERIAL
Constant for unit of volume: gallon-imperial |
public
static
final
MeasureUnit |
GENERIC_TEMPERATURE
Constant for unit of temperature: generic |
public
static
final
MeasureUnit |
GIGABIT
Constant for unit of digital: gigabit |
public
static
final
MeasureUnit |
GIGABYTE
Constant for unit of digital: gigabyte |
public
static
final
MeasureUnit |
GIGAHERTZ
Constant for unit of frequency: gigahertz |
public
static
final
MeasureUnit |
GIGAWATT
Constant for unit of power: gigawatt |
public
static
final
MeasureUnit |
GRAM
Constant for unit of mass: gram |
public
static
final
MeasureUnit |
G_FORCE
Constant for unit of acceleration: g-force |
public
static
final
MeasureUnit |
HECTARE
Constant for unit of area: hectare |
public
static
final
MeasureUnit |
HECTOLITER
Constant for unit of volume: hectoliter |
public
static
final
MeasureUnit |
HECTOPASCAL
Constant for unit of pressure: hectopascal |
public
static
final
MeasureUnit |
HERTZ
Constant for unit of frequency: hertz |
public
static
final
MeasureUnit |
HORSEPOWER
Constant for unit of power: horsepower |
public
static
final
TimeUnit |
HOUR
Constant for unit of duration: hour |
public
static
final
MeasureUnit |
INCH
Constant for unit of length: inch |
public
static
final
MeasureUnit |
INCH_HG
Constant for unit of pressure: inch-ofhg |
public
static
final
MeasureUnit |
ITEM
Constant for unit of concentr: item |
public
static
final
MeasureUnit |
JOULE
Constant for unit of energy: joule |
public
static
final
MeasureUnit |
KARAT
Constant for unit of concentr: karat |
public
static
final
MeasureUnit |
KELVIN
Constant for unit of temperature: kelvin |
public
static
final
MeasureUnit |
KILOBIT
Constant for unit of digital: kilobit |
public
static
final
MeasureUnit |
KILOBYTE
Constant for unit of digital: kilobyte |
public
static
final
MeasureUnit |
KILOCALORIE
Constant for unit of energy: kilocalorie |
public
static
final
MeasureUnit |
KILOGRAM
Constant for unit of mass: kilogram |
public
static
final
MeasureUnit |
KILOHERTZ
Constant for unit of frequency: kilohertz |
public
static
final
MeasureUnit |
KILOJOULE
Constant for unit of energy: kilojoule |
public
static
final
MeasureUnit |
KILOMETER
Constant for unit of length: kilometer |
public
static
final
MeasureUnit |
KILOMETER_PER_HOUR
Constant for unit of speed: kilometer-per-hour |
public
static
final
MeasureUnit |
KILOWATT
Constant for unit of power: kilowatt |
public
static
final
MeasureUnit |
KILOWATT_HOUR
Constant for unit of energy: kilowatt-hour |
public
static
final
MeasureUnit |
KILOWATT_HOUR_PER_100_KILOMETER
Constant for unit of force: kilowatt-hour-per-100-kilometer |
public
static
final
MeasureUnit |
KNOT
Constant for unit of speed: knot |
public
static
final
MeasureUnit |
LIGHT_YEAR
Constant for unit of length: light-year |
public
static
final
MeasureUnit |
LITER
Constant for unit of volume: liter |
public
static
final
MeasureUnit |
LITER_PER_100KILOMETERS
Constant for unit of consumption: liter-per-100-kilometer |
public
static
final
MeasureUnit |
LITER_PER_KILOMETER
Constant for unit of consumption: liter-per-kilometer |
public
static
final
MeasureUnit |
LUMEN
Constant for unit of light: lumen |
public
static
final
MeasureUnit |
LUX
Constant for unit of light: lux |
public
static
final
MeasureUnit |
MEGABIT
Constant for unit of digital: megabit |
public
static
final
MeasureUnit |
MEGABYTE
Constant for unit of digital: megabyte |
public
static
final
MeasureUnit |
MEGAHERTZ
Constant for unit of frequency: megahertz |
public
static
final
MeasureUnit |
MEGALITER
Constant for unit of volume: megaliter |
public
static
final
MeasureUnit |
MEGAPIXEL
Constant for unit of graphics: megapixel |
public
static
final
MeasureUnit |
MEGAWATT
Constant for unit of power: megawatt |
public
static
final
MeasureUnit |
METER
Constant for unit of length: meter |
public
static
final
MeasureUnit |
METER_PER_SECOND
Constant for unit of speed: meter-per-second |
public
static
final
MeasureUnit |
METER_PER_SECOND_SQUARED
Constant for unit of acceleration: meter-per-square-second |
public
static
final
MeasureUnit |
METRIC_TON
Constant for unit of mass: metric-ton (renamed to tonne in CLDR 42 / ICU 72). |
public
static
final
MeasureUnit |
MICROGRAM
Constant for unit of mass: microgram |
public
static
final
MeasureUnit |
MICROMETER
Constant for unit of length: micrometer |
public
static
final
MeasureUnit |
MICROSECOND
Constant for unit of duration: microsecond |
public
static
final
MeasureUnit |
MILE
Constant for unit of length: mile |
public
static
final
MeasureUnit |
MILE_PER_GALLON
Constant for unit of consumption: mile-per-gallon |
public
static
final
MeasureUnit |
MILE_PER_GALLON_IMPERIAL
Constant for unit of consumption: mile-per-gallon-imperial |
public
static
final
MeasureUnit |
MILE_PER_HOUR
Constant for unit of speed: mile-per-hour |
public
static
final
MeasureUnit |
MILE_SCANDINAVIAN
Constant for unit of length: mile-scandinavian |
public
static
final
MeasureUnit |
MILLIAMPERE
Constant for unit of electric: milliampere |
public
static
final
MeasureUnit |
MILLIBAR
Constant for unit of pressure: millibar |
public
static
final
MeasureUnit |
MILLIGRAM
Constant for unit of mass: milligram |
public
static
final
MeasureUnit |
MILLIGRAM_OFGLUCOSE_PER_DECILITER
Constant for unit of concentr: milligram-ofglucose-per-deciliter |
public
static
final
MeasureUnit |
MILLIGRAM_PER_DECILITER
Constant for unit of concentr: milligram-per-deciliter |
public
static
final
MeasureUnit |
MILLILITER
Constant for unit of volume: milliliter |
public
static
final
MeasureUnit |
MILLIMETER
Constant for unit of length: millimeter |
public
static
final
MeasureUnit |
MILLIMETER_OF_MERCURY
Constant for unit of pressure: millimeter-ofhg |
public
static
final
MeasureUnit |
MILLIMOLE_PER_LITER
Constant for unit of concentr: millimole-per-liter |
public
static
final
MeasureUnit |
MILLISECOND
Constant for unit of duration: millisecond |
public
static
final
MeasureUnit |
MILLIWATT
Constant for unit of power: milliwatt |
public
static
final
TimeUnit |
MINUTE
Constant for unit of duration: minute |
public
static
final
TimeUnit |
MONTH
Constant for unit of duration: month |
public
static
final
MeasureUnit |
NANOMETER
Constant for unit of length: nanometer |
public
static
final
MeasureUnit |
NANOSECOND
Constant for unit of duration: nanosecond |
public
static
final
MeasureUnit |
NAUTICAL_MILE
Constant for unit of length: nautical-mile |
public
static
final
MeasureUnit |
OHM
Constant for unit of electric: ohm |
public
static
final
MeasureUnit |
OUNCE
Constant for unit of mass: ounce |
public
static
final
MeasureUnit |
OUNCE_TROY
Constant for unit of mass: ounce-troy |
public
static
final
MeasureUnit |
PARSEC
Constant for unit of length: parsec |
public
static
final
MeasureUnit |
PART_PER_MILLION
Constant for unit of concentr: permillion |
public
static
final
MeasureUnit |
PERCENT
Constant for unit of concentr: percent |
public
static
final
MeasureUnit |
PERMILLE
Constant for unit of concentr: permille |
public
static
final
MeasureUnit |
PETABYTE
Constant for unit of digital: petabyte |
public
static
final
MeasureUnit |
PICOMETER
Constant for unit of length: picometer |
public
static
final
MeasureUnit |
PINT
Constant for unit of volume: pint |
public
static
final
MeasureUnit |
PINT_METRIC
Constant for unit of volume: pint-metric |
public
static
final
MeasureUnit |
PIXEL
Constant for unit of graphics: pixel |
public
static
final
MeasureUnit |
PIXEL_PER_CENTIMETER
Constant for unit of graphics: pixel-per-centimeter |
public
static
final
MeasureUnit |
PIXEL_PER_INCH
Constant for unit of graphics: pixel-per-inch |
public
static
final
MeasureUnit |
POINT
Constant for unit of length: point |
public
static
final
MeasureUnit |
POUND
Constant for unit of mass: pound |
public
static
final
MeasureUnit |
POUND_PER_SQUARE_INCH
Constant for unit of pressure: pound-force-per-square-inch |
public
static
final
MeasureUnit |
QUART
Constant for unit of volume: quart |
public
static
final
MeasureUnit |
RADIAN
Constant for unit of angle: radian |
public
static
final
MeasureUnit |
REVOLUTION_ANGLE
Constant for unit of angle: revolution |
public
static
final
TimeUnit |
SECOND
Constant for unit of duration: second |
public
static
final
MeasureUnit |
SQUARE_CENTIMETER
Constant for unit of area: square-centimeter |
public
static
final
MeasureUnit |
SQUARE_FOOT
Constant for unit of area: square-foot |
public
static
final
MeasureUnit |
SQUARE_INCH
Constant for unit of area: square-inch |
public
static
final
MeasureUnit |
SQUARE_KILOMETER
Constant for unit of area: square-kilometer |
public
static
final
MeasureUnit |
SQUARE_METER
Constant for unit of area: square-meter |
public
static
final
MeasureUnit |
SQUARE_MILE
Constant for unit of area: square-mile |
public
static
final
MeasureUnit |
SQUARE_YARD
Constant for unit of area: square-yard |
public
static
final
MeasureUnit |
STONE
Constant for unit of mass: stone |
public
static
final
MeasureUnit |
TABLESPOON
Constant for unit of volume: tablespoon |
public
static
final
MeasureUnit |
TEASPOON
Constant for unit of volume: teaspoon |
public
static
final
MeasureUnit |
TERABIT
Constant for unit of digital: terabit |
public
static
final
MeasureUnit |
TERABYTE
Constant for unit of digital: terabyte |
public
static
final
MeasureUnit |
TON
Constant for unit of mass: ton |
public
static
final
MeasureUnit |
VOLT
Constant for unit of electric: volt |
public
static
final
MeasureUnit |
WATT
Constant for unit of power: watt |
public
static
final
TimeUnit |
WEEK
Constant for unit of duration: week |
public
static
final
MeasureUnit |
YARD
Constant for unit of length: yard |
public
static
final
TimeUnit |
YEAR
Constant for unit of duration: year |
Public methods | |
|---|---|
boolean
|
equals(Object rhs)
Indicates whether some other object is "equal to" this one. |
static
MeasureUnit
|
forIdentifier(String identifier)
Construct a MeasureUnit from a CLDR Core Unit Identifier, defined in UTS 35. |
static
Set<MeasureUnit>
|
getAvailable(String type)
For the given type, return the available units. |
static
Set<MeasureUnit>
|
getAvailable()
Get all of the available units. |
static
Set<String>
|
getAvailableTypes()
Get all of the available units' types. |
MeasureUnit.Complexity
|
getComplexity()
Compute the complexity of the unit. |
int
|
getDimensionality()
Returns the dimensionality (power) of this MeasureUnit. |
String
|
getIdentifier()
Get CLDR Unit Identifier for this MeasureUnit, as defined in UTS 35. |
MeasureUnit.MeasurePrefix
|
getPrefix()
Returns the current SI or binary prefix of this SINGLE unit. |
String
|
getSubtype()
Get the subType, such as “foot”. |
String
|
getType()
Get the type, such as "length". |
int
|
hashCode()
Returns a hash code value for the object. |
MeasureUnit
|
product(MeasureUnit other)
Computes the product of this unit with another unit. |
MeasureUnit
|
reciprocal()
Computes the reciprocal of this MeasureUnit, with the numerator and denominator flipped. |
List<MeasureUnit>
|
splitToSingleUnits()
Returns the list of SINGLE units contained within a sequence of COMPOUND units. |
String
|
toString()
Returns a string representation of the object. |
MeasureUnit
|
withDimensionality(int dimensionality)
Creates a MeasureUnit which is this SINGLE unit augmented with the specified dimensionality (power). |
MeasureUnit
|
withPrefix(MeasureUnit.MeasurePrefix prefix)
Creates a MeasureUnit which is this SINGLE unit augmented with the specified prefix. |
Inherited methods | |||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
From class
| |||||||||||||||||||||||
public static final MeasureUnit ASTRONOMICAL_UNIT
Constant for unit of length: astronomical-unit
public static final MeasureUnit CUBIC_CENTIMETER
Constant for unit of volume: cubic-centimeter
public static final MeasureUnit CUBIC_KILOMETER
Constant for unit of volume: cubic-kilometer
public static final MeasureUnit DOT_PER_CENTIMETER
Constant for unit of graphics: dot-per-centimeter
public static final MeasureUnit DOT_PER_INCH
Constant for unit of graphics: dot-per-inch
public static final MeasureUnit GALLON_IMPERIAL
Constant for unit of volume: gallon-imperial
public static final MeasureUnit GENERIC_TEMPERATURE
Constant for unit of temperature: generic
public static final MeasureUnit KILOMETER_PER_HOUR
Constant for unit of speed: kilometer-per-hour
public static final MeasureUnit KILOWATT_HOUR
Constant for unit of energy: kilowatt-hour
public static final MeasureUnit KILOWATT_HOUR_PER_100_KILOMETER
Constant for unit of force: kilowatt-hour-per-100-kilometer
public static final MeasureUnit LITER_PER_100KILOMETERS
Constant for unit of consumption: liter-per-100-kilometer
public static final MeasureUnit LITER_PER_KILOMETER
Constant for unit of consumption: liter-per-kilometer
public static final MeasureUnit METER_PER_SECOND
Constant for unit of speed: meter-per-second
public static final MeasureUnit METER_PER_SECOND_SQUARED
Constant for unit of acceleration: meter-per-square-second
public static final MeasureUnit METRIC_TON
Constant for unit of mass: metric-ton (renamed to tonne in CLDR 42 / ICU 72). Note: In ICU 74 this will be deprecated in favor of TONNE, which is currently draft but will become stable in ICU 74, and which uses the preferred naming.
public static final MeasureUnit MILE_PER_GALLON
Constant for unit of consumption: mile-per-gallon
public static final MeasureUnit MILE_PER_GALLON_IMPERIAL
Constant for unit of consumption: mile-per-gallon-imperial
public static final MeasureUnit MILE_PER_HOUR
Constant for unit of speed: mile-per-hour
public static final MeasureUnit MILE_SCANDINAVIAN
Constant for unit of length: mile-scandinavian
public static final MeasureUnit MILLIGRAM_OFGLUCOSE_PER_DECILITER
Constant for unit of concentr: milligram-ofglucose-per-deciliter
public static final MeasureUnit MILLIGRAM_PER_DECILITER
Constant for unit of concentr: milligram-per-deciliter
public static final MeasureUnit MILLIMETER_OF_MERCURY
Constant for unit of pressure: millimeter-ofhg
public static final MeasureUnit MILLIMOLE_PER_LITER
Constant for unit of concentr: millimole-per-liter
public static final MeasureUnit NAUTICAL_MILE
Constant for unit of length: nautical-mile
public static final MeasureUnit PART_PER_MILLION
Constant for unit of concentr: permillion
public static final MeasureUnit PIXEL_PER_CENTIMETER
Constant for unit of graphics: pixel-per-centimeter
public static final MeasureUnit PIXEL_PER_INCH
Constant for unit of graphics: pixel-per-inch
public static final MeasureUnit POUND_PER_SQUARE_INCH
Constant for unit of pressure: pound-force-per-square-inch
public static final MeasureUnit REVOLUTION_ANGLE
Constant for unit of angle: revolution
public static final MeasureUnit SQUARE_CENTIMETER
Constant for unit of area: square-centimeter
public static final MeasureUnit SQUARE_KILOMETER
Constant for unit of area: square-kilometer
public boolean equals (Object rhs)
Indicates whether some other object is "equal to" this one.
The equals method implements an equivalence relation
on non-null object references:
x, x.equals(x) should return
true.
x and y, x.equals(y)
should return true if and only if
y.equals(x) returns true.
x, y, and z, if
x.equals(y) returns true and
y.equals(z) returns true, then
x.equals(z) should return true.
x and y, multiple invocations of
x.equals(y) consistently return true
or consistently return false, provided no
information used in equals comparisons on the
objects is modified.
x,
x.equals(null) should return false.
The equals method for class Object implements
the most discriminating possible equivalence relation on objects;
that is, for any non-null reference values x and
y, this method returns true if and only
if x and y refer to the same object
(x == y has the value true).
Note that it is generally necessary to override the hashCode
method whenever this method is overridden, so as to maintain the
general contract for the hashCode method, which states
that equal objects must have equal hash codes.
| Parameters | |
|---|---|
rhs |
Object: the reference object with which to compare. |
| Returns | |
|---|---|
boolean |
true if this object is the same as the obj
argument; false otherwise. |
public static MeasureUnit forIdentifier (String identifier)
Construct a MeasureUnit from a CLDR Core Unit Identifier, defined in UTS
35. (Core unit identifiers and mixed unit identifiers are supported, long
unit identifiers are not.) Validates and canonicalizes the identifier.
Note: dimensionless MeasureUnit is null
MeasureUnit example = MeasureUnit::forIdentifier("furlong-per-nanosecond")
| Parameters | |
|---|---|
identifier |
String: CLDR Unit Identifier |
| Returns | |
|---|---|
MeasureUnit |
|
| Throws | |
|---|---|
IllegalArgumentException |
if the identifier is invalid. |
public static Set<MeasureUnit> getAvailable (String type)
For the given type, return the available units.
| Parameters | |
|---|---|
type |
String: the type |
| Returns | |
|---|---|
Set<MeasureUnit> |
the available units for type. Returned set is unmodifiable. |
public static Set<MeasureUnit> getAvailable ()
Get all of the available units. Returned set is unmodifiable.
| Returns | |
|---|---|
Set<MeasureUnit> |
|
public static Set<String> getAvailableTypes ()
Get all of the available units' types. Returned set is unmodifiable.
| Returns | |
|---|---|
Set<String> |
|
public MeasureUnit.Complexity getComplexity ()
Compute the complexity of the unit. See Complexity for more information.
| Returns | |
|---|---|
MeasureUnit.Complexity |
The unit complexity. |
public int getDimensionality ()
Returns the dimensionality (power) of this MeasureUnit. For example, if the unit is square, then 2 is returned.
NOTE: Only works on SINGLE units. If this is a COMPOUND or MIXED unit, an exception will be thrown. For more information, see `Complexity`.
| Returns | |
|---|---|
int |
The dimensionality (power) of this simple unit. |
| Throws | |
|---|---|
UnsupportedOperationException |
if the unit is COMPOUND or MIXED. |
public String getIdentifier ()
Get CLDR Unit Identifier for this MeasureUnit, as defined in UTS 35.
| Returns | |
|---|---|
String |
The string form of this unit. |
public MeasureUnit.MeasurePrefix getPrefix ()
Returns the current SI or binary prefix of this SINGLE unit. For example, if the unit has the prefix "kilo", then MeasurePrefix.KILO is returned.
NOTE: Only works on SINGLE units. If this is a COMPOUND or MIXED unit, an error will occur. For more information, see `Complexity`.
| Returns | |
|---|---|
MeasureUnit.MeasurePrefix |
The prefix of this SINGLE unit, from MeasurePrefix. |
| Throws | |
|---|---|
UnsupportedOperationException |
if the unit is COMPOUND or MIXED. |
public String getSubtype ()
Get the subType, such as “foot”. May return null.
| Returns | |
|---|---|
String |
|
public int hashCode ()
Returns a hash code value for the object. This method is
supported for the benefit of hash tables such as those provided by
HashMap.
The general contract of hashCode is:
hashCode method
must consistently return the same integer, provided no information
used in equals comparisons on the object is modified.
This integer need not remain consistent from one execution of an
application to another execution of the same application.
equals(Object)
method, then calling the hashCode method on each of
the two objects must produce the same integer result.
equals(java.lang.Object)
method, then calling the hashCode method on each of the
two objects must produce distinct integer results. However, the
programmer should be aware that producing distinct integer results
for unequal objects may improve the performance of hash tables.
As much as is reasonably practical, the hashCode method defined
by class Object does return distinct integers for
distinct objects. (The hashCode may or may not be implemented
as some function of an object's memory address at some point
in time.)
| Returns | |
|---|---|
int |
a hash code value for this object. |
public MeasureUnit product (MeasureUnit other)
Computes the product of this unit with another unit. This is a way to build units from constituent parts.
The numerator and denominator are preserved through this operation.
For example, if the receiver is "kilowatt" and the argument is "hour-per-day", then the unit "kilowatt-hour-per-day" is returned.
NOTE: Only works on SINGLE and COMPOUND units. If either unit (receivee and argument) is a MIXED unit, an error will occur. For more information, see `Complexity`.
| Parameters | |
|---|---|
other |
MeasureUnit: The MeasureUnit to multiply with the target. |
| Returns | |
|---|---|
MeasureUnit |
The product of the target unit with the provided unit. |
| Throws | |
|---|---|
UnsupportedOperationException |
if the unit is MIXED. |
public MeasureUnit reciprocal ()
Computes the reciprocal of this MeasureUnit, with the numerator and denominator flipped.
For example, if the receiver is "meter-per-second", the unit "second-per-meter" is returned.
NOTE: Only works on SINGLE and COMPOUND units. If this is a MIXED unit, an error will occur. For more information, see `Complexity`.
| Returns | |
|---|---|
MeasureUnit |
The reciprocal of the target unit. |
| Throws | |
|---|---|
UnsupportedOperationException |
if the unit is MIXED. |
public List<MeasureUnit> splitToSingleUnits ()
Returns the list of SINGLE units contained within a sequence of COMPOUND units.
Examples: - Given "meter-kilogram-per-second", three units will be returned: "meter", "kilogram", and "per-second". - Given "hour+minute+second", three units will be returned: "hour", "minute", and "second".
If this is a SINGLE unit, a list of length 1 will be returned.
| Returns | |
|---|---|
List<MeasureUnit> |
An unmodifiable list of single units |
public String toString ()
Returns a string representation of the object. In general, the
toString method returns a string that
"textually represents" this object. The result should
be a concise but informative representation that is easy for a
person to read.
It is recommended that all subclasses override this method.
The toString method for class Object
returns a string consisting of the name of the class of which the
object is an instance, the at-sign character `@', and
the unsigned hexadecimal representation of the hash code of the
object. In other words, this method returns a string equal to the
value of:
getClass().getName() + '@' + Integer.toHexString(hashCode())
| Returns | |
|---|---|
String |
a string representation of the object. |
public MeasureUnit withDimensionality (int dimensionality)
Creates a MeasureUnit which is this SINGLE unit augmented with the specified dimensionality (power). For example, if dimensionality is 2, the unit will be squared.
NOTE: Only works on SINGLE units. If this is a COMPOUND or MIXED unit, an exception is thrown. For more information, see `Complexity`.
| Parameters | |
|---|---|
dimensionality |
int: The dimensionality (power). |
| Returns | |
|---|---|
MeasureUnit |
A new SINGLE unit. |
| Throws | |
|---|---|
UnsupportedOperationException |
if the unit is COMPOUND or MIXED. |
public MeasureUnit withPrefix (MeasureUnit.MeasurePrefix prefix)
Creates a MeasureUnit which is this SINGLE unit augmented with the specified prefix. For example, MeasurePrefix.KILO for "kilo", or MeasurePrefix.KIBI for "kibi". May return `this` if this unit already has that prefix.
There is sufficient locale data to format all standard prefixes.
NOTE: Only works on SINGLE units. If this is a COMPOUND or MIXED unit, an error will occur. For more information, see `Complexity`.
| Parameters | |
|---|---|
prefix |
MeasureUnit.MeasurePrefix: The prefix, from MeasurePrefix. |
| Returns | |
|---|---|
MeasureUnit |
A new SINGLE unit. |
| Throws | |
|---|---|
UnsupportedOperationException |
if this unit is a COMPOUND or MIXED unit. |