International Components for Unicode for Java (icu4j) 74.2 · com.ibm.icu.text.QuantityFormatter

Modifier and Type	Field and Description
private final SimpleFormatter[]	templates

Access	Constructor and Description
public	QuantityFormatter()

Method Summary

Modifier and Type	Method and Description
public void	addIfAbsent(CharSequence the plural variant, e.g "zero", "one", "two", "few", "many", "other" variant, String the text for that plural variant with "{0}" as the quantity. For example, in English, the template for the "one" variant may be "{0} apple" while the template for the "other" variant may be "{0} apples" template) Adds a template if there is none yet for the plural form.
public String	Returns: the formatted string e.g '3 apples' format(double the number to be formatted number, NumberFormat used to actually format the number. numberFormat, PluralRules uses the number and the numberFormat to determine what plural variant to use for fetching the formatting template. pluralRules) Format formats a number with this object.
public static StringBuilder	format(String compiledPattern, CharSequence value, StringBuilder appendTo, FieldPosition pos) Formats the pattern with the value and adjusts the FieldPosition.
public SimpleFormatter	Returns: the SimpleFormatter getByVariant(CharSequence "zero", "one", "two", "few", "many", "other" variant) Gets the SimpleFormatter for a particular variant.
public boolean	Returns: true if this object has at least the "other" variant isValid()
public static StandardPlural	selectPlural(double number, NumberFormat numberFormat, PluralRules rules) Selects the standard plural form for the number/formatter/rules.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

templates	back to summary
private final SimpleFormatter[] templates

QuantityFormatter	back to summary
public QuantityFormatter()

addIfAbsent	back to summary
public void addIfAbsent(CharSequence variant, String template) Adds a template if there is none yet for the plural form. Parameters variant:CharSequence the plural variant, e.g "zero", "one", "two", "few", "many", "other" template:String the text for that plural variant with "{0}" as the quantity. For example, in English, the template for the "one" variant may be "{0} apple" while the template for the "other" variant may be "{0} apples" Exceptions IllegalArgumentException: if variant is not recognized or if template has more than just the {0} placeholder.

addIfAbsent

public void addIfAbsent(CharSequence variant, String template)

Adds a template if there is none yet for the plural form.

Parameters

variant:CharSequence: the plural variant, e.g "zero", "one", "two", "few", "many", "other"
template:String: the text for that plural variant with "{0}" as the quantity. For example, in English, the template for the "one" variant may be "{0} apple" while the template for the "other" variant may be "{0} apples"

Exceptions

IllegalArgumentException:: if variant is not recognized or if template has more than just the {0} placeholder.

format	back to summary
public String format(double number, NumberFormat numberFormat, PluralRules pluralRules) Format formats a number with this object. Parameters number:double the number to be formatted numberFormat:NumberFormat used to actually format the number. pluralRules:PluralRules uses the number and the numberFormat to determine what plural variant to use for fetching the formatting template. Returns:String the formatted string e.g '3 apples'

format

public String format(double number, NumberFormat numberFormat, PluralRules pluralRules)

Format formats a number with this object.

Parameters

number:double: the number to be formatted
numberFormat:NumberFormat: used to actually format the number.
pluralRules:PluralRules: uses the number and the numberFormat to determine what plural variant to use for fetching the formatting template.

Returns:String

the formatted string e.g '3 apples'

format	back to summary
public static StringBuilder format(String compiledPattern, CharSequence value, StringBuilder appendTo, FieldPosition pos) Formats the pattern with the value and adjusts the FieldPosition.

getByVariant	back to summary
public SimpleFormatter getByVariant(CharSequence variant) Gets the SimpleFormatter for a particular variant. Parameters variant:CharSequence "zero", "one", "two", "few", "many", "other" Returns:SimpleFormatter the SimpleFormatter

getByVariant

public SimpleFormatter getByVariant(CharSequence variant)

Gets the SimpleFormatter for a particular variant.

Parameters

the SimpleFormatter

isValid	back to summary
public boolean isValid() Returns:boolean true if this object has at least the "other" variant

selectPlural	back to summary
public static StandardPlural selectPlural(double number, NumberFormat numberFormat, PluralRules rules) Selects the standard plural form for the number/formatter/rules.