com.ibm.icu.util
public class Currency extends MeasureUnit implements Serializable
Note: This class deliberately resembles java.util.Currency but it has a completely independent implementation, and adds features not present in the JDK.
UNKNOWN: ICU 2.2
Field Summary | |
---|---|
static int | LONG_NAME
Selector for ucurr_getName indicating the long name for a
currency, such as "US Dollar" for USD. |
static int | SYMBOL_NAME
Selector for getName() indicating a symbolic name for a
currency, such as "$" for USD. |
Constructor Summary | |
---|---|
protected | Currency(String theISOCode)
Constructs a currency object for the given ISO 4217 3-letter
code. |
Method Summary | |
---|---|
boolean | equals(Object rhs)
Return true if rhs is a Currency instance,
is non-null, and has the same currency code. |
static Locale[] | getAvailableLocales()
Return an array of the locales for which a currency
is defined. |
static ULocale[] | getAvailableULocales()
Return an array of the ulocales for which a currency
is defined. |
String | getCurrencyCode()
Returns the ISO 4217 3-letter code for this currency object. |
int | getDefaultFractionDigits()
Returns the number of the number of fraction digits that should
be displayed for this currency. |
static Currency | getInstance(Locale locale)
Returns a currency object for the default currency in the given
locale. |
static Currency | getInstance(ULocale locale)
Returns a currency object for the default currency in the given
locale. |
static Currency | getInstance(String theISOCode)
Returns a currency object given an ISO 4217 3-letter code. |
ULocale | getLocale(ULocale.Type type)
Return the locale that was used to create this object, or null.
|
String | getName(Locale locale, int nameStyle, boolean[] isChoiceFormat)
Returns the display name for the given currency in the
given locale. |
String | getName(ULocale locale, int nameStyle, boolean[] isChoiceFormat)
Returns the display name for the given currency in the
given locale. |
double | getRoundingIncrement()
Returns the rounding increment for this currency, or 0.0 if no
rounding is done by this currency. |
String | getSymbol()
Convenience and compatibility override of getName that
requests the symbol name. |
String | getSymbol(Locale loc)
Convenience and compatibility override of getName that
requests the symbol name. |
String | getSymbol(ULocale uloc)
Convenience and compatibility override of getName that
requests the symbol name. |
int | hashCode()
Return a hashcode for this currency. |
static String | parse(ULocale locale, String text, ParsePosition pos)
Attempt to parse the given string as a currency, either as a
display name in the given locale, or as a 3-letter ISO 4217
code. |
static Object | registerInstance(Currency currency, ULocale locale)
Registers a new currency for the provided locale. |
String | toString()
Returns the ISO 4217 code for this currency. |
static boolean | unregister(Object registryKey)
Unregister the currency associated with this key (obtained from
registerInstance). |
UNKNOWN: ICU 2.6
UNKNOWN: ICU 2.6
Parameters: theISOCode The iso code used to construct the currency.
UNKNOWN: ICU 3.4 This API might change or be removed in a future release.
UNKNOWN: ICU 2.2
Returns: an array of the available locales
UNKNOWN: ICU 2.2
Returns: an array of the available ulocales
UNKNOWN: ICU 3.2
UNKNOWN: ICU 2.2
Returns: a non-negative number of fraction digits to be displayed
UNKNOWN: ICU 2.2
Parameters: locale the locale
Returns: the currency object for this locale
UNKNOWN: ICU 2.2
UNKNOWN: ICU 3.2 This API might change or be removed in a future release.
Parameters: theISOCode the iso code
Returns: the currency for this iso code
UNKNOWN: ICU 2.2
Note: This method will be obsoleted. The implementation is no longer locale-specific and so there is no longer a valid or actual locale associated with the Currency object. Until it is removed, this method will return the root locale.
Parameters: type type of information requested, either {@link com.ibm.icu.util.ULocale#VALID_LOCALE} or {@link com.ibm.icu.util.ULocale#ACTUAL_LOCALE}.
Returns: the information specified by type, or null if this object was not constructed from locale data.
See Also: ULocale VALID_LOCALE ACTUAL_LOCALE
UNKNOWN: ICU 3.2 to be removed This API might change or be removed in a future release.
Parameters: locale locale in which to display currency nameStyle selector for which kind of name to return isChoiceFormat fill-in; isChoiceFormat[0] is set to true if the returned value is a ChoiceFormat pattern; otherwise it is set to false
Returns: display string for this currency. If the resource data contains no entry for this currency, then the ISO 4217 code is returned. If isChoiceFormat[0] is true, then the result is a ChoiceFormat pattern. Otherwise it is a static string.
UNKNOWN: ICU 3.2 This API might change or be removed in a future release.
Parameters: locale locale in which to display currency nameStyle selector for which kind of name to return isChoiceFormat fill-in; isChoiceFormat[0] is set to true if the returned value is a ChoiceFormat pattern; otherwise it is set to false
Returns: display string for this currency. If the resource data contains no entry for this currency, then the ISO 4217 code is returned. If isChoiceFormat[0] is true, then the result is a ChoiceFormat pattern. Otherwise it is a static string.
UNKNOWN: ICU 3.2 This API might change or be removed in a future release.
Returns: the non-negative rounding increment, or 0.0 if none
UNKNOWN: ICU 2.2
See Also: Currency
UNKNOWN: ICU 3.4 This API might change or be removed in a future release.
Parameters: loc the Locale for the symbol
See Also: Currency
UNKNOWN: ICU 3.4 This API might change or be removed in a future release.
Parameters: uloc the ULocale for the symbol
See Also: Currency
UNKNOWN: ICU 3.4 This API might change or be removed in a future release.
UNKNOWN: ICU 2.2
Parameters: locale the locale of the display names to match text the text to parse pos input-output position; on input, the position within text to match; must have 0 <= pos.getIndex() < text.length(); on output, the position after the last matched character. If the parse fails, the position in unchanged upon output.
Returns: the ISO 4217 code, as a string, of the best match, or null if there is no match
UNKNOWN:
Parameters: currency the currency to register locale the ulocale under which to register the currency
Returns: a registry key that can be used to unregister this currency
See Also: Currency
UNKNOWN: ICU 3.2 This API might change or be removed in a future release.
UNKNOWN: ICU 2.2
Parameters: registryKey the registry key returned from registerInstance
See Also: Currency
UNKNOWN: ICU 2.6