1/*
2 *  Licensed to the Apache Software Foundation (ASF) under one or more
3 *  contributor license agreements.  See the NOTICE file distributed with
4 *  this work for additional information regarding copyright ownership.
5 *  The ASF licenses this file to You under the Apache License, Version 2.0
6 *  (the "License"); you may not use this file except in compliance with
7 *  the License.  You may obtain a copy of the License at
8 *
9 *     http://www.apache.org/licenses/LICENSE-2.0
10 *
11 *  Unless required by applicable law or agreed to in writing, software
12 *  distributed under the License is distributed on an "AS IS" BASIS,
13 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 *  See the License for the specific language governing permissions and
15 *  limitations under the License.
16 */
17
18package java.util.spi;
19
20import java.util.Locale;
21
22/**
23 * This abstract class should be extended by service providers that provide
24 * localized currency symbols (currency names) from currency codes.
25 * <p>Note that Android does not support user-supplied locale service providers.
26 * @since 1.6
27 * @hide
28 */
29public abstract class CurrencyNameProvider extends LocaleServiceProvider {
30    /**
31     * Default constructor, for use by subclasses.
32     */
33    protected CurrencyNameProvider() {
34        // do nothing
35    }
36
37    /**
38     * Returns the localized currency symbol for the given currency code.
39     *
40     * @param code an ISO 4217 currency code
41     * @param locale a locale
42     * @return the symbol or null if there is no available symbol in the locale
43     * @throws NullPointerException
44     *             if {@code code == null || locale == null}
45     * @throws IllegalArgumentException
46     *             if code or locale is not in a legal format or not available
47     */
48    public abstract String getSymbol(String code, Locale locale);
49}
50