com.ibm.icu.text
Class CurrencyPluralInfo

java.lang.Object
  extended by com.ibm.icu.text.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

Constructor Summary
CurrencyPluralInfo()
          Create a CurrencyPluralInfo object for the default locale.
CurrencyPluralInfo(Locale locale)
          Create a CurrencyPluralInfo object for the given locale.
CurrencyPluralInfo(ULocale locale)
          Create a CurrencyPluralInfo object for the given locale.
 
Method Summary
 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()
          Gets a CurrencyPluralInfo instance for the default locale.
static CurrencyPluralInfo getInstance(Locale locale)
          Gets a CurrencyPluralInfo instance for the given locale.
static CurrencyPluralInfo getInstance(ULocale 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.
 
Methods inherited from class java.lang.Object
finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CurrencyPluralInfo

public CurrencyPluralInfo()
Create a CurrencyPluralInfo object for the default locale.


CurrencyPluralInfo

public CurrencyPluralInfo(Locale locale)
Create a CurrencyPluralInfo object for the given locale.

Parameters:
locale - the locale

CurrencyPluralInfo

public CurrencyPluralInfo(ULocale locale)
Create a CurrencyPluralInfo object for the given locale.

Parameters:
locale - the locale
Method Detail

getInstance

public static CurrencyPluralInfo getInstance()
Gets a CurrencyPluralInfo instance for the default locale.

Returns:
A CurrencyPluralInfo instance.

getInstance

public static CurrencyPluralInfo getInstance(Locale locale)
Gets a CurrencyPluralInfo instance for the given locale.

Parameters:
locale - the locale.
Returns:
A CurrencyPluralInfo instance.

getInstance

public static CurrencyPluralInfo getInstance(ULocale locale)
Gets a CurrencyPluralInfo instance for the given locale.

Parameters:
locale - the locale.
Returns:
A CurrencyPluralInfo instance.

getPluralRules

public PluralRules getPluralRules()
Gets plural rules of this locale, used for currency plural format

Returns:
plural rule

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

getLocale

public ULocale getLocale()
Get locale

Returns:
locale

setPluralRules

public void setPluralRules(String ruleDescription)
Set plural rules. The plural rule is set when CurrencyPluralInfo instance is created. You can call this method to reset plural rules only if you want to modify the default plural rule of the locale.

Parameters:
ruleDescription - new plural rule description

setCurrencyPluralPattern

public void setCurrencyPluralPattern(String pluralCount,
                                     String pattern)
Set currency plural patterns. The currency plural pattern is set when CurrencyPluralInfo instance is created. You can call this method to reset currency plural patterns only if you want to modify the default currency plural pattern of the locale.

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

setLocale

public void setLocale(ULocale loc)
Set locale

Parameters:
loc - the new locale to set

clone

public Object clone()
Standard override

Overrides:
clone in class Object

equals

public boolean equals(Object a)
Override equals

Overrides:
equals in class Object


Copyright (c) 2009 IBM Corporation and others.