0N/A/*
0N/A * Copyright (c) 2005, 2011, Oracle and/or its affiliates. All rights reserved.
0N/A * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
0N/A *
0N/A * This code is free software; you can redistribute it and/or modify it
0N/A * under the terms of the GNU General Public License version 2 only, as
0N/A * published by the Free Software Foundation. Oracle designates this
0N/A * particular file as subject to the "Classpath" exception as provided
0N/A * by Oracle in the LICENSE file that accompanied this code.
0N/A *
0N/A * This code is distributed in the hope that it will be useful, but WITHOUT
0N/A * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
0N/A * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
0N/A * version 2 for more details (a copy is included in the LICENSE file that
0N/A * accompanied this code).
0N/A *
0N/A * You should have received a copy of the GNU General Public License version
0N/A * 2 along with this work; if not, write to the Free Software Foundation,
0N/A * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
0N/A *
0N/A * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
0N/A * or visit www.oracle.com if you need additional information or have any
0N/A * questions.
0N/A */
0N/A
0N/Apackage java.util.spi;
0N/A
0N/Aimport java.util.Locale;
0N/A
0N/A/**
0N/A * An abstract class for service providers that
1246N/A * provide localized names for the
1246N/A * {@link java.util.Locale Locale} class.
1246N/A *
0N/A * @since 1.6
0N/A */
0N/Apublic abstract class LocaleNameProvider extends LocaleServiceProvider {
0N/A
0N/A /**
0N/A * Sole constructor. (For invocation by subclass constructors, typically
0N/A * implicit.)
0N/A */
0N/A protected LocaleNameProvider() {
0N/A }
0N/A
0N/A /**
0N/A * Returns a localized name for the given <a href="http://www.rfc-editor.org/rfc/bcp/bcp47.txt">
0N/A * IETF BCP47</a> language code and the given locale that is appropriate for
0N/A * display to the user.
0N/A * For example, if <code>languageCode</code> is "fr" and <code>locale</code>
0N/A * is en_US, getDisplayLanguage() will return "French"; if <code>languageCode</code>
0N/A * is "en" and <code>locale</code> is fr_FR, getDisplayLanguage() will return "anglais".
0N/A * If the name returned cannot be localized according to <code>locale</code>,
0N/A * (say, the provider does not have a Japanese name for Croatian),
0N/A * this method returns null.
0N/A * @param languageCode the language code string in the form of two to eight
0N/A * lower-case letters between 'a' (U+0061) and 'z' (U+007A)
0N/A * @param locale the desired locale
0N/A * @return the name of the given language code for the specified locale, or null if it's not
0N/A * available.
0N/A * @exception NullPointerException if <code>languageCode</code> or <code>locale</code> is null
0N/A * @exception IllegalArgumentException if <code>languageCode</code> is not in the form of
0N/A * two or three lower-case letters, or <code>locale</code> isn't
0N/A * one of the locales returned from
0N/A * {@link java.util.spi.LocaleServiceProvider#getAvailableLocales()
0N/A * getAvailableLocales()}.
0N/A * @see java.util.Locale#getDisplayLanguage(java.util.Locale)
0N/A */
0N/A public abstract String getDisplayLanguage(String languageCode, Locale locale);
0N/A
0N/A /**
0N/A * Returns a localized name for the given <a href="http://www.rfc-editor.org/rfc/bcp/bcp47.txt">
0N/A * IETF BCP47</a> script code and the given locale that is appropriate for
0N/A * display to the user.
0N/A * For example, if <code>scriptCode</code> is "Latn" and <code>locale</code>
0N/A * is en_US, getDisplayScript() will return "Latin"; if <code>scriptCode</code>
0N/A * is "Cyrl" and <code>locale</code> is fr_FR, getDisplayScript() will return "cyrillique".
0N/A * If the name returned cannot be localized according to <code>locale</code>,
0N/A * (say, the provider does not have a Japanese name for Cyrillic),
0N/A * this method returns null. The default implementation returns null.
0N/A * @param scriptCode the four letter script code string in the form of title-case
0N/A * letters (the first letter is upper-case character between 'A' (U+0041) and
0N/A * 'Z' (U+005A) followed by three lower-case character between 'a' (U+0061)
0N/A * and 'z' (U+007A)).
0N/A * @param locale the desired locale
0N/A * @return the name of the given script code for the specified locale, or null if it's not
0N/A * available.
0N/A * @exception NullPointerException if <code>scriptCode</code> or <code>locale</code> is null
0N/A * @exception IllegalArgumentException if <code>scriptCode</code> is not in the form of
0N/A * four title case letters, or <code>locale</code> isn't
0N/A * one of the locales returned from
0N/A * {@link java.util.spi.LocaleServiceProvider#getAvailableLocales()
0N/A * getAvailableLocales()}.
0N/A * @see java.util.Locale#getDisplayScript(java.util.Locale)
0N/A * @since 1.7
0N/A */
0N/A public String getDisplayScript(String scriptCode, Locale locale) {
0N/A return null;
0N/A }
0N/A
0N/A /**
0N/A * Returns a localized name for the given <a href="http://www.rfc-editor.org/rfc/bcp/bcp47.txt">
0N/A * IETF BCP47</a> region code (either ISO 3166 country code or UN M.49 area
0N/A * codes) and the given locale that is appropriate for display to the user.
0N/A * For example, if <code>countryCode</code> is "FR" and <code>locale</code>
0N/A * is en_US, getDisplayCountry() will return "France"; if <code>countryCode</code>
0N/A * is "US" and <code>locale</code> is fr_FR, getDisplayCountry() will return "Etats-Unis".
0N/A * If the name returned cannot be localized according to <code>locale</code>,
0N/A * (say, the provider does not have a Japanese name for Croatia),
0N/A * this method returns null.
0N/A * @param countryCode the country(region) code string in the form of two
0N/A * upper-case letters between 'A' (U+0041) and 'Z' (U+005A) or the UN M.49 area code
0N/A * in the form of three digit letters between '0' (U+0030) and '9' (U+0039).
0N/A * @param locale the desired locale
0N/A * @return the name of the given country code for the specified locale, or null if it's not
0N/A * available.
0N/A * @exception NullPointerException if <code>countryCode</code> or <code>locale</code> is null
0N/A * @exception IllegalArgumentException if <code>countryCode</code> is not in the form of
0N/A * two upper-case letters or three digit letters, or <code>locale</code> isn't
0N/A * one of the locales returned from
0N/A * {@link java.util.spi.LocaleServiceProvider#getAvailableLocales()
0N/A * getAvailableLocales()}.
0N/A * @see java.util.Locale#getDisplayCountry(java.util.Locale)
0N/A */
0N/A public abstract String getDisplayCountry(String countryCode, Locale locale);
0N/A
0N/A /**
0N/A * Returns a localized name for the given variant code and the given locale that
0N/A * is appropriate for display to the user.
0N/A * If the name returned cannot be localized according to <code>locale</code>,
0N/A * this method returns null.
0N/A * @param variant the variant string
0N/A * @param locale the desired locale
0N/A * @return the name of the given variant string for the specified locale, or null if it's not
0N/A * available.
0N/A * @exception NullPointerException if <code>variant</code> or <code>locale</code> is null
0N/A * @exception IllegalArgumentException if <code>locale</code> isn't
0N/A * one of the locales returned from
0N/A * {@link java.util.spi.LocaleServiceProvider#getAvailableLocales()
0N/A * getAvailableLocales()}.
0N/A * @see java.util.Locale#getDisplayVariant(java.util.Locale)
0N/A */
0N/A public abstract String getDisplayVariant(String variant, Locale locale);
0N/A}
0N/A