Added in API level 24

Summary: Methods | Inherited Methods

MeasureFormat

Kotlin |Java

public class MeasureFormat
extends UFormat

java.lang.Object
↳	java.text.Format
	↳	android.icu.text.UFormat
		↳	android.icu.text.MeasureFormat

A formatter for Measure objects.

IMPORTANT: New users are strongly encouraged to see if NumberFormatter fits their use case. Although not deprecated, this class, MeasureFormat, is provided for backwards compatibility only, and has much more limited capabilities.

To format a Measure object, first create a formatter object using a MeasureFormat factory method. Then use that object's format or formatMeasures methods. Here is sample code:

 MeasureFormat fmtFr = MeasureFormat.getInstance(ULocale.FRENCH, FormatWidth.SHORT);
 Measure measure = new Measure(23, MeasureUnit.CELSIUS);

 // Output: 23 °C
 System.out.println(fmtFr.format(measure));

 Measure measureF = new Measure(70, MeasureUnit.FAHRENHEIT);

 // Output: 70 °F
 System.out.println(fmtFr.format(measureF));

 MeasureFormat fmtFrFull = MeasureFormat.getInstance(ULocale.FRENCH, FormatWidth.WIDE);
 // Output: 70 pieds et 5,3 pouces
 System.out.println(fmtFrFull.formatMeasures(new Measure(70, MeasureUnit.FOOT),
         new Measure(5.3, MeasureUnit.INCH)));

 // Output: 1 pied et 1 pouce
 System.out.println(
         fmtFrFull.formatMeasures(new Measure(1, MeasureUnit.FOOT), new Measure(1, MeasureUnit.INCH)));

 MeasureFormat fmtFrNarrow = MeasureFormat.getInstance(ULocale.FRENCH, FormatWidth.NARROW);
 // Output: 1\u2032 1\u2033
 System.out.println(fmtFrNarrow.formatMeasures(new Measure(1, MeasureUnit.FOOT),
         new Measure(1, MeasureUnit.INCH)));

 MeasureFormat fmtEn = MeasureFormat.getInstance(ULocale.ENGLISH, FormatWidth.WIDE);

 // Output: 1 inch, 2 feet
 fmtEn.formatMeasures(new Measure(1, MeasureUnit.INCH), new Measure(2, MeasureUnit.FOOT));

This class does not do conversions from one unit to another. It simply formats whatever units it is given

This class is immutable and thread-safe so long as its deprecated subclass, TimeUnitFormat, is never used. TimeUnitFormat is not thread-safe, and is mutable. Although this class has existing subclasses, this class does not support new sub-classes.

See also:

UFormat

Summary

Public methods
`final boolean`	`equals(Object other)` Two MeasureFormats, a and b, are equal if and only if they have the same formatWidth, locale, and equal number formats.
`StringBuffer`	`format(Object obj, StringBuffer toAppendTo, FieldPosition fpos)` Able to format Collection<? extends Measure>, Measure[], and Measure by delegating to formatMeasures.
`StringBuilder`	`formatMeasurePerUnit(Measure measure, MeasureUnit perUnit, StringBuilder appendTo, FieldPosition pos)` Formats a single measure per unit.
`StringBuilder`	`formatMeasures(StringBuilder appendTo, FieldPosition fpos, Measure... measures)` Formats a sequence of measures.
`final String`	`formatMeasures(Measure... measures)` Format a sequence of measures.
`static MeasureFormat`	`getCurrencyFormat()` Return a formatter for CurrencyAmount objects in the default `FORMAT` locale.
`static MeasureFormat`	`getCurrencyFormat(Locale locale)` Return a formatter for CurrencyAmount objects in the given `Locale`.
`static MeasureFormat`	`getCurrencyFormat(ULocale locale)` Return a formatter for CurrencyAmount objects in the given locale.
`static MeasureFormat`	`getInstance(Locale locale, MeasureFormat.FormatWidth formatWidth, NumberFormat format)` Create a format from the `Locale`, formatWidth, and format.
`static MeasureFormat`	`getInstance(Locale locale, MeasureFormat.FormatWidth formatWidth)` Create a format from the `Locale` and formatWidth.
`static MeasureFormat`	`getInstance(ULocale locale, MeasureFormat.FormatWidth formatWidth)` Create a format from the locale, formatWidth, and format.
`static MeasureFormat`	`getInstance(ULocale locale, MeasureFormat.FormatWidth formatWidth, NumberFormat format)` Create a format from the locale, formatWidth, and format.
`final ULocale`	`getLocale()` Get the locale of this instance.
`NumberFormat`	`getNumberFormat()` Get a copy of the number format.
`String`	`getUnitDisplayName(MeasureUnit unit)` Gets the display name of the specified `MeasureUnit` corresponding to the current locale and format width.
`MeasureFormat.FormatWidth`	`getWidth()` Get the format width this instance is using.
`final int`	`hashCode()` Returns a hash code value for the object.

Inherited methods

From class


        
          java.text.Format

`Object`	`clone()` Creates and returns a copy of this object.
`final String`	`format(Object obj)` Formats an object to produce a string.
`abstract StringBuffer`	`format(Object obj, StringBuffer toAppendTo, FieldPosition pos)` Formats an object and appends the resulting text to a given string buffer.
`AttributedCharacterIterator`	`formatToCharacterIterator(Object obj)` Formats an Object producing an `AttributedCharacterIterator`.
`Object`	`parseObject(String source)` Parses text from the beginning of the given string to produce an object.
`abstract Object`	`parseObject(String source, ParsePosition pos)` Parses text from a string to produce an object.

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Public methods

equals

Added in API level 24

public final boolean equals (Object other)

Two MeasureFormats, a and b, are equal if and only if they have the same formatWidth, locale, and equal number formats.

Parameters
`other`	`Object`: the reference object with which to compare.

Returns
`boolean`	`true` if this object is the same as the obj argument; `false` otherwise.

format

Added in API level 24

public StringBuffer format (Object obj, 
                StringBuffer toAppendTo, 
                FieldPosition fpos)

Able to format Collection<? extends Measure>, Measure[], and Measure by delegating to formatMeasures. If the pos argument identifies a NumberFormat field, then its indices are set to the beginning and end of the first such field encountered. MeasureFormat itself does not supply any fields. Calling a formatMeasures method is preferred over calling this method as they give better performance.

Parameters
`obj`	`Object`: must be a Collection<? extends Measure>, Measure[], or Measure object.
`toAppendTo`	`StringBuffer`: Formatted string appended here.
`fpos`	`FieldPosition`: Identifies a field in the formatted text.

Returns
`StringBuffer`	the string buffer passed in as `toAppendTo`, with formatted text appended

See also:

Format.format(java.lang.Object, java.lang.StringBuffer, java.text.FieldPosition)

formatMeasurePerUnit

Added in API level 26

public StringBuilder formatMeasurePerUnit (Measure measure, 
                MeasureUnit perUnit, 
                StringBuilder appendTo, 
                FieldPosition pos)

Formats a single measure per unit. An example of such a formatted string is "3.5 meters per second."

Parameters
`measure`	`Measure`: the measure object. In above example, 3.5 meters.
`perUnit`	`MeasureUnit`: the per unit. In above example, it is MeasureUnit.SECOND
`appendTo`	`StringBuilder`: formatted string appended here.
`pos`	`FieldPosition`: The field position.

Returns
`StringBuilder`	appendTo.

formatMeasures

Added in API level 24

public StringBuilder formatMeasures (StringBuilder appendTo, 
                FieldPosition fpos, 
                Measure... measures)

Formats a sequence of measures. If the fieldPosition argument identifies a NumberFormat field, then its indices are set to the beginning and end of the first such field encountered. MeasureFormat itself does not supply any fields.

Parameters
`appendTo`	`StringBuilder`: the formatted string appended here.
`fpos`	`FieldPosition`: Identifies a field in the formatted text.
`measures`	`Measure`: the measures to format.

Returns
`StringBuilder`	appendTo.

See also:

formatMeasures(Measure)

formatMeasures

Added in API level 24

public final String formatMeasures (Measure... measures)

Format a sequence of measures. Uses the ListFormatter unit lists. So, for example, one could format \u201c3 feet, 2 inches\u201d. Zero values are formatted (eg, \u201c3 feet, 0 inches\u201d). It is the caller\u2019s responsibility to have the appropriate values in appropriate order, and using the appropriate Number values. Typically the units should be in descending order, with all but the last Measure having integer values (eg, not \u201c3.2 feet, 2 inches\u201d).

Parameters
`measures`	`Measure`: a sequence of one or more measures.

Returns
`String`	the formatted string.

getCurrencyFormat

Added in API level 24

public static MeasureFormat getCurrencyFormat ()

Return a formatter for CurrencyAmount objects in the default FORMAT locale.

Returns
`MeasureFormat`	a formatter object

See also:

ULocale.Category.FORMAT

getCurrencyFormat

Added in API level 24

public static MeasureFormat getCurrencyFormat (Locale locale)

Return a formatter for CurrencyAmount objects in the given Locale.

Parameters
`locale`	`Locale`: desired `Locale`

Returns
`MeasureFormat`	a formatter object

getCurrencyFormat

Added in API level 24

public static MeasureFormat getCurrencyFormat (ULocale locale)

Return a formatter for CurrencyAmount objects in the given locale.

Parameters
`locale`	`ULocale`: desired locale

Returns
`MeasureFormat`	a formatter object

getInstance

Added in API level 24

public static MeasureFormat getInstance (Locale locale, 
                MeasureFormat.FormatWidth formatWidth, 
                NumberFormat format)

Create a format from the Locale, formatWidth, and format.

Parameters
`locale`	`Locale`: the `Locale`.
`formatWidth`	`MeasureFormat.FormatWidth`: hints how long formatted strings should be.
`format`	`NumberFormat`: This is defensively copied.

Returns
`MeasureFormat`	The new MeasureFormat object.

getInstance

Added in API level 24

public static MeasureFormat getInstance (Locale locale, 
                MeasureFormat.FormatWidth formatWidth)

Create a format from the Locale and formatWidth.

Parameters
`locale`	`Locale`: the `Locale`.
`formatWidth`	`MeasureFormat.FormatWidth`: hints how long formatted strings should be.

Returns
`MeasureFormat`	The new MeasureFormat object.

getInstance

Added in API level 24

public static MeasureFormat getInstance (ULocale locale, 
                MeasureFormat.FormatWidth formatWidth)

Create a format from the locale, formatWidth, and format.

Parameters
`locale`	`ULocale`: the locale.
`formatWidth`	`MeasureFormat.FormatWidth`: hints how long formatted strings should be.

Returns
`MeasureFormat`	The new MeasureFormat object.

getInstance

Added in API level 24

public static MeasureFormat getInstance (ULocale locale, 
                MeasureFormat.FormatWidth formatWidth, 
                NumberFormat format)

Create a format from the locale, formatWidth, and format.

Parameters
`locale`	`ULocale`: the locale.
`formatWidth`	`MeasureFormat.FormatWidth`: hints how long formatted strings should be.
`format`	`NumberFormat`: This is defensively copied.

Returns
`MeasureFormat`	The new MeasureFormat object.

getLocale

Added in API level 24

public final ULocale getLocale ()

Get the locale of this instance.

Returns
`ULocale`

getNumberFormat

Added in API level 24

public NumberFormat getNumberFormat ()

Get a copy of the number format.

Returns
`NumberFormat`

getUnitDisplayName

Added in API level 28

public String getUnitDisplayName (MeasureUnit unit)

Gets the display name of the specified MeasureUnit corresponding to the current locale and format width.

Parameters
`unit`	`MeasureUnit`: The unit for which to get a display name.

Returns
`String`	The display name in the locale and width specified in `MeasureFormat.getInstance`, or null if there is no display name available for the specified unit.

getWidth

Added in API level 24

public MeasureFormat.FormatWidth getWidth ()

Get the format width this instance is using.

Returns
`MeasureFormat.FormatWidth`

hashCode

Added in API level 24

public final 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:

Whenever it is invoked on the same object more than once during an execution of a Java application, the 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.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals 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.

Returns
`int`	a hash code value for this object.