Currency

public final class Currency extends Object
implements Serializable

Represents a currency. Currencies are identified by their ISO 4217 currency codes. Visit the ISO web site for more information.

The class is designed so that there's never more than one Currency instance for any given currency. Therefore, there's no public constructor. You obtain a Currency instance using the getInstance methods.

Public Method Summary

static Set<Currency>
getAvailableCurrencies()
Gets the set of available currencies.
String
getCurrencyCode()
Gets the ISO 4217 currency code of this currency.
int
getDefaultFractionDigits()
Gets the default number of fraction digits used with this currency.
String
getDisplayName()
Gets the name that is suitable for displaying this currency for the default DISPLAY locale.
String
getDisplayName(Locale locale)
Gets the name that is suitable for displaying this currency for the specified locale.
static Currency
getInstance(String currencyCode)
Returns the Currency instance for the given currency code.
static Currency
getInstance(Locale locale)
Returns the Currency instance for the country of the given locale.
int
getNumericCode()
Returns the ISO 4217 numeric code of this currency.
String
getSymbol(Locale locale)
Gets the symbol of this currency for the specified locale.
String
getSymbol()
Gets the symbol of this currency for the default DISPLAY locale.
String
toString()
Returns the ISO 4217 currency code of this currency.

Inherited Method Summary

Public Methods

public static Set<Currency> getAvailableCurrencies ()

Gets the set of available currencies. The returned set of currencies contains all of the available currencies, which may include currencies that represent obsolete ISO 4217 codes. The set can be modified without affecting the available currencies in the runtime.

Returns
  • the set of available currencies. If there is no currency available in the runtime, the returned set is empty.

public String getCurrencyCode ()

Gets the ISO 4217 currency code of this currency.

Returns
  • the ISO 4217 currency code of this currency.

public int getDefaultFractionDigits ()

Gets the default number of fraction digits used with this currency. For example, the default number of fraction digits for the Euro is 2, while for the Japanese Yen it's 0. In the case of pseudo-currencies, such as IMF Special Drawing Rights, -1 is returned.

Returns
  • the default number of fraction digits used with this currency

public String getDisplayName ()

Gets the name that is suitable for displaying this currency for the default DISPLAY locale. If there is no suitable display name found for the default locale, the ISO 4217 currency code is returned.

This is equivalent to calling getDisplayName(Locale.getDefault(Locale.Category.DISPLAY)).

Returns
  • the display name of this currency for the default DISPLAY locale

public String getDisplayName (Locale locale)

Gets the name that is suitable for displaying this currency for the specified locale. If there is no suitable display name found for the specified locale, the ISO 4217 currency code is returned.

Parameters
locale the locale for which a display name for this currency is needed
Returns
  • the display name of this currency for the specified locale
Throws
NullPointerException if locale is null

public static Currency getInstance (String currencyCode)

Returns the Currency instance for the given currency code.

Parameters
currencyCode the ISO 4217 code of the currency
Returns
  • the Currency instance for the given currency code
Throws
NullPointerException if currencyCode is null
IllegalArgumentException if currencyCode is not a supported ISO 4217 code.

public static Currency getInstance (Locale locale)

Returns the Currency instance for the country of the given locale. The language and variant components of the locale are ignored. The result may vary over time, as countries change their currencies. For example, for the original member countries of the European Monetary Union, the method returns the old national currencies until December 31, 2001, and the Euro from January 1, 2002, local time of the respective countries.

The method returns null for territories that don't have a currency, such as Antarctica.

Parameters
locale the locale for whose country a Currency instance is needed
Returns
  • the Currency instance for the country of the given locale, or null
Throws
NullPointerException if locale or its country code is null
IllegalArgumentException if the country of the given locale is not a supported ISO 3166 country code.

public int getNumericCode ()

Returns the ISO 4217 numeric code of this currency.

Returns
  • the ISO 4217 numeric code of this currency

public String getSymbol (Locale locale)

Gets the symbol of this currency for the specified locale. For example, for the US Dollar, the symbol is "$" if the specified locale is the US, while for other locales it may be "US$". If no symbol can be determined, the ISO 4217 currency code is returned.

Parameters
locale the locale for which a display name for this currency is needed
Returns
  • the symbol of this currency for the specified locale
Throws
NullPointerException if locale is null

public String getSymbol ()

Gets the symbol of this currency for the default DISPLAY locale. For example, for the US Dollar, the symbol is "$" if the default locale is the US, while for other locales it may be "US$". If no symbol can be determined, the ISO 4217 currency code is returned.

This is equivalent to calling getSymbol(Locale.getDefault(Locale.Category.DISPLAY)).

Returns
  • the symbol of this currency for the default DISPLAY locale

public String toString ()

Returns the ISO 4217 currency code of this currency.

Returns
  • the ISO 4217 currency code of this currency