| java.lang.Object
 java.util.Currency
| Currency | | final public class Currency implements Serializable(Code) | | Represents a currency. Currencies are identified by their ISO 4217 currency
codes. Visit the
BSi web site for more information, including a table of
currency codes.
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 creating a properties
file named <JAVA_HOME>/lib/currency.properties. The contents
of the properties file 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. For example,
#Sample currency properties
JP=JPZ,999,0
will supersede the currency data for Japan.
since:
1.4 |
| Method Summary | |
| public static Set<Currency> | getAvailableCurrencies()
Gets the set of available currencies. | | public String | getCurrencyCode()
Gets the ISO 4217 currency code of this currency. | | public int | getDefaultFractionDigits()
Gets 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 locale. | | public String | getDisplayName(Locale locale)
Gets the name that is suitable for displaying this currency for
the specified locale. | | public static Currency | getInstance(String currencyCode)
Returns the Currency instance for the given currency code. | | public static Currency | getInstance(Locale locale)
Returns the Currency instance for the country of the
given locale. | | public int | getNumericCode()
Returns the ISO 4217 numeric code of this currency. | | public String | getSymbol()
Gets the symbol of this currency for the default 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$". | | 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$". | | public String | toString()
Returns the ISO 4217 currency code of this currency. |
| dataVersion | | static int dataVersion(Code) | | |
| formatVersion | | static int formatVersion(Code) | | |
| mainTable | | static int[] mainTable(Code) | | |
| otherCurrenciesDFD | | static int[] otherCurrenciesDFD(Code) | | |
| otherCurrenciesNumericCode | | static int[] otherCurrenciesNumericCode(Code) | | |
| scCutOverTimes | | static long[] scCutOverTimes(Code) | | |
| scNewCurrenciesDFD | | static int[] scNewCurrenciesDFD(Code) | | |
| scNewCurrenciesNumericCode | | static int[] scNewCurrenciesNumericCode(Code) | | |
| scOldCurrenciesDFD | | static int[] scOldCurrenciesDFD(Code) | | |
| scOldCurrenciesNumericCode | | static int[] scOldCurrenciesNumericCode(Code) | | |
| getAvailableCurrencies | | public static Set<Currency> getAvailableCurrencies()(Code) | | 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.
the set of available currencies. If there is no currencyavailable in the runtime, the returned set is empty.
since:
1.7 |
| getCurrencyCode | | public String getCurrencyCode()(Code) | | Gets the ISO 4217 currency code of this currency.
the ISO 4217 currency code of this currency. |
| getDefaultFractionDigits | | public int getDefaultFractionDigits()(Code) | | 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.
the default number of fraction digits used with this currency |
| getDisplayName | | public String getDisplayName()(Code) | | Gets the name that is suitable for displaying this currency for
the default locale. If there is no suitable display name found
for the default locale, the ISO 4217 currency code is returned.
the display name of this currency for the default locale
since:
1.7 |
| getDisplayName | | public String getDisplayName(Locale locale)(Code) | | 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 isneeded the display name of this currency for the specified locale
exception:
NullPointerException - if locale is null
since:
1.7 |
| getInstance | | public static Currency getInstance(String currencyCode)(Code) | | Returns the Currency instance for the given currency code.
Parameters:
currencyCode - the ISO 4217 code of the currency the Currency instance for the given currency code
exception:
NullPointerException - if currencyCode is null
exception:
IllegalArgumentException - if currencyCode is nota supported ISO 4217 code. |
| getInstance | | public static Currency getInstance(Locale locale)(Code) | | 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 Currencyinstance is needed the Currency instance for the country of the givenlocale, or null
exception:
NullPointerException - if locale or its countrycode is null
exception:
IllegalArgumentException - if the country of the given localeis not a supported ISO 3166 country code. |
| getNumericCode | | public int getNumericCode()(Code) | | Returns the ISO 4217 numeric code of this currency.
the ISO 4217 numeric code of this currency
since:
1.7 |
| getSymbol | | public String getSymbol()(Code) | | Gets the symbol of this currency for the default 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.
the symbol of this currency for the default locale |
| getSymbol | | public String getSymbol(Locale locale)(Code) | | 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 isneeded the symbol of this currency for the specified locale
exception:
NullPointerException - if locale is null |
| toString | | public String toString()(Code) | | Returns the ISO 4217 currency code of this currency.
the ISO 4217 currency code of this currency |
|
|