/*
 * @(#)CurrencyNameProvider.java	1.3 10/03/23
 *
 * Copyright (c) 2006, Oracle and/or its affiliates. All rights reserved.
 * ORACLE PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
 */

package java.util.spi;

import java.util.Currency;
import java.util.Locale;

/**
 * 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.3 10/03/23
 */
public abstract class CurrencyNameProvider extends LocaleServiceProvider {

    /**
     * Sole constructor.  (For invocation by subclass constructors, typically
     * implicit.)
     */
    protected CurrencyNameProvider() {
    }

    /**
     * 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 <code>currencyCode</code> or 
     *     <code>locale</code> is null
     * @exception IllegalArgumentException if <code>currencyCode</code> is not in 
     *     the form of three upper-case letters, or <code>locale</code> isn't
     *     one of the locales returned from 
     *     {@link java.util.spi.LocaleServiceProvider#getAvailableLocales() 
     *     getAvailableLocales()}.
     * @see java.util.Currency#getSymbol(java.util.Locale)
     */
    public abstract String getSymbol(String currencyCode, Locale locale);
}
