Top Description Constructors Methods
java.util.spi

public abstract Class CurrencyNameProvider

extends LocaleServiceProvider
Class Inheritance
Known Direct Subclasses
sun.util.locale.provider.CurrencyNameProviderImpl, sun.util.locale.provider.SPILocaleProviderAdapter.CurrencyNameProviderDelegate
Imports
java.util.Arrays, .Currency, .List, .Locale, .ResourceBundle.Control
An abstract class for service providers that provide localized currency symbols and display names for the Currency class. Note that currency symbols are considered names when determining behaviors described in the LocaleServiceProvider specification.
Since
1.6

Constructor Summary

AccessConstructor and Description
protected
CurrencyNameProvider()

Sole constructor.

Method Summary

Modifier and TypeMethod and Description
public String

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
getDisplayName(String
the ISO 4217 currency code, which consists of three upper-case letters between 'A' (U+0041) and 'Z' (U+005A)
currencyCode, Locale
the desired locale
locale)

Returns a name for the currency that is appropriate for display to the user.

public abstract String

Returns:

the symbol of the given currency code for the specified locale, or null if the symbol is not available for the locale
getSymbol(String
the ISO 4217 currency code, which consists of three upper-case letters between 'A' (U+0041) and 'Z' (U+005A)
currencyCode, Locale
the desired locale
locale)

Gets the symbol of the given currency code for the specified locale.

Inherited from java.util.spi.LocaleServiceProvider:
getAvailableLocalesisSupportedLocale

Constructor Detail

CurrencyNameProviderback to summary
protected CurrencyNameProvider()

Sole constructor. (For invocation by subclass constructors, typically implicit.)

Method Detail

getDisplayNameback to summary
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:String

the ISO 4217 currency code, which consists of three upper-case letters between 'A' (U+0041) and 'Z' (U+005A)

locale:Locale

the desired locale

Returns:String

the name for the currency that is appropriate for display to the user, or null if the name is not available for the locale

Exceptions
IllegalArgumentException:
if currencyCode is not in the form of three upper-case letters, or locale isn't one of the locales returned from getAvailableLocales().
NullPointerException:
if currencyCode or locale is null
Since
1.7
getSymbolback to summary
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:String

the ISO 4217 currency code, which consists of three upper-case letters between 'A' (U+0041) and 'Z' (U+005A)

locale:Locale

the desired locale

Returns:String

the symbol of the given currency code for the specified locale, or null if the symbol is not available for the locale

Exceptions
NullPointerException:
if currencyCode or locale is null
IllegalArgumentException:
if currencyCode is not in the form of three upper-case letters, or locale isn't one of the locales returned from getAvailableLocales().
See Also
java.util.Currency#getSymbol(java.util.Locale)