GrepCode: java.util.spi.LocaleNameProvider (.java) - Class

JDK
/
jdk / openjdk
/
6-b14

7-b147
6-b14
/
java.util.spi.LocaleNameProvider
Find Usages
Diff
Raw
Download
HTML Widget
Stack Overflow Questions
1
  /*
2
   * Copyright 2005 Sun Microsystems, Inc.  All Rights Reserved.
3
   * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4
   *
5
   * This code is free software; you can redistribute it and/or modify it
6
   * under the terms of the GNU General Public License version 2 only, as
7
   * published by the Free Software Foundation.  Sun designates this
8
   * particular file as subject to the "Classpath" exception as provided
9
   * by Sun in the LICENSE file that accompanied this code.
10
  *
11
  * This code is distributed in the hope that it will be useful, but WITHOUT
12
  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13
  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14
  * version 2 for more details (a copy is included in the LICENSE file that
15
  * accompanied this code).
16
  *
17
  * You should have received a copy of the GNU General Public License version
18
  * 2 along with this work; if not, write to the Free Software Foundation,
19
  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20
  *
21
  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
22
  * CA 95054 USA or visit www.sun.com if you need additional information or
23
  * have any questions.
24
  */
25
 
26
 package java.util.spi;
27
 
28
 import java.util.Locale;

 An abstract class for service providers that
 provide localized names for the
 Locale class.

 
 Since:1.6
36
 
37
 public abstract class LocaleNameProvider extends LocaleServiceProvider {

    
 Sole constructor.  (For invocation by subclass constructors, typically
 implicit.)
 
42
 
43
     protected LocaleNameProvider() {
44
     }

    
 Returns a localized name for the given ISO 639 language code and the
 given locale that is appropriate for display to the user.
 For example, if languageCode is "fr" and locale
 is en_US, getDisplayLanguage() will return "French"; if languageCode
 is "en" and locale is fr_FR, getDisplayLanguage() will return "anglais".
 If the name returned cannot be localized according to locale,
 (say, the provider does not have a Japanese name for Croatian),
 this method returns null.
 
 Parameters:languageCode the ISO 639 language code string in the form of two
     lower-case letters between 'a' (U+0061) and 'z' (U+007A)locale the desired locale Returns:the name of the given language code for the specified locale, or null if it's not
     available. Throws:java.lang.NullPointerException if languageCode or locale is nulljava.lang.IllegalArgumentException if languageCode is not in the form of
     two lower-case letters, or locale isn't
     one of the locales returned from
          getAvailableLocales(). See also:java.util.Locale.getDisplayLanguage(java.util.Locale)
67
 
68
     public abstract String getDisplayLanguage(String languageCode, Locale locale);

    
 Returns a localized name for the given ISO 3166 country code and the
 given locale that is appropriate for display to the user.
 For example, if countryCode is "FR" and locale
 is en_US, getDisplayCountry() will return "France"; if countryCode
 is "US" and locale is fr_FR, getDisplayCountry() will return "Etats-Unis".
 If the name returned cannot be localized according to locale,
 (say, the provider does not have a Japanese name for Croatia),
 this method returns null.
 
 Parameters:countryCode the ISO 3166 country code string in the form of two
     upper-case letters between 'A' (U+0041) and 'Z' (U+005A)locale the desired locale Returns:the name of the given country code for the specified locale, or null if it's not
     available. Throws:java.lang.NullPointerException if countryCode or locale is nulljava.lang.IllegalArgumentException if countryCode is not in the form of
     two upper-case letters, or locale isn't
     one of the locales returned from
          getAvailableLocales(). See also:java.util.Locale.getDisplayCountry(java.util.Locale)
91
 
92
     public abstract String getDisplayCountry(String countryCode, Locale locale);

    
 Returns a localized name for the given variant code and the given locale that
 is appropriate for display to the user.
 If the name returned cannot be localized according to locale,
 this method returns null.
 
 Parameters:variant the variant stringlocale the desired locale Returns:the name of the given variant string for the specified locale, or null if it's not
     available. Throws:java.lang.NullPointerException if variant or locale is nulljava.lang.IllegalArgumentException if locale isn't
     one of the locales returned from
          getAvailableLocales(). See also:java.util.Locale.getDisplayVariant(java.util.Locale)
109
110
    public abstract String getDisplayVariant(String variant, Locale locale);
111
}