MeasureFormat

java.lang.Object
- java.text.Format
- - ohos.global.icu.text.UFormat
  - - ohos.global.icu.text.MeasureFormat

所有已实现的接口:: Serializable, Cloneable

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.

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.

另请参阅:: UFormat, 序列化表格

嵌套类概要

嵌套类
限定符和类型类说明

static class MeasureFormat.FormatWidth
Formatting width enum.
- 从类继承的嵌套类/接口 java.text.Format
  Format.Field

嵌套类
限定符和类型	类	说明
`static class`	`MeasureFormat.FormatWidth`	Formatting width enum.

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法	说明
`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.
`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)`	Create a format from the `Locale` and formatWidth.
`static MeasureFormat`	`getInstance(Locale locale, MeasureFormat.FormatWidth formatWidth, NumberFormat format)`	Create a format from the `Locale`, formatWidth, and format.
`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.
`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.
`int`	`hashCode()`	Returns a hash code value for the object.
`Measure`	`parseObject(String source, ParsePosition pos)`	Parses text from a string to produce a `Measure`.

从类继承的方法 java.text.Format
clone, format, formatToCharacterIterator, parseObject

从类继承的方法 java.lang.Object
finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- 方法详细资料
  - getInstance
```
public static MeasureFormat getInstance(ULocale locale,
                                        MeasureFormat.FormatWidth formatWidth)
```
    Create a format from the locale, formatWidth, and format.
    
    参数:
    
    locale - the locale.
    
    formatWidth - hints how long formatted strings should be.
    
    返回:
    
    The new MeasureFormat object.
  - getInstance
```
public static MeasureFormat getInstance(Locale locale,
                                        MeasureFormat.FormatWidth formatWidth)
```
    Create a format from the Locale and formatWidth.
    
    参数:
    
    locale - the Locale.
    
    formatWidth - hints how long formatted strings should be.
    
    返回:
    
    The new MeasureFormat object.
  - getInstance
```
public static MeasureFormat getInstance(ULocale locale,
                                        MeasureFormat.FormatWidth formatWidth,
                                        NumberFormat format)
```
    Create a format from the locale, formatWidth, and format.
    
    参数:
    
    locale - the locale.
    
    formatWidth - hints how long formatted strings should be.
    
    format - This is defensively copied.
    
    返回:
    
    The new MeasureFormat object.
  - getInstance
```
public static MeasureFormat getInstance(Locale locale,
                                        MeasureFormat.FormatWidth formatWidth,
                                        NumberFormat format)
```
    Create a format from the Locale, formatWidth, and format.
    
    参数:
    
    locale - the Locale.
    
    formatWidth - hints how long formatted strings should be.
    
    format - This is defensively copied.
    
    返回:
    
    The new MeasureFormat object.
  - 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.
    
    指定者:
    
    format 在类中 Format
    
    参数:
    
    obj - must be a Collection<? extends Measure>, Measure[], or Measure object.
    
    toAppendTo - Formatted string appended here.
    
    fpos - Identifies a field in the formatted text.
    
    返回:
    
    the string buffer passed in as toAppendTo, with formatted text appended
    
    另请参阅:
    
    Format.format(java.lang.Object, java.lang.StringBuffer, java.text.FieldPosition)
  - parseObject
```
public Measure parseObject(String source,
                           ParsePosition pos)
```
    Parses text from a string to produce a Measure.
    
    指定者:
    
    parseObject 在类中 Format
    
    参数:
    
    source - A String, part of which should be parsed.
    
    pos - A ParsePosition object with index and error index information as described above.
    
    返回:
    
    An Object parsed from the string. In case of error, returns null.
    
    抛出:
    
    UnsupportedOperationException - Not supported.
    
    另请参阅:
    
    Format.parseObject(java.lang.String, java.text.ParsePosition)
  - 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”).
    
    参数:
    
    measures - a sequence of one or more measures.
    
    返回:
    
    the formatted string.
  - 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."
    
    参数:
    
    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.
    
    返回:
    
    appendTo.
  - 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.
    
    参数:
    
    appendTo - the formatted string appended here.
    
    fpos - Identifies a field in the formatted text.
    
    measures - the measures to format.
    
    返回:
    
    appendTo.
    
    另请参阅:
    
    formatMeasures(Measure...)
  - getUnitDisplayName
```
public String getUnitDisplayName(MeasureUnit unit)
```
    Gets the display name of the specified MeasureUnit corresponding to the current locale and format width.
    
    参数:
    
    unit - The unit for which to get a display name.
    
    返回:
    
    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.
  - 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.
    
    覆盖:
    
    equals 在类中 Object
    
    参数:
    
    other - the reference object with which to compare.
    
    返回:
    
    true if this object is the same as the obj argument; false otherwise.
    
    另请参阅:
    
    Object.hashCode(), HashMap
  - hashCode
```
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(Object) 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 Object.equals(java.lang.Object) 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.
    As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java™ programming language.)
    覆盖:
    
    hashCode 在类中 Object
    
    返回:
    
    a hash code value for this object.
    
    另请参阅:
    
    Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)
  - getWidth
```
public MeasureFormat.FormatWidth getWidth()
```
    Get the format width this instance is using.
  - getLocale
```
public final ULocale getLocale()
```
    Get the locale of this instance.
  - getNumberFormat
```
public NumberFormat getNumberFormat()
```
    Get a copy of the number format.
  - getCurrencyFormat
```
public static MeasureFormat getCurrencyFormat(ULocale locale)
```
    Return a formatter for CurrencyAmount objects in the given locale.
    
    参数:
    
    locale - desired locale
    
    返回:
    
    a formatter object
  - getCurrencyFormat
```
public static MeasureFormat getCurrencyFormat(Locale locale)
```
    Return a formatter for CurrencyAmount objects in the given Locale.
    
    参数:
    
    locale - desired Locale
    
    返回:
    
    a formatter object
  - getCurrencyFormat
```
public static MeasureFormat getCurrencyFormat()
```
    Return a formatter for CurrencyAmount objects in the default FORMAT locale.
    
    返回:
    
    a formatter object
    
    另请参阅:
    
    ULocale.Category.FORMAT

类 MeasureFormat

嵌套类概要

从类继承的嵌套类/接口 java.text.Format

方法概要

从类继承的方法 java.text.Format

从类继承的方法 java.lang.Object

方法详细资料

getInstance

getInstance

getInstance

getInstance

format

parseObject

formatMeasures

formatMeasurePerUnit

formatMeasures

getUnitDisplayName

equals

hashCode

getWidth

getLocale

getNumberFormat

getCurrencyFormat

getCurrencyFormat

getCurrencyFormat