MeasureUnit
open class MeasureUnit : Serializable
| kotlin.Any | |
| ↳ | android.icu.util.MeasureUnit |
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.)
Summary
| Nested classes | |
|---|---|
|
Enumeration for unit complexity. |
|
|
Enumeration for SI and binary prefixes, e. |
|
| Public methods | |
|---|---|
| open Boolean |
Indicates whether some other object is "equal to" this one. |
| open static MeasureUnit! |
forIdentifier(identifier: String!)Constructs a MeasureUnit from a CLDR Core Unit Identifier, as defined in UTS 35. |
| open static MutableSet<MeasureUnit!>! |
Get all of the available units. |
| open static MutableSet<MeasureUnit!>! |
getAvailable(type: String!)For the given type, return the available units. |
| open static MutableSet<String!>! |
Get all of the available units' types. |
| open MeasureUnit.Complexity! |
Compute the complexity of the unit. |
| open Int |
Returns the dimensionality (power) of this MeasureUnit. |
| open String! |
Get CLDR Unit Identifier for this MeasureUnit, as defined in UTS 35. |
| open MeasureUnit.MeasurePrefix! |
Returns the current SI or binary prefix of this SINGLE unit. |
| open String! |
Get the subType, such as “foot”. |
| open String! |
getType()Get the type, such as "length". |
| open Int |
hashCode()Returns a hash code value for the object. |
| open MeasureUnit! |
product(other: MeasureUnit!)Computes the product of this unit with another unit. |
| open MeasureUnit! |
Computes the reciprocal of this MeasureUnit, with the numerator and denominator flipped. |
| open MutableList<MeasureUnit!>! |
Returns the list of SINGLE units contained within a sequence of COMPOUND units. |
| open String |
toString()Returns a string representation of the object. |
| open MeasureUnit! |
withDimensionality(dimensionality: Int)Creates a MeasureUnit which is this SINGLE unit augmented with the specified dimensionality (power). |
| open MeasureUnit! |
withPrefix(prefix: MeasureUnit.MeasurePrefix!)Creates a MeasureUnit which is this SINGLE unit augmented with the specified prefix. |
| Properties | |
|---|---|
| static MeasureUnit! |
Constant for unit of area: acre |
| static MeasureUnit! |
Constant for unit of volume: acre-foot |
| static MeasureUnit! |
Constant for unit of electric: ampere |
| static MeasureUnit! |
Constant for unit of angle: arc-minute |
| static MeasureUnit! |
Constant for unit of angle: arc-second |
| static MeasureUnit! |
Constant for unit of length: astronomical-unit |
| static MeasureUnit! |
Constant for unit of pressure: atmosphere |
| static MeasureUnit! |
Constant for unit of speed: beaufort |
| static MeasureUnit! |
Constant for unit of digital: bit |
| static MeasureUnit! |
Constant for unit of volume: bushel |
| static MeasureUnit! |
Constant for unit of digital: byte |
| static MeasureUnit! |
Constant for unit of energy: calorie |
| static MeasureUnit! |
Constant for unit of light: candela |
| static MeasureUnit! |
Constant for unit of mass: carat |
| static MeasureUnit! |
Constant for unit of temperature: celsius |
| static MeasureUnit! |
Constant for unit of volume: centiliter |
| static MeasureUnit! |
Constant for unit of length: centimeter |
| static MeasureUnit! |
Constant for unit of duration: century |
| static MeasureUnit! |
Constant for unit of volume: cubic-centimeter |
| static MeasureUnit! |
Constant for unit of volume: cubic-foot |
| static MeasureUnit! |
Constant for unit of volume: cubic-inch |
| static MeasureUnit! |
Constant for unit of volume: cubic-kilometer |
| static MeasureUnit! |
Constant for unit of volume: cubic-meter |
| static MeasureUnit! |
Constant for unit of volume: cubic-mile |
| static MeasureUnit! |
Constant for unit of volume: cubic-yard |
| static MeasureUnit! |
Constant for unit of volume: cup |
| static MeasureUnit! |
Constant for unit of volume: cup-metric |
| static TimeUnit! |
Constant for unit of duration: day |
| static MeasureUnit! |
Constant for unit of duration: decade |
| static MeasureUnit! |
Constant for unit of volume: deciliter |
| static MeasureUnit! |
Constant for unit of length: decimeter |
| static MeasureUnit! |
Constant for unit of angle: degree |
| static MeasureUnit! |
Constant for unit of graphics: dot |
| static MeasureUnit! |
Constant for unit of graphics: dot-per-centimeter |
| static MeasureUnit! |
Constant for unit of graphics: dot-per-inch |
| static MeasureUnit! |
Constant for unit of graphics: em |
| static MeasureUnit! |
Constant for unit of temperature: fahrenheit |
| static MeasureUnit! |
Constant for unit of length: fathom |
| static MeasureUnit! |
Constant for unit of volume: fluid-ounce |
| static MeasureUnit! |
Constant for unit of energy: foodcalorie |
| static MeasureUnit! |
Constant for unit of length: foot |
| static MeasureUnit! |
Constant for unit of length: furlong |
| static MeasureUnit! |
Constant for unit of volume: gallon |
| static MeasureUnit! |
Constant for unit of volume: gallon-imperial |
| static MeasureUnit! |
Constant for unit of pressure: gasoline-energy-density |
| static MeasureUnit! |
Constant for unit of temperature: generic |
| static MeasureUnit! |
Constant for unit of digital: gigabit |
| static MeasureUnit! |
Constant for unit of digital: gigabyte |
| static MeasureUnit! |
Constant for unit of frequency: gigahertz |
| static MeasureUnit! |
Constant for unit of power: gigawatt |
| static MeasureUnit! |
Constant for unit of mass: gram |
| static MeasureUnit! |
Constant for unit of acceleration: g-force |
| static MeasureUnit! |
Constant for unit of area: hectare |
| static MeasureUnit! |
Constant for unit of volume: hectoliter |
| static MeasureUnit! |
Constant for unit of pressure: hectopascal |
| static MeasureUnit! |
Constant for unit of frequency: hertz |
| static MeasureUnit! |
Constant for unit of power: horsepower |
| static TimeUnit! |
Constant for unit of duration: hour |
| static MeasureUnit! |
Constant for unit of length: inch |
| static MeasureUnit! |
Constant for unit of pressure: inch-ofhg |
| static MeasureUnit! |
Constant for unit of concentr: item |
| static MeasureUnit! |
Constant for unit of energy: joule |
| static MeasureUnit! |
Constant for unit of concentr: karat |
| static MeasureUnit! |
Constant for unit of temperature: kelvin |
| static MeasureUnit! |
Constant for unit of digital: kilobit |
| static MeasureUnit! |
Constant for unit of digital: kilobyte |
| static MeasureUnit! |
Constant for unit of energy: kilocalorie |
| static MeasureUnit! |
Constant for unit of mass: kilogram |
| static MeasureUnit! |
Constant for unit of frequency: kilohertz |
| static MeasureUnit! |
Constant for unit of energy: kilojoule |
| static MeasureUnit! |
Constant for unit of length: kilometer |
| static MeasureUnit! |
Constant for unit of speed: kilometer-per-hour |
| static MeasureUnit! |
Constant for unit of power: kilowatt |
| static MeasureUnit! |
Constant for unit of energy: kilowatt-hour |
| static MeasureUnit! |
Constant for unit of force: kilowatt-hour-per-100-kilometer |
| static MeasureUnit! |
Constant for unit of speed: knot |
| static MeasureUnit! |
Constant for unit of speed: light-speed |
| static MeasureUnit! |
Constant for unit of length: light-year |
| static MeasureUnit! |
Constant for unit of volume: liter |
| static MeasureUnit! |
Constant for unit of consumption: liter-per-100-kilometer |
| static MeasureUnit! |
Constant for unit of consumption: liter-per-kilometer |
| static MeasureUnit! |
Constant for unit of light: lumen |
| static MeasureUnit! |
Constant for unit of light: lux |
| static MeasureUnit! |
Constant for unit of digital: megabit |
| static MeasureUnit! |
Constant for unit of digital: megabyte |
| static MeasureUnit! |
Constant for unit of frequency: megahertz |
| static MeasureUnit! |
Constant for unit of volume: megaliter |
| static MeasureUnit! |
Constant for unit of graphics: megapixel |
| static MeasureUnit! |
Constant for unit of power: megawatt |
| static MeasureUnit! |
Constant for unit of length: meter |
| static MeasureUnit! |
Constant for unit of speed: meter-per-second |
| static MeasureUnit! |
Constant for unit of acceleration: meter-per-square-second |
| static MeasureUnit! |
Constant for unit of mass: metric-ton (renamed to tonne in CLDR 42 / ICU 72). |
| static MeasureUnit! |
Constant for unit of mass: microgram |
| static MeasureUnit! |
Constant for unit of length: micrometer |
| static MeasureUnit! |
Constant for unit of duration: microsecond |
| static MeasureUnit! |
Constant for unit of length: mile |
| static MeasureUnit! |
Constant for unit of consumption: mile-per-gallon |
| static MeasureUnit! |
Constant for unit of consumption: mile-per-gallon-imperial |
| static MeasureUnit! |
Constant for unit of speed: mile-per-hour |
| static MeasureUnit! |
Constant for unit of length: mile-scandinavian |
| static MeasureUnit! |
Constant for unit of electric: milliampere |
| static MeasureUnit! |
Constant for unit of pressure: millibar |
| static MeasureUnit! |
Constant for unit of mass: milligram |
| static MeasureUnit! |
Constant for unit of concentr: milligram-ofglucose-per-deciliter |
| static MeasureUnit! |
Constant for unit of concentr: milligram-per-deciliter (renamed to milligram-ofglucose-per-deciliter in CLDR 39 / ICU 69). |
| static MeasureUnit! |
Constant for unit of volume: milliliter |
| static MeasureUnit! |
Constant for unit of length: millimeter |
| static MeasureUnit! |
Constant for unit of pressure: millimeter-ofhg |
| static MeasureUnit! |
Constant for unit of concentr: millimole-per-liter |
| static MeasureUnit! |
Constant for unit of duration: millisecond |
| static MeasureUnit! |
Constant for unit of power: milliwatt |
| static TimeUnit! |
Constant for unit of duration: minute |
| static TimeUnit! |
Constant for unit of duration: month |
| static MeasureUnit! |
Constant for unit of length: nanometer |
| static MeasureUnit! |
Constant for unit of duration: nanosecond |
| static MeasureUnit! |
Constant for unit of length: nautical-mile |
| static MeasureUnit! |
Constant for unit of duration: night |
| static MeasureUnit! |
Constant for unit of electric: ohm |
| static MeasureUnit! |
Constant for unit of mass: ounce |
| static MeasureUnit! |
Constant for unit of mass: ounce-troy |
| static MeasureUnit! |
Constant for unit of length: parsec |
| static MeasureUnit! |
Constant for unit of concentr: part-per-million (renamed to part-per-1e6 in CLDR 48 / ICU 78). |
| static MeasureUnit! |
Constant for unit of concentr: percent |
| static MeasureUnit! |
Constant for unit of concentr: permille |
| static MeasureUnit! |
Constant for unit of digital: petabyte |
| static MeasureUnit! |
Constant for unit of length: picometer |
| static MeasureUnit! |
Constant for unit of volume: pint |
| static MeasureUnit! |
Constant for unit of volume: pint-metric |
| static MeasureUnit! |
Constant for unit of graphics: pixel |
| static MeasureUnit! |
Constant for unit of graphics: pixel-per-centimeter |
| static MeasureUnit! |
Constant for unit of graphics: pixel-per-inch |
| static MeasureUnit! |
Constant for unit of length: point |
| static MeasureUnit! |
Constant for unit of mass: pound |
| static MeasureUnit! |
Constant for unit of pressure: pound-force-per-square-inch |
| static MeasureUnit! |
Constant for unit of volume: quart |
| static MeasureUnit! |
Constant for unit of duration: quarter |
| static MeasureUnit! |
Constant for unit of angle: radian |
| static MeasureUnit! |
Constant for unit of angle: revolution |
| static TimeUnit! |
Constant for unit of duration: second |
| static MeasureUnit! |
Constant for unit of area: square-centimeter |
| static MeasureUnit! |
Constant for unit of area: square-foot |
| static MeasureUnit! |
Constant for unit of area: square-inch |
| static MeasureUnit! |
Constant for unit of area: square-kilometer |
| static MeasureUnit! |
Constant for unit of area: square-meter |
| static MeasureUnit! |
Constant for unit of area: square-mile |
| static MeasureUnit! |
Constant for unit of area: square-yard |
| static MeasureUnit! |
Constant for unit of mass: stone |
| static MeasureUnit! |
Constant for unit of volume: tablespoon |
| static MeasureUnit! |
Constant for unit of volume: teaspoon |
| static MeasureUnit! |
Constant for unit of digital: terabit |
| static MeasureUnit! |
Constant for unit of digital: terabyte |
| static MeasureUnit! |
Constant for unit of mass: ton |
| static MeasureUnit! |
Constant for unit of mass: tonne |
| static MeasureUnit! |
Constant for unit of electric: volt |
| static MeasureUnit! |
Constant for unit of power: watt |
| static TimeUnit! |
Constant for unit of duration: week |
| static MeasureUnit! |
Constant for unit of length: yard |
| static TimeUnit! |
Constant for unit of duration: year |
Public methods
equals
open fun equals(other: Any?): Boolean
Indicates whether some other object is "equal to" this one.
The equals method implements an equivalence relation on non-null object references:
- It is reflexive: for any non-null reference value
x,x.equals(x)should returntrue. - It is symmetric: for any non-null reference values
xandy,x.equals(y)should returntrueif and only ify.equals(x)returnstrue. - It is transitive: for any non-null reference values
x,y, andz, ifx.equals(y)returnstrueandy.equals(z)returnstrue, thenx.equals(z)should returntrue. - It is consistent: for any non-null reference values
xandy, multiple invocations ofx.equals(y)consistently returntrueor consistently returnfalse, provided no information used inequalscomparisons on the objects is modified. - For any non-null reference value
x,x.equals(null)should returnfalse.
An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.
| Parameters | |
|---|---|
obj |
the reference object with which to compare. |
| Return | |
|---|---|
Boolean |
true if this object is the same as the obj argument; false otherwise. |
forIdentifier
open static fun forIdentifier(identifier: String!): MeasureUnit!
Constructs a MeasureUnit from a CLDR Core Unit Identifier, as defined in UTS 35. This method supports core unit identifiers and mixed unit identifiers. It validates and canonicalizes the given identifier. Note: A dimensionless MeasureUnit is represented as null. Example usage:
MeasureUnit example = MeasureUnit.forIdentifier("meter-per-second);
| Parameters | |
|---|---|
identifier |
String!: the CLDR Unit Identifier |
| Return | |
|---|---|
MeasureUnit! |
the corresponding MeasureUnit |
| Exceptions | |
|---|---|
java.lang.IllegalArgumentException |
if the identifier is invalid |
getAvailable
open static fun getAvailable(): MutableSet<MeasureUnit!>!
Get all of the available units. Returned set is unmodifiable.