java.util.Currency Maven / Gradle / Ivy
Show all versions of android-all Show documentation
/*
* Copyright (C) 2014 The Android Open Source Project
* Copyright (c) 2000, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
package java.util;
import java.io.Serializable;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.ConcurrentMap;
import libcore.icu.ICU;
// BEGIN Android-changed: Removed docs about superseding runtime currency data.
// Doing so via a properties file is not supported on Android.
/**
* 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.
*
* @since 1.4
*/
// END Android-changed: Removed docs about superseding runtime currency data.
public final class Currency implements Serializable {
private static final long serialVersionUID = -158308464356906721L;
/**
* ISO 4217 currency code for this currency.
*
* @serial
*/
private final String currencyCode;
// class data: instance map
private static ConcurrentMap instances = new ConcurrentHashMap<>(7);
private static HashSet available;
// Android-changed: Implement Currency on top of ICU throughout.
// We do not keep track of defaultFractionDigits and numericCode separately here.
private transient final android.icu.util.Currency icuCurrency;
/**
* Constructs a Currency instance. The constructor is private
* so that we can insure that there's never more than one instance for a
* given currency.
*/
private Currency(android.icu.util.Currency icuCurrency) {
this.icuCurrency = icuCurrency;
this.currencyCode = icuCurrency.getCurrencyCode();
}
/**
* Returns the Currency instance for the given currency code.
*
* @param currencyCode the ISO 4217 code of the currency
* @return the Currency instance for the given currency code
* @exception NullPointerException if currencyCode is null
* @exception IllegalArgumentException if currencyCode is not
* a supported ISO 4217 code.
*/
public static Currency getInstance(String currencyCode) {
// BEGIN Android-changed: use ICU
Currency instance = instances.get(currencyCode);
if (instance != null) {
return instance;
}
android.icu.util.Currency icuInstance =
android.icu.util.Currency.getInstance(currencyCode);
if (icuInstance == null) {
return null;
}
Currency currencyVal = new Currency(icuInstance);
// END Android-changed
instance = instances.putIfAbsent(currencyCode, currencyVal);
return (instance != null ? instance : currencyVal);
}
/**
* 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.
*
* @param locale the locale for whose country a Currency
* instance is needed
* @return the Currency instance for the country of the given
* locale, or {@code null}
* @exception NullPointerException if locale or its country
* code is {@code null}
* @exception IllegalArgumentException if the country of the given {@code locale}
* is not a supported ISO 3166 country code.
*/
public static Currency getInstance(Locale locale) {
// BEGIN Android-changed: use ICU
android.icu.util.Currency icuInstance =
android.icu.util.Currency.getInstance(locale);
String variant = locale.getVariant();
String country = locale.getCountry();
if (!variant.isEmpty() && (variant.equals("EURO") || variant.equals("HK") ||
variant.equals("PREEURO"))) {
country = country + "_" + variant;
}
String currencyCode = ICU.getCurrencyCode(country);
if (currencyCode == null) {
throw new IllegalArgumentException("Unsupported ISO 3166 country: " + locale);
}
if (icuInstance == null || icuInstance.getCurrencyCode().equals("XXX")) {
return null;
}
return getInstance(currencyCode);
// END Android-changed
}
/**
* 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.
*
* @return the set of available currencies. If there is no currency
* available in the runtime, the returned set is empty.
* @since 1.7
*/
public static Set getAvailableCurrencies() {
synchronized(Currency.class) {
if (available == null) {
// BEGIN Android-changed: use ICU
Set icuAvailableCurrencies
= android.icu.util.Currency.getAvailableCurrencies();
available = new HashSet<>();
for (android.icu.util.Currency icuCurrency : icuAvailableCurrencies) {
Currency currency = getInstance(icuCurrency.getCurrencyCode());
if (currency == null) {
currency = new Currency(icuCurrency);
instances.put(currency.currencyCode, currency);
}
available.add(currency);
}
// END Android-changed
}
}
@SuppressWarnings("unchecked")
Set result = (Set) available.clone();
return result;
}
/**
* Gets the ISO 4217 currency code of this currency.
*
* @return the ISO 4217 currency code of this currency.
*/
public String getCurrencyCode() {
return currencyCode;
}
/**
* Gets the symbol of this currency for the default
* {@link Locale.Category#DISPLAY 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
* {@link #getSymbol(Locale)
* getSymbol(Locale.getDefault(Locale.Category.DISPLAY))}.
*
* @return the symbol of this currency for the default
* {@link Locale.Category#DISPLAY DISPLAY} locale
*/
public String getSymbol() {
return getSymbol(Locale.getDefault(Locale.Category.DISPLAY));
}
/**
* 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.
*
* @param locale the locale for which a display name for this currency is
* needed
* @return the symbol of this currency for the specified locale
* @exception NullPointerException if locale is null
*/
public String getSymbol(Locale locale) {
// BEGIN Android-changed: use ICU
if (locale == null) {
throw new NullPointerException("locale == null");
}
return icuCurrency.getSymbol(locale);
// END Android-changed
}
/**
* 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.
*
* @return the default number of fraction digits used with this currency
*/
public int getDefaultFractionDigits() {
// BEGIN Android-changed: use ICU
if (icuCurrency.getCurrencyCode().equals("XXX")) {
return -1;
}
return icuCurrency.getDefaultFractionDigits();
// END Android-changed
}
/**
* Returns the ISO 4217 numeric code of this currency.
*
* @return the ISO 4217 numeric code of this currency
* @since 1.7
*/
public int getNumericCode() {
// Android-changed: use ICU
// was: return numericCode;
return icuCurrency.getNumericCode();
}
/**
* Gets the name that is suitable for displaying this currency for
* the default {@link Locale.Category#DISPLAY 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
* {@link #getDisplayName(Locale)
* getDisplayName(Locale.getDefault(Locale.Category.DISPLAY))}.
*
* @return the display name of this currency for the default
* {@link Locale.Category#DISPLAY DISPLAY} locale
* @since 1.7
*/
public String getDisplayName() {
return getDisplayName(Locale.getDefault(Locale.Category.DISPLAY));
}
/**
* 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.
*
* @param locale the locale for which a display name for this currency is
* needed
* @return the display name of this currency for the specified locale
* @exception NullPointerException if locale is null
* @since 1.7
*/
public String getDisplayName(Locale locale) {
// Android-changed: use ICU
return icuCurrency.getDisplayName(Objects.requireNonNull(locale));
}
/**
* Returns the ISO 4217 currency code of this currency.
*
* @return the ISO 4217 currency code of this currency
*/
@Override
public String toString() {
// Android-changed: use ICU
return icuCurrency.toString();
}
/**
* Resolves instances being deserialized to a single instance per currency.
*/
private Object readResolve() {
return getInstance(currencyCode);
}
}