FileDocCategorySizeDatePackage
CurrencyNameProvider.javaAPI DocJava SE 6 API2131Tue Jun 10 00:26:00 BST 2008java.util.spi

CurrencyNameProvider

public abstract class CurrencyNameProvider extends LocaleServiceProvider
An abstract class for service providers that provide localized currency symbols for the {@link java.util.Currency Currency} class. Note that currency symbols are considered names when determining behaviors described in the {@link java.util.spi.LocaleServiceProvider LocaleServiceProvider} specification.
since
1.6
version
@(#)CurrencyNameProvider.java 1.2 05/11/17

Fields Summary
Constructors Summary
protected CurrencyNameProvider()
Sole constructor. (For invocation by subclass constructors, typically implicit.)
Methods Summary
public abstract java.lang.StringgetSymbol(java.lang.String currencyCode, java.util.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.

param
currencyCode the ISO 4217 currency code, which consists of three upper-case letters between 'A' (U+0041) and 'Z' (U+005A)
param
locale the desired locale
return
the symbol of the given currency code for the specified locale, or null if the symbol is not available for the locale
exception
NullPointerException if currencyCode or locale is null
exception
IllegalArgumentException if currencyCode is not in the form of three upper-case letters, or locale isn't one of the locales returned from {@link java.util.spi.LocaleServiceProvider#getAvailableLocales() getAvailableLocales()}.
see
java.util.Currency#getSymbol(java.util.Locale)