Class Currency

java.lang.Object
com.ibm.icu.util.MeasureUnit
com.ibm.icu.util.Currency
All Implemented Interfaces:
Serializable
public class Currency extends MeasureUnit
A class encapsulating a currency, as defined by ISO 4217. A Currency object can be created given a Locale or given an ISO 4217 code. Once created, the Currency object can return various data necessary to its proper display:
  • A display symbol, for a specific locale
  • The number of fraction digits to display
  • A rounding increment
The DecimalFormat class uses these data to display currencies.

Note: This class deliberately resembles java.util.Currency but it has a completely independent implementation, and adds features not present in the JDK.

Author:
Alan Liu
See Also:
Status:
Stable ICU 2.2.

  • Field Details

    • SYMBOL_NAME

      public static final int SYMBOL_NAME
      Selector for getName() indicating a symbolic name for a currency, such as "$" for USD.
      See Also:
      Status:
      Stable ICU 2.6.

    • LONG_NAME

      public static final int LONG_NAME
      Selector for getName() indicating the long name for a currency, such as "US Dollar" for USD.
      See Also:
      Status:
      Stable ICU 2.6.

    • PLURAL_LONG_NAME

      public static final int PLURAL_LONG_NAME
      Selector for getName() indicating the plural long name for a currency, such as "US dollar" for USD in "1 US dollar", and "US dollars" for USD in "2 US dollars".
      See Also:
      Status:
      Stable ICU 4.2.

    • NARROW_SYMBOL_NAME

      public static final int NARROW_SYMBOL_NAME
      Selector for getName() indicating the narrow currency symbol.

      The narrow currency symbol is similar to the regular currency symbol, but it always takes the shortest form; for example, "$" instead of "US$" for USD in en-CA.

      See Also:
      Status:
      Stable ICU 61.

    • FORMAL_SYMBOL_NAME

      public static final int FORMAL_SYMBOL_NAME
      Selector for getName() indicating the formal currency symbol.

      The formal currency symbol is similar to the regular currency symbol, but it always takes the form used in formal settings such as banking; for example, "NT$" instead of "$" for TWD in zh-TW.

      See Also:
      Status:
      Stable ICU 67.

    • VARIANT_SYMBOL_NAME

      public static final int VARIANT_SYMBOL_NAME
      Selector for getName() indicating the variant currency symbol.

      The variant symbol for a currency is an alternative symbol that is not necessarily as widely used as the regular symbol.

      See Also:
      Status:
      Stable ICU 67.

  • Constructor Details

    • Currency

      protected Currency(String theISOCode)
      Constructs a currency object for the given ISO 4217 3-letter code. This constructor assumes that the code is valid.
      Parameters:
      theISOCode - The iso code used to construct the currency.
      Status:
      Stable ICU 3.4.

  • Method Details

    • getInstance

      public static Currency getInstance(Locale locale)
      Returns a currency object for the default currency in the given locale.
      Parameters:
      locale - the locale
      Returns:
      the currency object for this locale
      Status:
      Stable ICU 2.2.

    • getInstance

      public static Currency getInstance(ULocale locale)
      Returns a currency object for the default currency in the given locale.
      Status:
      Stable ICU 3.2.

    • getAvailableCurrencyCodes

      public static String[] getAvailableCurrencyCodes(ULocale loc, Date d)
      Returns an array of Strings which contain the currency identifiers that are valid for the given locale on the given date. If there are no such identifiers, returns null. Returned identifiers are in preference order.
      Parameters:
      loc - the locale for which to retrieve currency codes.
      d - the date for which to retrieve currency codes for the given locale.
      Returns:
      The array of ISO currency codes.
      Status:
      Stable ICU 4.0.

    • getAvailableCurrencyCodes

      public static String[] getAvailableCurrencyCodes(Locale loc, Date d)
      Returns an array of Strings which contain the currency identifiers that are valid for the given Locale on the given date. If there are no such identifiers, returns null. Returned identifiers are in preference order.
      Parameters:
      loc - the Locale for which to retrieve currency codes.
      d - the date for which to retrieve currency codes for the given locale.
      Returns:
      The array of ISO currency codes.
      Status:
      Stable ICU 54.

    • getAvailableCurrencies

      public static Set<Currency> getAvailableCurrencies()
      Returns the set of available currencies. The returned set of currencies contains all of the available currencies, including obsolete ones. The result set can be modified without affecting the available currencies in the runtime.
      Returns:
      The set of available currencies. The returned set could be empty if there is no currency data available.
      Status:
      Stable ICU 49.

    • getInstance

      public static Currency getInstance(String theISOCode)
      Returns a currency object given an ISO 4217 3-letter code.
      Parameters:
      theISOCode - the iso code
      Returns:
      the currency for this iso code
      Throws:
      NullPointerException - if theISOCode is null.
      IllegalArgumentException - if theISOCode is not a 3-letter alpha code.
      Status:
      Stable ICU 2.2.

    • fromJavaCurrency

      public static Currency fromJavaCurrency(Currency currency)
      Returns a Currency object based on the currency represented by the given java.util.Currency.
      Parameters:
      currency - The Java currency object to convert.
      Returns:
      An equivalent ICU currency object.
      Status:
      Stable ICU 60.

    • toJavaCurrency

      public Currency toJavaCurrency()
      Returns a java.util.Currency object based on the currency represented by this Currency.
      Returns:
      An equivalent Java currency object.
      Status:
      Stable ICU 60.

    • registerInstance

      public static Object registerInstance(Currency currency, ULocale locale)
      Registers a new currency for the provided locale. The returned object is a key that can be used to unregister this currency object.

      Because ICU may choose to cache Currency objects internally, this must be called at application startup, prior to any calls to Currency.getInstance to avoid undefined behavior.

      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:
      Status:
      Stable ICU 3.2.

    • unregister

      public static boolean unregister(Object registryKey)
      Unregister the currency associated with this key (obtained from registerInstance).
      Parameters:
      registryKey - the registry key returned from registerInstance
      See Also:
      Status:
      Stable ICU 2.6.

    • getAvailableLocales

      public static Locale[] getAvailableLocales()
      Return an array of the locales for which a currency is defined.
      Returns:
      an array of the available locales
      Status:
      Stable ICU 2.2.

    • getAvailableULocales

      public static ULocale[] getAvailableULocales()
      Return an array of the ulocales for which a currency is defined.
      Returns:
      an array of the available ulocales
      Status:
      Stable ICU 3.2.

    • getKeywordValuesForLocale

      public static final String[] getKeywordValuesForLocale(String key, ULocale locale, boolean commonlyUsed)
      Given a key and a locale, returns an array of values for the key for which data exists. If commonlyUsed is true, these are the values that typically are used with this locale, otherwise these are all values for which data exists. This is a common service API.

      The only supported key is "currency", other values return an empty array.

      Currency information is based on the region of the locale. If the locale does not indicate a region, ULocale.addLikelySubtags(ULocale) is used to infer a region, except for the 'und' locale.

      If commonlyUsed is true, only the currencies known to be in use as of the current date are returned. When there are more than one, these are returned in preference order (typically, this occurs when a country is transitioning to a new currency, and the newer currency is preferred), see Unicode TR#35 Sec. C1. If commonlyUsed is false, all currencies ever used in any locale are returned, in no particular order.

      Parameters:
      key - key whose values to look up. the only recognized key is "currency"
      locale - the locale
      commonlyUsed - if true, return only values that are currently used in the locale. Otherwise returns all values.
      Returns:
      an array of values for the given key and the locale. If there is no data, the array will be empty.
      Status:
      Stable ICU 4.2.

    • getCurrencyCode

      public String getCurrencyCode()
      Returns the ISO 4217 3-letter code for this currency object.
      Status:
      Stable ICU 2.2.

    • getNumericCode

      public int getNumericCode()
      Returns the ISO 4217 numeric code for this currency object.

      Note: If the ISO 4217 numeric code is not assigned for the currency or the currency is unknown, this method returns 0.

      Returns:
      The ISO 4217 numeric code of this currency.
      Status:
      Stable ICU 49.

    • getSymbol

      public String getSymbol()
      Convenience and compatibility override of getName that requests the symbol name for the default DISPLAY locale.
      See Also:
      Status:
      Stable ICU 3.4.

    • getSymbol

      public String getSymbol(Locale loc)
      Convenience and compatibility override of getName that requests the symbol name.
      Parameters:
      loc - the Locale for the symbol
      See Also:
      Status:
      Stable ICU 3.4.

    • getSymbol

      public String getSymbol(ULocale uloc)
      Convenience and compatibility override of getName that requests the symbol name.
      Parameters:
      uloc - the ULocale for the symbol
      See Also:
      Status:
      Stable ICU 3.4.

    • getName

      public String getName(Locale locale, int nameStyle, boolean[] isChoiceFormat)
      Returns the display name for the given currency in the given locale. This is a convenient method for getName(ULocale, int, boolean[]);
      Parameters:
      locale - locale in which to display currency
      nameStyle - selector for which kind of name to return. The nameStyle should be SYMBOL_NAME, NARROW_SYMBOL_NAME, or LONG_NAME. Otherwise, throw IllegalArgumentException.
      isChoiceFormat - isChoiceFormat[0] is always set to false, or isChoiceFormat can be null; display names are static strings; since ICU 4.4, ChoiceFormat patterns are no longer supported
      Returns:
      display string for this currency. If the resource data contains no entry for this currency, then the ISO 4217 code is returned.
      Status:
      Stable ICU 3.2.

    • getName

      public String getName(ULocale locale, int nameStyle, boolean[] isChoiceFormat)
      Returns the display name for the given currency in the given locale. For example, the display name for the USD currency object in the en_US locale is "$".
      Parameters:
      locale - locale in which to display currency
      nameStyle - selector for which kind of name to return. The nameStyle should be SYMBOL_NAME, NARROW_SYMBOL_NAME, or LONG_NAME. Otherwise, throw IllegalArgumentException.
      isChoiceFormat - isChoiceFormat[0] is always set to false, or isChoiceFormat can be null; display names are static strings; since ICU 4.4, ChoiceFormat patterns are no longer supported
      Returns:
      display string for this currency. If the resource data contains no entry for this currency, then the ISO 4217 code is returned.
      Throws:
      IllegalArgumentException - if the nameStyle is not SYMBOL_NAME or LONG_NAME.
      See Also:
      Status:
      Stable ICU 3.2.

    • getName

      public String getName(Locale locale, int nameStyle, String pluralCount, boolean[] isChoiceFormat)
      Returns the display name for the given currency in the given locale. This is a convenience overload of getName(ULocale, int, String, boolean[]);
      Parameters:
      locale - locale in which to display currency
      nameStyle - selector for which kind of name to return
      pluralCount - plural count string for this locale
      isChoiceFormat - isChoiceFormat[0] is always set to false, or isChoiceFormat can be null; display names are static strings; since ICU 4.4, ChoiceFormat patterns are no longer supported
      Returns:
      display string for this currency. If the resource data contains no entry for this currency, then the ISO 4217 code is returned.
      Status:
      Stable ICU 4.2.

    • getName

      public String getName(ULocale locale, int nameStyle, String pluralCount, boolean[] isChoiceFormat)
      Returns the display name for the given currency in the given locale. For example, the SYMBOL_NAME for the USD currency object in the en_US locale is "$". The PLURAL_LONG_NAME for the USD currency object when the currency amount is plural is "US dollars", such as in "3.00 US dollars"; while the PLURAL_LONG_NAME for the USD currency object when the currency amount is singular is "US dollar", such as in "1.00 US dollar".
      Parameters:
      locale - locale in which to display currency
      nameStyle - selector for which kind of name to return
      pluralCount - plural count string for this locale
      isChoiceFormat - isChoiceFormat[0] is always set to false, or isChoiceFormat can be null; display names are static strings; since ICU 4.4, ChoiceFormat patterns are no longer supported
      Returns:
      display string for this currency. If the resource data contains no entry for this currency, then the ISO 4217 code is returned.
      Throws:
      IllegalArgumentException - if the nameStyle is not SYMBOL_NAME, LONG_NAME, or PLURAL_LONG_NAME.
      Status:
      Stable ICU 4.2.

    • getDisplayName

      public String getDisplayName()
      Returns the display name for this currency in the default locale. If the resource data for the default locale contains no entry for this currency, then the ISO 4217 code is returned.

      Note: This method is a convenience equivalent for Currency.getDisplayName() and is equivalent to getName(Locale.getDefault(), LONG_NAME, null).

      Returns:
      The display name of this currency
      See Also:
      Status:
      Stable ICU 49.

    • getDisplayName

      public String getDisplayName(Locale locale)
      Returns the display name for this currency in the given locale. If the resource data for the given locale contains no entry for this currency, then the ISO 4217 code is returned.

      Note: This method is a convenience equivalent for Currency.getDisplayName(java.util.Locale) and is equivalent to getName(locale, LONG_NAME, null).

      Parameters:
      locale - locale in which to display currency
      Returns:
      The display name of this currency for the specified locale
      See Also:
      Status:
      Stable ICU 49.

    • parse

      @Deprecated public static String parse(ULocale locale, String text, int type, ParsePosition pos)
      Deprecated.
      This API is ICU internal only.
      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. If multiple display names match, then the longest one is selected. If both a display name and a 3-letter ISO code match, then the display name is preferred, unless it's length is less than 3.
      Parameters:
      locale - the locale of the display names to match
      text - the text to parse
      type - parse against currency type: LONG_NAME only or not
      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
      Status:
      Internal. This API is ICU internal only.

    • getParsingTrie

      @Deprecated public static com.ibm.icu.impl.TextTrieMap<Currency.CurrencyStringInfo> getParsingTrie(ULocale locale, int type)
      Deprecated.
      This API is ICU internal only.
      Status:
      Internal. This API is ICU internal only.

    • getDefaultFractionDigits

      public int getDefaultFractionDigits()
      Returns the number of the number of fraction digits that should be displayed for this currency. This is equivalent to getDefaultFractionDigits(CurrencyUsage.STANDARD);

      Important: The number of fraction digits for a given currency is NOT guaranteed to be constant across versions of ICU or CLDR. For example, do NOT use this value as a mechanism for deciding the magnitude used to store currency values in a database. You should use this value for display purposes only.

      Returns:
      a non-negative number of fraction digits to be displayed
      Status:
      Stable ICU 2.2.

    • getDefaultFractionDigits

      public int getDefaultFractionDigits(Currency.CurrencyUsage Usage)
      Returns the number of the number of fraction digits that should be displayed for this currency with Usage.

      Important: The number of fraction digits for a given currency is NOT guaranteed to be constant across versions of ICU or CLDR. For example, do NOT use this value as a mechanism for deciding the magnitude used to store currency values in a database. You should use this value for display purposes only.

      Parameters:
      Usage - the usage of currency(Standard or Cash)
      Returns:
      a non-negative number of fraction digits to be displayed
      Status:
      Stable ICU 54.

    • getRoundingIncrement

      public double getRoundingIncrement()
      Returns the rounding increment for this currency, or 0.0 if no rounding is done by this currency. This is equivalent to getRoundingIncrement(CurrencyUsage.STANDARD);
      Returns:
      the non-negative rounding increment, or 0.0 if none
      Status:
      Stable ICU 2.2.

    • getRoundingIncrement

      public double getRoundingIncrement(Currency.CurrencyUsage Usage)
      Returns the rounding increment for this currency, or 0.0 if no rounding is done by this currency with the Usage.
      Parameters:
      Usage - the usage of currency(Standard or Cash)
      Returns:
      the non-negative rounding increment, or 0.0 if none
      Status:
      Stable ICU 54.

    • toString

      public String toString()
      Returns the ISO 4217 code for this currency.
      Overrides:
      toString in class MeasureUnit
      Status:
      Stable ICU 2.2.

    • isAvailable

      public static boolean isAvailable(String code, Date from, Date to)
      Queries if the given ISO 4217 3-letter code is available on the specified date range.

      Note: For checking availability of a currency on a specific date, specify the date on both from and to. When both from and to are null, this method checks if the specified currency is available all time.

      Parameters:
      code - The ISO 4217 3-letter code.
      from - The lower bound of the date range, inclusive. When from is null, check the availability of the currency any date before to
      to - The upper bound of the date range, inclusive. When to is null, check the availability of the currency any date after from
      Returns:
      true if the given ISO 4217 3-letter code is supported on the specified date range.
      Throws:
      IllegalArgumentException - when to is before from.
      Status:
      Stable ICU 4.6.