Currency

getAvailableCurrencies

static fun getAvailableCurrencies(): MutableSet<Currency!>!

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.

getCurrencyCode

fun getCurrencyCode(): String!

Gets the ISO 4217 currency code of this currency.

getDefaultFractionDigits

fun getDefaultFractionDigits(): Int

Gets the default number of fraction digits used with this currency. Note that the number of fraction digits is the same as ISO 4217's minor unit for the 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.

getDisplayName

fun getDisplayName(): String!

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)).

getDisplayName

fun getDisplayName(locale: Locale!): String!

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.

getInstance

static fun getInstance(currencyCode: String!): Currency!

Returns the Currency instance for the given currency code.

getInstance

static fun getInstance(locale: Locale!): Currency!

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.

If the specified locale contains "cu" Unicode extensions, the instance returned from this method reflects the values specified with those extensions.

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

getNumericCode

fun getNumericCode(): Int

Returns the ISO 4217 numeric code of this currency.

getNumericCodeAsString

fun getNumericCodeAsString(): String!

Returns the 3 digit ISO 4217 numeric code of this currency as a 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".

getSymbol

fun getSymbol(): String!

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)).

getSymbol

fun getSymbol(locale: Locale!): String!

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.

toString

fun toString(): String

Returns the ISO 4217 currency code of this currency.