Added in API level 24

Summary: Ctors | Methods | Inherited Methods

CurrencyPluralInfo

Kotlin |Java

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

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Public constructors

CurrencyPluralInfo

Added in API level 24

public CurrencyPluralInfo ()

Create a CurrencyPluralInfo object for the default FORMAT locale.

See also:

ULocale.Category.FORMAT

CurrencyPluralInfo

Added in API level 24

public CurrencyPluralInfo (Locale locale)

Create a CurrencyPluralInfo object for the given locale.

Parameters
`locale`	`Locale`: the locale

CurrencyPluralInfo

Added in API level 24

public CurrencyPluralInfo (ULocale locale)

Create a CurrencyPluralInfo object for the given locale.

Parameters
`locale`	`ULocale`: the locale

Public methods

clone

Added in API level 24

public Object clone ()

Standard override

Returns
`Object`	a clone of this instance.

equals

Added in API level 24

public 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

public 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

public static 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

public static CurrencyPluralInfo getInstance ()

Gets a CurrencyPluralInfo instance for the default locale.

Returns
`CurrencyPluralInfo`	A CurrencyPluralInfo instance.

getInstance

Added in API level 24

public static 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

public ULocale getLocale ()

Get locale

Returns
`ULocale`	locale

getPluralRules

Added in API level 24

public PluralRules getPluralRules ()

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

Returns
`PluralRules`	plural rule

setCurrencyPluralPattern

Added in API level 24

public 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

public 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

public 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