Package com.ibm.icu.text

Class CurrencyPluralInfo

  • All Implemented Interfaces:
    Serializable, Cloneable
    public class CurrencyPluralInfo
extends Object
implements Cloneable, Serializable
    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.
    See Also:
    Serialized Form
    Status:
    Stable ICU 4.2.

    • Constructor Detail

      • CurrencyPluralInfo

        public CurrencyPluralInfo()
        Create a CurrencyPluralInfo object for the default FORMAT locale.
        See Also:
        ULocale.Category.FORMAT
        Status:
        Stable ICU 4.2.

      • CurrencyPluralInfo

        public CurrencyPluralInfo​(Locale locale)
        Create a CurrencyPluralInfo object for the given locale.
        Parameters:
        locale - the locale
        Status:
        Stable ICU 4.2.

      • CurrencyPluralInfo

        public CurrencyPluralInfo​(ULocale locale)
        Create a CurrencyPluralInfo object for the given locale.
        Parameters:
        locale - the locale
        Status:
        Stable ICU 4.2.

    • Method Detail

      • getInstance

        public static CurrencyPluralInfo getInstance()
        Gets a CurrencyPluralInfo instance for the default locale.
        Returns:
        A CurrencyPluralInfo instance.
        Status:
        Stable ICU 4.2.

      • getInstance

        public static CurrencyPluralInfo getInstance​(Locale locale)
        Gets a CurrencyPluralInfo instance for the given locale.
        Parameters:
        locale - the locale.
        Returns:
        A CurrencyPluralInfo instance.
        Status:
        Stable ICU 4.2.

      • getInstance

        public static CurrencyPluralInfo getInstance​(ULocale locale)
        Gets a CurrencyPluralInfo instance for the given locale.
        Parameters:
        locale - the locale.
        Returns:
        A CurrencyPluralInfo instance.
        Status:
        Stable ICU 4.2.

      • getPluralRules

        public PluralRules getPluralRules()
        Gets plural rules of this locale, used for currency plural format
        Returns:
        plural rule
        Status:
        Stable ICU 4.2.

      • getCurrencyPluralPattern

        public String getCurrencyPluralPattern​(String pluralCount)
        Given a plural count, gets currency plural pattern of this locale, used for currency plural format
        Parameters:
        pluralCount - currency plural count
        Returns:
        a currency plural pattern based on plural count
        Status:
        Stable ICU 4.2.

      • getLocale

        public ULocale getLocale()
        Get locale
        Returns:
        locale
        Status:
        Stable ICU 4.2.

      • setPluralRules

        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 - new plural rule description
        Status:
        Stable ICU 4.2.

      • setCurrencyPluralPattern

        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 - the plural count for which the currency pattern will be overridden.
        pattern - the new currency plural pattern
        Status:
        Stable ICU 4.2.

      • setLocale

        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 - the new locale to set
        Status:
        Stable ICU 4.2.

      • equals

        public boolean equals​(Object a)
        Override equals
        Overrides:
        equals in class Object
        Status:
        Stable ICU 4.2.

      • hashCode

        public int hashCode()
        Override hashCode
        Overrides:
        hashCode in class Object
        Status:
        Stable ICU 4.2.

      • select

        @Deprecated
public String select​(PluralRules.FixedDecimal numberInfo)
        Deprecated.
        This API is ICU internal only.
        Given a number, returns the keyword of the first rule that applies to the number.
        Status:
        Internal. This API is ICU internal only.

      • pluralPatternIterator

        @Deprecated
public Iterator<String> pluralPatternIterator()
        Deprecated.
        This API is ICU internal only.
        Currency plural pattern iterator.
        Returns:
        a iterator on the currency plural pattern key set.
        Status:
        Internal. This API is ICU internal only.