- java.lang.Object
-
- java.util.spi.LocaleServiceProvider
-
- java.util.spi.CurrencyNameProvider
-
public abstract class CurrencyNameProvider extends LocaleServiceProvider
An abstract class for service providers that provide localized currency symbols and display names for theCurrency
class. Note that currency symbols are considered names when determining behaviors described in theLocaleServiceProvider
specification.- Since:
- 1.6
-
-
Constructor Summary
Constructors Modifier Constructor and Description protected
CurrencyNameProvider()
Sole constructor.
-
Method Summary
Methods Modifier and Type Method and Description String
getDisplayName(String currencyCode, Locale locale)
Returns a name for the currency that is appropriate for display to the user.abstract String
getSymbol(String currencyCode, Locale locale)
Gets the symbol of the given currency code for the specified locale.-
Methods inherited from class java.util.spi.LocaleServiceProvider
getAvailableLocales
-
-
-
-
Constructor Detail
-
CurrencyNameProvider
protected CurrencyNameProvider()
Sole constructor. (For invocation by subclass constructors, typically implicit.)
-
-
Method Detail
-
getSymbol
public abstract String getSymbol(String currencyCode, Locale locale)
Gets the symbol of the given currency code for the specified locale. For example, for "USD" (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, null should be returned.- Parameters:
currencyCode
- the ISO 4217 currency code, which consists of three upper-case letters between 'A' (U+0041) and 'Z' (U+005A)locale
- the desired locale- Returns:
- the symbol of the given currency code for the specified locale, or null if the symbol is not available for the locale
- Throws:
NullPointerException
- ifcurrencyCode
orlocale
is nullIllegalArgumentException
- ifcurrencyCode
is not in the form of three upper-case letters, orlocale
isn't one of the locales returned fromgetAvailableLocales()
.- See Also:
Currency.getSymbol(java.util.Locale)
-
getDisplayName
public String getDisplayName(String currencyCode, Locale locale)
Returns a name for the currency that is appropriate for display to the user. The default implementation returns null.- Parameters:
currencyCode
- the ISO 4217 currency code, which consists of three upper-case letters between 'A' (U+0041) and 'Z' (U+005A)locale
- the desired locale- Returns:
- the name for the currency that is appropriate for display to the user, or null if the name is not available for the locale
- Throws:
IllegalArgumentException
- ifcurrencyCode
is not in the form of three upper-case letters, orlocale
isn't one of the locales returned fromgetAvailableLocales()
.NullPointerException
- ifcurrencyCode
orlocale
isnull
- Since:
- 1.7
-
-
Document created the 11/06/2005, last modified the 04/03/2020
Source of the printed document:https://www.gaudry.be/en/java-api-rf-java/util/spi/CurrencyNameProvider.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.