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.
Public constructors | |
---|---|
CurrencyPluralInfo()
Create a CurrencyPluralInfo object for the default |
|
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 | |
---|---|
From
class
java.lang.Object
|
CurrencyPluralInfo ()
Create a CurrencyPluralInfo object for the default FORMAT
locale.
See also:
CurrencyPluralInfo (Locale locale)
Create a CurrencyPluralInfo object for the given locale.
Parameters | |
---|---|
locale |
Locale :
the locale
|
CurrencyPluralInfo (ULocale locale)
Create a CurrencyPluralInfo object for the given locale.
Parameters | |
---|---|
locale |
ULocale :
the locale
|
Object clone ()
Standard override
Returns | |
---|---|
Object |
a clone of this instance. |
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. |
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 |
CurrencyPluralInfo getInstance (ULocale locale)
Gets a CurrencyPluralInfo instance for the given locale.
Parameters | |
---|---|
locale |
ULocale :
the locale. |
Returns | |
---|---|
CurrencyPluralInfo |
A CurrencyPluralInfo instance. |
CurrencyPluralInfo getInstance ()
Gets a CurrencyPluralInfo instance for the default locale.
Returns | |
---|---|
CurrencyPluralInfo |
A CurrencyPluralInfo instance. |
CurrencyPluralInfo getInstance (Locale locale)
Gets a CurrencyPluralInfo instance for the given locale.
Parameters | |
---|---|
locale |
Locale :
the locale. |
Returns | |
---|---|
CurrencyPluralInfo |
A CurrencyPluralInfo instance. |
PluralRules getPluralRules ()
Gets plural rules of this locale, used for currency plural format
Returns | |
---|---|
PluralRules |
plural rule |
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.
Parameters | |
---|---|
pluralCount |
String :
the plural count for which the currency pattern will
be overridden. |
pattern |
String :
the new currency plural pattern
|
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
|
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
|