CurrencyPluralInfo

public class CurrencyPluralInfo
extends Object implements Cloneable, Serializable

java.lang.Object
   ↳ android.icu.text.CurrencyPluralInfo


This class represents the information needed by DecimalFormat to format currency plural, such as "3.00 US dollars" or "1.00 US dollar". DecimalFormat creates for itself an instance of CurrencyPluralInfo from its locale data. If you need to change any of these symbols, you can get the CurrencyPluralInfo object from your DecimalFormat and modify it. Following are the information needed for currency plural format and parse: locale information, plural rule of the locale, currency plural pattern of the locale.

Summary

Public constructors

CurrencyPluralInfo()

Create a CurrencyPluralInfo object for the default FORMAT locale.

CurrencyPluralInfo(Locale locale)

Create a CurrencyPluralInfo object for the given locale.

CurrencyPluralInfo(ULocale locale)

Create a CurrencyPluralInfo object for the given locale.

Public methods

Object clone()

Standard override

boolean equals(Object a)

Override equals

String getCurrencyPluralPattern(String pluralCount)

Given a plural count, gets currency plural pattern of this locale, used for currency plural format

static CurrencyPluralInfo getInstance(ULocale locale)

Gets a CurrencyPluralInfo instance for the given locale.

static CurrencyPluralInfo getInstance()

Gets a CurrencyPluralInfo instance for the default locale.

static CurrencyPluralInfo getInstance(Locale locale)

Gets a CurrencyPluralInfo instance for the given locale.

ULocale getLocale()

Get locale

PluralRules getPluralRules()

Gets plural rules of this locale, used for currency plural format

void setCurrencyPluralPattern(String pluralCount, String pattern)

Set currency plural patterns.

void setLocale(ULocale loc)

Set locale.

void setPluralRules(String ruleDescription)

Set plural rules.

Inherited methods

Public constructors

CurrencyPluralInfo

added in API level 24
CurrencyPluralInfo ()

Create a CurrencyPluralInfo object for the default FORMAT locale.

See also:

CurrencyPluralInfo

added in API level 24
CurrencyPluralInfo (Locale locale)

Create a CurrencyPluralInfo object for the given locale.

Parameters
locale Locale: the locale

CurrencyPluralInfo

added in API level 24
CurrencyPluralInfo (ULocale locale)

Create a CurrencyPluralInfo object for the given locale.

Parameters
locale ULocale: the locale

Public methods

clone

added in API level 24
Object clone ()

Standard override

Returns
Object a clone of this instance.

equals

added in API level 24
boolean equals (Object a)

Override equals

Parameters
a Object: the reference object with which to compare.

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

getCurrencyPluralPattern

added in API level 24
String getCurrencyPluralPattern (String pluralCount)

Given a plural count, gets currency plural pattern of this locale, used for currency plural format

Parameters
pluralCount String: currency plural count

Returns
String a currency plural pattern based on plural count

getInstance

added in API level 24
CurrencyPluralInfo getInstance (ULocale locale)

Gets a CurrencyPluralInfo instance for the given locale.

Parameters
locale ULocale: the locale.

Returns
CurrencyPluralInfo A CurrencyPluralInfo instance.

getInstance

added in API level 24
CurrencyPluralInfo getInstance ()

Gets a CurrencyPluralInfo instance for the default locale.

Returns
CurrencyPluralInfo A CurrencyPluralInfo instance.

getInstance

added in API level 24
CurrencyPluralInfo getInstance (Locale locale)

Gets a CurrencyPluralInfo instance for the given locale.

Parameters
locale Locale: the locale.

Returns
CurrencyPluralInfo A CurrencyPluralInfo instance.

getLocale

added in API level 24
ULocale getLocale ()

Get locale

Returns
ULocale locale

getPluralRules

added in API level 24
PluralRules getPluralRules ()

Gets plural rules of this locale, used for currency plural format

Returns
PluralRules plural rule

setCurrencyPluralPattern

added in API level 24
void setCurrencyPluralPattern (String pluralCount, 
                String pattern)

Set currency plural patterns. These are initially set in the constructor based on the locale, and usually do not need to be changed. The decimal digits part of the pattern cannot be specified via this method. All plural forms will use the same decimal pattern as set in the constructor of DecimalFormat. For example, you can't set "0.0" for plural "few" but "0.00" for plural "many".

Parameters
pluralCount String: the plural count for which the currency pattern will be overridden.

pattern String: the new currency plural pattern

setLocale

added in API level 24
void setLocale (ULocale loc)

Set locale. This also sets both the plural rules and the currency plural patterns to be the defaults for the locale.

Parameters
loc ULocale: the new locale to set

setPluralRules

added in API level 24
void setPluralRules (String ruleDescription)

Set plural rules. These are initially set in the constructor based on the locale, and usually do not need to be changed.

Parameters
ruleDescription String: new plural rule description