Top Description Inners Fields Constructors Methods
com.ibm.icu.util

public Class MeasureUnit

extends Object
implements Serializable
Class Inheritance
All Implemented Interfaces
java.io.Serializable
Known Direct Subclasses
com.ibm.icu.util.Currency, com.ibm.icu.util.TimeUnit
Imports
java.io.Externalizable, .IOException, .ObjectInput, .ObjectOutput, .ObjectStreamException, .Serializable, java.util.ArrayList, .Collections, .HashMap, .HashSet, .List, .Map, .Set, com.ibm.icu.impl.CollectionSet, .ICUData, .ICUResourceBundle, .UResource, com.ibm.icu.impl.units.MeasureUnitImpl, .SingleUnitImpl, com.ibm.icu.text.UnicodeSet

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.)
Author
Alan Liu
ICU Status
Stable since ICU 3.0.
See Also
com.ibm.icu.util.Measure

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static enum
MeasureUnit.Complexity

Enumeration for unit complexity.

private static class
MeasureUnit.CurrencyNumericCodeSink

Sink for enumerating the currency numeric codes.

protected static interface
MeasureUnit.Factory

Deprecated This API is ICU internal only.
public static enum
MeasureUnit.MeasurePrefix

Enumeration for SI and binary prefixes, e.g. "kilo-", "nano-", "mebi-".

pack-priv static class
private static class
MeasureUnit.MeasureUnitSink

Sink for enumerating the available measure units.

Field Summary

Modifier and TypeField and Description
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

pack-priv static final UnicodeSet
pack-priv static final UnicodeSet
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
BAR

Constant for unit of pressure: bar

public static final MeasureUnit
BARREL

Constant for unit of volume: barrel

public static final MeasureUnit
BEAUFORT

Constant for unit of speed: beaufort

public static final MeasureUnit
BIT

Constant for unit of digital: bit

public static final MeasureUnit
BRITISH_THERMAL_UNIT

Constant for unit of energy: british-thermal-unit

public static final MeasureUnit
BUSHEL

Constant for unit of volume: bushel

public static final MeasureUnit
BYTE

Constant for unit of digital: byte

private static final Map<String, Map<String, MeasureUnit>>
private static boolean
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

pack-priv static MeasureUnit.Factory
CURRENCY_FACTORY

Deprecated as a consequence of MeasureUnit.Factory being deprecated.
public static final MeasureUnit
DALTON

Constant for unit of mass: dalton

public static final TimeUnit
DAY

Constant for unit of duration: day

public static final MeasureUnit
DAY_PERSON

Constant for unit of duration: day-person

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
DESSERT_SPOON

Constant for unit of volume: dessert-spoon

public static final MeasureUnit
DESSERT_SPOON_IMPERIAL

Constant for unit of volume: dessert-spoon-imperial

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
DRAM

Constant for unit of volume: dram

public static final MeasureUnit
DROP

Constant for unit of volume: drop

public static final MeasureUnit
DUNAM

Constant for unit of area: dunam

public static final MeasureUnit
EARTH_MASS

Constant for unit of mass: earth-mass

public static final MeasureUnit
EARTH_RADIUS

Constant for unit of length: earth-radius

public static final MeasureUnit
ELECTRONVOLT

Constant for unit of energy: electronvolt

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
FLUID_OUNCE_IMPERIAL

Constant for unit of volume: fluid-ounce-imperial

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
G_FORCE

Constant for unit of acceleration: g-force

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
GASOLINE_ENERGY_DENSITY

Constant for unit of pressure: gasoline-energy-density

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
GRAIN

Constant for unit of mass: grain

public static final MeasureUnit
GRAM

Constant for unit of mass: gram

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
JIGGER

Constant for unit of volume: jigger

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
KILOPASCAL

Constant for unit of pressure: kilopascal

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

private MeasureUnitImpl
measureUnitImpl

Used by new draft APIs in ICU 68.

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
MEGAPASCAL

Constant for unit of pressure: megapascal

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 MeasureUnit
MOLE

Constant for unit of concentr: mole

public static final TimeUnit
MONTH

Constant for unit of duration: month

public static final MeasureUnit
MONTH_PERSON

Constant for unit of duration: month-person

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
NEWTON

Constant for unit of force: newton

public static final MeasureUnit
NEWTON_METER

Constant for unit of torque: newton-meter

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
PASCAL

Constant for unit of pressure: pascal

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
PERMYRIAD

Constant for unit of concentr: permyriad

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
PINCH

Constant for unit of volume: pinch

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_FOOT

Constant for unit of torque: pound-force-foot

public static final MeasureUnit
POUND_FORCE

Constant for unit of force: pound-force

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
QUART_IMPERIAL

Constant for unit of volume: quart-imperial

public static final MeasureUnit
QUARTER

Constant for unit of duration: quarter

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

private static final long
public static final MeasureUnit
SOLAR_LUMINOSITY

Constant for unit of light: solar-luminosity

public static final MeasureUnit
SOLAR_MASS

Constant for unit of mass: solar-mass

public static final MeasureUnit
SOLAR_RADIUS

Constant for unit of length: solar-radius

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

protected final String
subType

If subType set to null, measureUnitImpl is in use instead of type and subType.

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
THERM_US

Constant for unit of energy: therm-us

pack-priv static MeasureUnit.Factory
TIMEUNIT_FACTORY

Deprecated as a consequence of MeasureUnit.Factory being deprecated.
public static final MeasureUnit
TON

Constant for unit of mass: ton

public static final MeasureUnit
TONNE

Constant for unit of mass: tonne

protected final String
type

If type set to null, measureUnitImpl is in use instead of type and subType.

private static MeasureUnit.Factory
UNIT_FACTORY

Deprecated as a consequence of MeasureUnit.Factory being deprecated.
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
WEEK_PERSON

Constant for unit of duration: week-person

public static final MeasureUnit
YARD

Constant for unit of length: yard

public static final TimeUnit
YEAR

Constant for unit of duration: year

public static final MeasureUnit
YEAR_PERSON

Constant for unit of duration: year-person

Constructor Summary

AccessConstructor and Description
protected
MeasureUnit(String type, String subType)

Deprecated This API is ICU internal only.
private
MeasureUnit(MeasureUnitImpl measureUnitImpl)

Method Summary

Modifier and TypeMethod and Description
protected static synchronized MeasureUnit
addUnit(String type, String unitName, MeasureUnit.Factory factory)

Deprecated This API is ICU internal only.
public boolean
equals(Object
the reference object with which to compare.
rhs
)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.
public static MeasureUnit
findBySubType(String subType)

Deprecated This API is ICU internal only.
public static MeasureUnit
forIdentifier(String
CLDR Unit Identifier
identifier
)

Construct a MeasureUnit from a CLDR Core Unit Identifier, defined in UTS 35.

public static MeasureUnit
fromMeasureUnitImpl(MeasureUnitImpl measureUnitImpl)

Deprecated Internal API for ICU use only.
public static Set<MeasureUnit>

Returns:

the available units for type. Returned set is unmodifiable.
getAvailable
(String
the type
type
)

For the given type, return the available units.

public static synchronized Set<MeasureUnit>
getAvailable()

Get all of the available units.

public static Set<String>
getAvailableTypes()

Get all of the available units' types.

public MeasureUnit.Complexity

Returns:

The unit complexity.
getComplexity
()

Compute the complexity of the unit.

public MeasureUnitImpl

Returns:

this object in a MeasureUnitImpl form.
getCopyOfMeasureUnitImpl
()

Deprecated This API is ICU internal only.
public int

Returns:

The dimensionality (power) of this simple unit.
getDimensionality
()

Returns the dimensionality (power) of this MeasureUnit.

public String

Returns:

The string form of this unit.
getIdentifier
()

Get CLDR Unit Identifier for this MeasureUnit, as defined in UTS 35.

private MeasureUnitImpl

Returns:

this object in a MeasureUnitImpl form.
getMaybeReferenceOfMeasureUnitImpl
()

public MeasureUnit.MeasurePrefix

Returns:

The prefix of this SINGLE unit, from MeasurePrefix.
getPrefix
()

Returns the current SI or binary prefix of this SINGLE unit.

private SingleUnitImpl

Returns:

this object as a SingleUnitImpl.
getSingleUnitImpl
()

public String
getSubtype()

Get the subType, such as “foot”.

public String
getType()

Get the type, such as "length".

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for the object.
public static MeasureUnit
internalGetInstance(String type, String subType)

Deprecated This API is ICU internal only.
Creates a MeasureUnit instance (creates a singleton instance) or returns one from the cache.
private static synchronized void
populateCache()

Populate the MeasureUnit cache with all types from the data.

public MeasureUnit

Returns:

The product of the target unit with the provided unit.
product
(MeasureUnit
The MeasureUnit to multiply with the target.
other
)

Computes the product of this unit with another unit.

public MeasureUnit

Returns:

The reciprocal of the target unit.
reciprocal
()

Computes the reciprocal of this MeasureUnit, with the numerator and denominator flipped.

public List<MeasureUnit>

Returns:

An unmodifiable list of single units
splitToSingleUnits
()

Returns the list of SINGLE units contained within a sequence of COMPOUND units.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
public MeasureUnit

Returns:

A new SINGLE unit.
withDimensionality
(int
The dimensionality (power).
dimensionality
)

Creates a MeasureUnit which is this SINGLE unit augmented with the specified dimensionality (power).

public MeasureUnit

Returns:

A new SINGLE unit.
withPrefix
(MeasureUnit.MeasurePrefix
The prefix, from MeasurePrefix.
prefix
)

Creates a MeasureUnit which is this SINGLE unit augmented with the specified prefix.

private Object
Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait