Serializablepublic final class Currency extends Object implements Serializable
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.
Users can supersede the Java runtime currency data by means of the system property java.util.currency.data. If this system property is defined then its value is the location of a properties file, the contents of which are key/value pairs of the ISO 3166 country codes and the ISO 4217 currency data respectively. The value part consists of three ISO 4217 values of a currency, i.e., an alphabetic code, a numeric code, and a minor unit. Those three ISO 4217 values are separated by commas. The lines which start with '#'s are considered comment lines. An optional UTC timestamp may be specified per currency entry if users need to specify a cutover date indicating when the new data comes into effect. The timestamp is appended to the end of the currency properties and uses a comma as a separator. If a UTC datestamp is present and valid, the JRE will only use the new currency properties if the current UTC date is later than the date specified at class loading time. The format of the timestamp must be of ISO 8601 format : 'yyyy-MM-dd'T'HH:mm:ss'. For example,
#Sample currency properties
JP=JPZ,999,0
will supersede the currency data for Japan. If JPZ is one of the existing ISO 4217 currency code referred by other countries, the existing JPZ currency data is updated with the given numeric code and minor unit value.
#Sample currency properties with cutover date
JP=JPZ,999,0,2014-01-01T00:00:00
will supersede the currency data for Japan if Currency class is loaded after 1st January 2014 00:00:00 GMT.
Where syntactically malformed entries are encountered, the entry is ignored and the remainder of entries in file are processed. For instances where duplicate country code entries exist, the behavior of the Currency information for that Currency is undefined and the remainder of entries in file are processed.
If multiple property entries with same currency code but different numeric code and/or minor unit are encountered, those entries are ignored and the remainder of entries in file are processed.
It is recommended to use BigDecimal class while dealing with Currency or monetary values as it provides better handling of floating point numbers and their operations.
| Modifier and Type | Method | Description |
|---|---|---|
static Set |
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 |
Gets the name that is suitable for displaying this currency for the specified locale. |
static Currency |
getInstance |
Returns the Currency instance for the given currency code. |
static Currency |
getInstance |
Returns the Currency instance for the country of the given locale. |
int |
getNumericCode() |
Returns the ISO 4217 numeric code of this currency. |
String |
getNumericCodeAsString() |
Returns the 3 digit ISO 4217 numeric code of this currency as a String. |
String |
getSymbol() |
Gets the symbol of this currency for the default DISPLAY locale. |
String |
getSymbol |
Gets the symbol of this currency for the specified locale. |
String |
toString() |
Returns the ISO 4217 currency code of this currency. |
public static Currency getInstance(String currencyCode)
Currency instance for the given currency code.currencyCode - the ISO 4217 code of the currencyCurrency instance for the given currency codeNullPointerException - if currencyCode is nullIllegalArgumentException - if currencyCode is not a supported ISO 4217 code.public static Currency getInstance(Locale locale)
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. If the specified locale contains "cu" and/or "rg" Unicode extensions, the instance returned from this method reflects the values specified with those extensions. If both "cu" and "rg" are specified, the currency from the "cu" extension supersedes the implicit one from the "rg" extension.
The method returns null for territories that don't have a currency, such as Antarctica.
locale - the locale for whose country a Currency instance is neededCurrency instance for the country of the given locale, or null
NullPointerException - if locale is null
IllegalArgumentException - if the country of the given locale is not a supported ISO 3166 country code.public static Set<Currency> getAvailableCurrencies()
public String getCurrencyCode()
public String getSymbol()
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. If the default DISPLAY locale contains "rg" (region override) Unicode extensions, the symbol returned from this method reflects the value specified with that extension.
This is equivalent to calling getSymbol(Locale.getDefault(Locale.Category.DISPLAY)).
DISPLAY localepublic String getSymbol(Locale locale)
If the specified locale contains "rg" (region override) Unicode extensions, the symbol returned from this method reflects the value specified with that extension.
locale - the locale for which a display name for this currency is neededNullPointerException - if locale is nullpublic int getDefaultFractionDigits()
public int getNumericCode()
public String getNumericCodeAsString()
String. Unlike getNumericCode(), which returns the numeric code as int, this method always returns the numeric code as a 3 digit string. e.g. a numeric value of 32 would be returned as "032", and a numeric value of 6 would be returned as "006".String
public String getDisplayName()
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)).
DISPLAY localepublic String getDisplayName(Locale locale)
locale - the locale for which a display name for this currency is neededNullPointerException - if locale is nullpublic String toString()
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/Currency.html