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.Locale;
029
030 /**
031 * An abstract class for service providers that
032 * provide localized names for the
033 * {@link java.util.Locale Locale} class.
034 *
035 * @since 1.6
036 * @version @(#)LocaleNameProvider.java 1.8 07/05/05
037 */
038 public abstract class LocaleNameProvider extends LocaleServiceProvider {
039
040 /**
041 * Sole constructor. (For invocation by subclass constructors, typically
042 * implicit.)
043 */
044 protected LocaleNameProvider() {
045 }
046
047 /**
048 * Returns a localized name for the given ISO 639 language code and the
049 * given locale that is appropriate for display to the user.
050 * For example, if <code>languageCode</code> is "fr" and <code>locale</code>
051 * is en_US, getDisplayLanguage() will return "French"; if <code>languageCode</code>
052 * is "en" and <code>locale</code> is fr_FR, getDisplayLanguage() will return "anglais".
053 * If the name returned cannot be localized according to <code>locale</code>,
054 * (say, the provider does not have a Japanese name for Croatian),
055 * this method returns null.
056 * @param languageCode the ISO 639 language code string in the form of two
057 * lower-case letters between 'a' (U+0061) and 'z' (U+007A)
058 * @param locale the desired locale
059 * @return the name of the given language code for the specified locale, or null if it's not
060 * available.
061 * @exception NullPointerException if <code>languageCode</code> or <code>locale</code> is null
062 * @exception IllegalArgumentException if <code>languageCode</code> is not in the form of
063 * two lower-case letters, or <code>locale</code> isn't
064 * one of the locales returned from
065 * {@link java.util.spi.LocaleServiceProvider#getAvailableLocales()
066 * getAvailableLocales()}.
067 * @see java.util.Locale#getDisplayLanguage(java.util.Locale)
068 */
069 public abstract String getDisplayLanguage(String languageCode,
070 Locale locale);
071
072 /**
073 * Returns a localized name for the given ISO 3166 country code and the
074 * given locale that is appropriate for display to the user.
075 * For example, if <code>countryCode</code> is "FR" and <code>locale</code>
076 * is en_US, getDisplayCountry() will return "France"; if <code>countryCode</code>
077 * is "US" and <code>locale</code> is fr_FR, getDisplayCountry() will return "Etats-Unis".
078 * If the name returned cannot be localized according to <code>locale</code>,
079 * (say, the provider does not have a Japanese name for Croatia),
080 * this method returns null.
081 * @param countryCode the ISO 3166 country code string in the form of two
082 * upper-case letters between 'A' (U+0041) and 'Z' (U+005A)
083 * @param locale the desired locale
084 * @return the name of the given country code for the specified locale, or null if it's not
085 * available.
086 * @exception NullPointerException if <code>countryCode</code> or <code>locale</code> is null
087 * @exception IllegalArgumentException if <code>countryCode</code> is not in the form of
088 * two upper-case letters, or <code>locale</code> isn't
089 * one of the locales returned from
090 * {@link java.util.spi.LocaleServiceProvider#getAvailableLocales()
091 * getAvailableLocales()}.
092 * @see java.util.Locale#getDisplayCountry(java.util.Locale)
093 */
094 public abstract String getDisplayCountry(String countryCode,
095 Locale locale);
096
097 /**
098 * Returns a localized name for the given variant code and the given locale that
099 * is appropriate for display to the user.
100 * If the name returned cannot be localized according to <code>locale</code>,
101 * this method returns null.
102 * @param variant the variant string
103 * @param locale the desired locale
104 * @return the name of the given variant string for the specified locale, or null if it's not
105 * available.
106 * @exception NullPointerException if <code>variant</code> or <code>locale</code> is null
107 * @exception IllegalArgumentException if <code>locale</code> isn't
108 * one of the locales returned from
109 * {@link java.util.spi.LocaleServiceProvider#getAvailableLocales()
110 * getAvailableLocales()}.
111 * @see java.util.Locale#getDisplayVariant(java.util.Locale)
112 */
113 public abstract String getDisplayVariant(String variant,
114 Locale locale);
115 }
|