Package com.ibm.icu.text

Class MeasureFormat

  • All Implemented Interfaces:
    Serializable, Cloneable
    Direct Known Subclasses:
    TimeUnitFormat
    public class MeasureFormat
extends UFormat
    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.

    Author:
    Alan Liu
    See Also:
    UFormat, Serialized Form
    Status:
    Stable ICU 3.0.

    • Method Detail

      • getInstance

        public static MeasureFormat getInstance​(ULocale locale,
                                        MeasureFormat.FormatWidth formatWidth)
        Create a format from the locale, formatWidth, and format.
        Parameters:
        locale - the locale.
        formatWidth - hints how long formatted strings should be.
        Returns:
        The new MeasureFormat object.
        Status:
        Stable ICU 53.

      • getInstance

        public static MeasureFormat getInstance​(Locale locale,
                                        MeasureFormat.FormatWidth formatWidth)
        Create a format from the Locale and formatWidth.
        Parameters:
        locale - the Locale.
        formatWidth - hints how long formatted strings should be.
        Returns:
        The new MeasureFormat object.
        Status:
        Stable ICU 54.

      • getInstance

        public static MeasureFormat getInstance​(ULocale locale,
                                        MeasureFormat.FormatWidth formatWidth,
                                        NumberFormat format)
        Create a format from the locale, formatWidth, and format.
        Parameters:
        locale - the locale.
        formatWidth - hints how long formatted strings should be.
        format - This is defensively copied.
        Returns:
        The new MeasureFormat object.
        Status:
        Stable ICU 53.

      • getInstance

        public static MeasureFormat getInstance​(Locale locale,
                                        MeasureFormat.FormatWidth formatWidth,
                                        NumberFormat format)
        Create a format from the Locale, formatWidth, and format.
        Parameters:
        locale - the Locale.
        formatWidth - hints how long formatted strings should be.
        format - This is defensively copied.
        Returns:
        The new MeasureFormat object.
        Status:
        Stable ICU 54.

      • format

        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.
        Specified by:
        format in class Format
        Parameters:
        obj - must be a Collection<? extends Measure>, Measure[], or Measure object.
        toAppendTo - Formatted string appended here.
        fpos - Identifies a field in the formatted text.
        See Also:
        Format.format(java.lang.Object, java.lang.StringBuffer, java.text.FieldPosition)
        Status:
        Stable ICU53.

      • formatMeasures

        public final String formatMeasures​(Measure... measures)
        Format a sequence of measures. Uses the ListFormatter unit lists. So, for example, one could format “3 feet, 2 inches”. Zero values are formatted (eg, “3 feet, 0 inches”). It is the caller’s 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 “3.2 feet, 2 inches”).
        Parameters:
        measures - a sequence of one or more measures.
        Returns:
        the formatted string.
        Status:
        Stable ICU 53.

      • formatMeasurePerUnit

        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 - the measure object. In above example, 3.5 meters.
        perUnit - the per unit. In above example, it is MeasureUnit.SECOND
        appendTo - formatted string appended here.
        pos - The field position.
        Returns:
        appendTo.
        Status:
        Stable ICU 55.

      • formatMeasures

        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 - the formatted string appended here.
        fpos - Identifies a field in the formatted text.
        measures - the measures to format.
        Returns:
        appendTo.
        See Also:
        formatMeasures(Measure...)
        Status:
        Stable ICU 53.

      • equals

        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.
        Overrides:
        equals in class Object
        Status:
        Stable ICU 3.0.

      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
        Status:
        Stable ICU 3.0.

      • getLocale

        public final ULocale getLocale()
        Get the locale of this instance.
        Status:
        Stable ICU 53.

      • getNumberFormat

        public NumberFormat getNumberFormat()
        Get a copy of the number format.
        Status:
        Stable ICU 53.

      • getCurrencyFormat

        public static MeasureFormat getCurrencyFormat​(ULocale locale)
        Return a formatter for CurrencyAmount objects in the given locale.
        Parameters:
        locale - desired locale
        Returns:
        a formatter object
        Status:
        Stable ICU 3.0.

      • getCurrencyFormat

        public static MeasureFormat getCurrencyFormat​(Locale locale)
        Return a formatter for CurrencyAmount objects in the given Locale.
        Parameters:
        locale - desired Locale
        Returns:
        a formatter object
        Status:
        Stable ICU 54.

      • getCurrencyFormat

        public static MeasureFormat getCurrencyFormat()
        Return a formatter for CurrencyAmount objects in the default FORMAT locale.
        Returns:
        a formatter object
        See Also:
        ULocale.Category.FORMAT
        Status:
        Stable ICU 3.0.

      • getRangeFormat

        @Deprecated
public static String getRangeFormat​(ULocale forLocale,
                                    MeasureFormat.FormatWidth width)
        Deprecated.
        This API is ICU internal only.
        Return a formatter (compiled SimpleFormatter pattern) for a range, such as "{0}–{1}".
        Parameters:
        forLocale - locale to get the format for
        width - the format width
        Returns:
        range formatter, such as "{0}–{1}"
        Status:
        Internal. This API is ICU internal only.