001    /* LocaleNameProvider.java -- Providers of localized locale names
002       Copyright (C) 2007 Free Software Foundation, Inc.
003    
004    This file is part of GNU Classpath.
005    
006    GNU Classpath is free software; you can redistribute it and/or modify
007    it under the terms of the GNU General Public License as published by
008    the Free Software Foundation; either version 2, or (at your option)
009    any later version.
010    
011    GNU Classpath is distributed in the hope that it will be useful, but
012    WITHOUT ANY WARRANTY; without even the implied warranty of
013    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014    General Public License for more details.
015    
016    You should have received a copy of the GNU General Public License
017    along with GNU Classpath; see the file COPYING.  If not, write to the
018    Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
019    02110-1301 USA.
020    
021    Linking this library statically or dynamically with other modules is
022    making a combined work based on this library.  Thus, the terms and
023    conditions of the GNU General Public License cover the whole
024    combination.
025    
026    As a special exception, the copyright holders of this library give you
027    permission to link this library with independent modules to produce an
028    executable, regardless of the license terms of these independent
029    modules, and to copy and distribute the resulting executable under
030    terms of your choice, provided that you also meet, for each linked
031    independent module, the terms and conditions of the license of that
032    module.  An independent module is a module which is not derived from
033    or based on this library.  If you modify this library, you may extend
034    this exception to your version of the library, but you are not
035    obligated to do so.  If you do not wish to do so, delete this
036    exception statement from your version. */
037    
038    package java.util.spi;
039    
040    import java.util.Locale;
041    
042    /**
043     * A {@link LocaleNameProvider} provides localized
044     * versions of the names that represent a particular
045     * locale.  Note that a <code>null</code> value may
046     * be returned, which should be treated as a lack of
047     * support for the specified {@link Locale}.
048     *
049     * @author Andrew John Hughes (gnu_andrew@member.fsf.org)
050     * @since 1.6
051     */
052    public abstract class LocaleNameProvider
053      extends LocaleServiceProvider
054    {
055    
056      /**
057       * Constructs a new {@link LocaleNameProvider}.
058       * Provided for implicit invocation by subclasses.
059       */
060      protected LocaleNameProvider()
061      {
062      }
063    
064      /**
065       * Returns the localized name for the specified ISO 3166
066       * country in the supplied {@link java.util.Locale}.
067       * For example, if the country code is <code>"DE"</code>,
068       * this method will return <code>"Germany"</code> for
069       * {@link Locale.ENGLISH} but <code>"Deutschland"</code>
070       * for {@link Locale.GERMANY}.  If the name of the country
071       * in the given locale is not supported, <code>null</code>
072       * is returned.
073       *
074       * @param countryCode the ISO 3166 country code, consisting
075       *                    of two uppercase letters from 'A' to 'Z'
076       * @param locale the locale to express the country in.
077       * @return the country name, or <code>null</code> if one is
078       *         not available.
079       * @throws NullPointerException if the locale is null.
080       * @throws IllegalArgumentException if the country code is
081       *                                  not in the correct format
082       *                                  or the locale is not one
083       *                                  returned by
084       *                                  {@link getAvailableLocales()}
085       * @see java.util.Locale#getDisplayCountry(java.util.Locale)
086       */
087      public abstract String getDisplayCountry(String countryCode,
088                                               Locale locale);
089    
090      /**
091       * Returns the localized name for the specified ISO 639
092       * language in the supplied {@link java.util.Locale}.
093       * For example, if the language code is <code>"de"</code>,
094       * this method will return <code>"German"</code> for
095       * {@link Locale.ENGLISH} but <code>"Deutsch"</code>
096       * for {@link Locale.GERMANY}.  If the name of the language
097       * in the given locale is not supported, <code>null</code>
098       * is returned.
099       *
100       * @param langCode the ISO 639 language code, consisting
101       *                 of two lowercase letters from 'a' to 'z'
102       * @param locale the locale to express the language in.
103       * @return the country name, or <code>null</code> if one is
104       *         not available.
105       * @throws NullPointerException if the locale is null.
106       * @throws IllegalArgumentException if the language code is
107       *                                  not in the correct format
108       *                                  or the locale is not one
109       *                                  returned by
110       *                                  {@link getAvailableLocales()}
111       * @see java.util.Locale#getDisplayLanguage(java.util.Locale)
112       */
113      public abstract String getDisplayLanguage(String langCode,
114                                                Locale locale);
115    
116      /**
117       * Returns the localized name for the specified variant
118       * in the supplied {@link java.util.Locale}.  If the name
119       * of the variant in the given locale is not supported,
120       * <code>null</code> is returned.
121       *
122       * @param variant the variant.
123       * @param locale the locale to express the variant in.
124       * @return the localized variant, or <code>null</code> if one is
125       *         not available.
126       * @throws NullPointerException if the locale is null.
127       * @throws IllegalArgumentException if the locale is not one
128       *                                  returned by
129       *                                  {@link getAvailableLocales()}
130       * @see java.util.Locale#getDisplayVariant(java.util.Locale)
131       */
132      public abstract String getDisplayVariant(String variant,
133                                               Locale locale);
134    
135    }