public final class

Currency

extends Object
implements Serializable
java.lang.Object
   ↳ java.util.Currency

Class Overview

This class represents a currency as identified in the ISO 4217 currency codes.

Summary

Public Methods
String getCurrencyCode()
Returns this currency's ISO 4217 currency code.
int getDefaultFractionDigits()
Returns the default number of fraction digits for this currency.
static Currency getInstance(Locale locale)
Returns the Currency instance for this Locale's country.
static Currency getInstance(String currencyCode)
Returns the Currency instance for the given currency code.
String getSymbol(Locale locale)
Returns the localized currency symbol for this currency in locale.
String getSymbol()
Returns the localized currency symbol for this currency in the user's default locale.
String toString()
Returns this currency's ISO 4217 currency code.
[Expand]
Inherited Methods
From class java.lang.Object

Public Methods

public String getCurrencyCode ()

Since: API Level 1

Returns this currency's ISO 4217 currency code.

public int getDefaultFractionDigits ()

Since: API Level 1

Returns the default number of fraction digits for this currency. For instance, the default number of fraction digits for the US dollar is 2. For the Japanese Yen the number is 0. In the case of pseudo-currencies, such as IMF Special Drawing Rights, -1 is returned.

Returns
  • the default number of fraction digits for this currency.

public static Currency getInstance (Locale locale)

Since: API Level 1

Returns the Currency instance for this Locale's country.

Parameters
locale the Locale of a country.
Returns
  • the Currency used in the country defined by the locale parameter.
Throws
IllegalArgumentException if the locale's country is not a supported ISO 3166 Country.

public static Currency getInstance (String currencyCode)

Since: API Level 1

Returns the Currency instance for the given currency code.

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

public String getSymbol (Locale locale)

Since: API Level 1

Returns the localized currency symbol for this currency in locale. That is, given "USD" and Locale.US, you'd get "$", but given "USD" and a non-US locale, you'd get "US$".

If the locale only specifies a language rather than a language and a country (such as Locale.JAPANESE or {new Locale("en", "")} rather than Locale.JAPAN or {new Locale("en", "US")}), the ISO 4217 currency code is returned.

If there is no locale-specific currency symbol, the ISO 4217 currency code is returned.

public String getSymbol ()

Since: API Level 1

Returns the localized currency symbol for this currency in the user's default locale. See "Be wary of the default locale".

public String toString ()

Since: API Level 1

Returns this currency's ISO 4217 currency code.

Returns
  • this currency's ISO 4217 currency code.