MeasureFormat

Kotlin |Java

open class MeasureFormat : UFormat

kotlin.Any
↳	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′ 1″
  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.

Summary

Nested classes
	`FormatWidth` Formatting width enum.

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

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

Exceptions
`java.lang.NullPointerException`	if `toAppendTo` or `pos` is null
`java.lang.IllegalArgumentException`	if the Format cannot format the given object

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.

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

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

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

MeasureFormat

Summary

Public methods

equals

format

formatMeasurePerUnit

formatMeasures

formatMeasures

getCurrencyFormat

getCurrencyFormat

getCurrencyFormat

getInstance

getInstance

getInstance

getInstance

getLocale

getNumberFormat

getUnitDisplayName

getWidth

hashCode