001 /*
002 * Copyright 2005 Sun Microsystems, Inc. All Rights Reserved.
003 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004 *
005 * This code is free software; you can redistribute it and/or modify it
006 * under the terms of the GNU General Public License version 2 only, as
007 * published by the Free Software Foundation. Sun designates this
008 * particular file as subject to the "Classpath" exception as provided
009 * by Sun in the LICENSE file that accompanied this code.
010 *
011 * This code is distributed in the hope that it will be useful, but WITHOUT
012 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
013 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
014 * version 2 for more details (a copy is included in the LICENSE file that
015 * accompanied this code).
016 *
017 * You should have received a copy of the GNU General Public License version
018 * 2 along with this work; if not, write to the Free Software Foundation,
019 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
020 *
021 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
022 * CA 95054 USA or visit www.sun.com if you need additional information or
023 * have any questions.
024 */
025
026 package java.util.spi;
027
028 import java.util.Currency;
029 import java.util.Locale;
030
031 /**
032 * An abstract class for service providers that
033 * provide localized currency symbols and display names for the
034 * {@link java.util.Currency Currency} class.
035 * Note that currency symbols are considered names when determining
036 * behaviors described in the
037 * {@link java.util.spi.LocaleServiceProvider LocaleServiceProvider}
038 * specification.
039 *
040 * @since 1.6
041 * @version @(#)CurrencyNameProvider.java 1.9 07/05/31
042 */
043 public abstract class CurrencyNameProvider extends
044 LocaleServiceProvider {
045
046 /**
047 * Sole constructor. (For invocation by subclass constructors, typically
048 * implicit.)
049 */
050 protected CurrencyNameProvider() {
051 }
052
053 /**
054 * Gets the symbol of the given currency code for the specified locale.
055 * For example, for "USD" (US Dollar), the symbol is "$" if the specified
056 * locale is the US, while for other locales it may be "US$". If no
057 * symbol can be determined, null should be returned.
058 *
059 * @param currencyCode the ISO 4217 currency code, which
060 * consists of three upper-case letters between 'A' (U+0041) and
061 * 'Z' (U+005A)
062 * @param locale the desired locale
063 * @return the symbol of the given currency code for the specified locale, or null if
064 * the symbol is not available for the locale
065 * @exception NullPointerException if <code>currencyCode</code> or
066 * <code>locale</code> is null
067 * @exception IllegalArgumentException if <code>currencyCode</code> is not in
068 * the form of three upper-case letters, or <code>locale</code> isn't
069 * one of the locales returned from
070 * {@link java.util.spi.LocaleServiceProvider#getAvailableLocales()
071 * getAvailableLocales()}.
072 * @see java.util.Currency#getSymbol(java.util.Locale)
073 */
074 public abstract String getSymbol(String currencyCode, Locale locale);
075
076 /**
077 * Returns a name for the currency that is appropriate for display to the
078 * user. The default implementation returns null.
079 *
080 * @param currencyCode the ISO 4217 currency code, which
081 * consists of three upper-case letters between 'A' (U+0041) and
082 * 'Z' (U+005A)
083 * @param locale the desired locale
084 * @return the name for the currency that is appropriate for display to the
085 * user, or null if the name is not available for the locale
086 * @exception IllegalArgumentException if <code>currencyCode</code> is not in
087 * the form of three upper-case letters, or <code>locale</code> isn't
088 * one of the locales returned from
089 * {@link java.util.spi.LocaleServiceProvider#getAvailableLocales()
090 * getAvailableLocales()}.
091 * @exception NullPointerException if <code>currencyCode</code> or
092 * <code>locale</code> is <code>null</code>
093 * @since 1.7
094 */
095 public String getDisplayName(String currencyCode, Locale locale) {
096 if (currencyCode == null || locale == null) {
097 throw new NullPointerException();
098 }
099
100 return null;
101 }
102 }
|