Android
java.util
public final class

java.util.Locale

java.lang.Object
java.util.Locale Serializable Cloneable

Locale represents a language/country/variant combination. It is an identifier which dictates particular conventions for the presentation of information. The language codes are two letter lowercase codes as defined by ISO-639. The country codes are three letter uppercase codes as defined by ISO-3166. The variant codes are unspecified.

See Also

Summary

Constants

      Value  
Locale  CANADA  Locale constant for en_CA.     
Locale  CANADA_FRENCH  Locale constant for fr_CA.     
Locale  CHINA  Locale constant for zh_CN.     
Locale  CHINESE  Locale constant for zh.     
Locale  ENGLISH  Locale constant for en.     
Locale  FRANCE  Locale constant for fr_FR.     
Locale  FRENCH  Locale constant for fr.     
Locale  GERMAN  Locale constant for de.     
Locale  GERMANY  Locale constant for de_DE.     
Locale  ITALIAN  Locale constant for it.     
Locale  ITALY  Locale constant for it_IT.     
Locale  JAPAN  Locale constant for ja_JP.     
Locale  JAPANESE  Locale constant for ja.     
Locale  KOREA  Locale constant for ko_KR.     
Locale  KOREAN  Locale constant for ko.     
Locale  PRC  Locale constant for zh_CN.     
Locale  SIMPLIFIED_CHINESE  Locale constant for zh_CN.     
Locale  TAIWAN  Locale constant for zh_TW.     
Locale  TRADITIONAL_CHINESE  Locale constant for zh_TW.     
Locale  UK  Locale constant for en_GB.     
Locale  US  Locale constant for en_US.     

Public Constructors

            Locale(String language)
Constructs a new Locale using the specified language.
            Locale(String language, String country)
Constructs a new Locale using the specified language and country codes.
            Locale(String language, String country, String variant)
Constructs a new Locale using the specified language, country, and variant codes.

Public Methods

          Object  clone()
Returns a new Locale with the same language, country and variant codes as this Locale.
          boolean  equals(Object object)
Compares the specified object to this Locale and answer if they are equal.
      static    Locale[]  getAvailableLocales()
Gets the list of installed Locales.
          String  getCountry()
Gets the country code for this Locale.
      static    Locale  getDefault()
Gets the default Locale.
          String  getDisplayCountry(Locale locale)
Gets the full country name in the specified Locale for the country code of this Locale.
    final      String  getDisplayCountry()
Gets the full country name in the default Locale for the country code of this Locale.
    final      String  getDisplayLanguage()
Gets the full language name in the default Locale for the language code of this Locale.
          String  getDisplayLanguage(Locale locale)
Gets the full language name in the specified Locale for the language code of this Locale.
    final      String  getDisplayName()
Gets the full language, country, and variant names in the default Locale for the codes of this Locale.
          String  getDisplayName(Locale locale)
Gets the full language, country, and variant names in the specified Locale for the codes of this Locale.
          String  getDisplayVariant(Locale locale)
Gets the full variant name in the specified Locale for the variant code of this Locale.
    final      String  getDisplayVariant()
Gets the full variant name in the default Locale for the variant code of this Locale.
          String  getISO3Country()
Gets the three letter ISO country code which corresponds to the country code for this Locale.
          String  getISO3Language()
Gets the three letter ISO language code which corresponds to the language code for this Locale.
      static    String[]  getISOCountries()
Gets the list of two letter ISO country codes which can be used as the country code for a Locale.
      static    String[]  getISOLanguages()
Gets the list of two letter ISO language codes which can be used as the language code for a Locale.
          String  getLanguage()
Gets the language code for this Locale.
          String  getVariant()
Gets the variant code for this Locale.
  synchronized        int  hashCode()
Returns an integer hash code for the receiver.
  synchronized    static    void  setDefault(Locale locale)
Sets the default Locale to the specified Locale.
    final      String  toString()
Returns the string representation of this Locale.
Methods inherited from class java.lang.Object

Details

Constants

public static final Locale CANADA

Locale constant for en_CA.

public static final Locale CANADA_FRENCH

Locale constant for fr_CA.

public static final Locale CHINA

Locale constant for zh_CN.

public static final Locale CHINESE

Locale constant for zh.

public static final Locale ENGLISH

Locale constant for en.

public static final Locale FRANCE

Locale constant for fr_FR.

public static final Locale FRENCH

Locale constant for fr.

public static final Locale GERMAN

Locale constant for de.

public static final Locale GERMANY

Locale constant for de_DE.

public static final Locale ITALIAN

Locale constant for it.

public static final Locale ITALY

Locale constant for it_IT.

public static final Locale JAPAN

Locale constant for ja_JP.

public static final Locale JAPANESE

Locale constant for ja.

public static final Locale KOREA

Locale constant for ko_KR.

public static final Locale KOREAN

Locale constant for ko.

public static final Locale PRC

Locale constant for zh_CN.

public static final Locale SIMPLIFIED_CHINESE

Locale constant for zh_CN.

public static final Locale TAIWAN

Locale constant for zh_TW.

public static final Locale TRADITIONAL_CHINESE

Locale constant for zh_TW.

public static final Locale UK

Locale constant for en_GB.

public static final Locale US

Locale constant for en_US.

Public Constructors

public Locale(String language)

Constructs a new Locale using the specified language.

public Locale(String language, String country)

Constructs a new Locale using the specified language and country codes.

public Locale(String language, String country, String variant)

Constructs a new Locale using the specified language, country, and variant codes.

Throws

NullPointerException if language, country or variant is null.

Public Methods

public Object clone()

Returns a new Locale with the same language, country and variant codes as this Locale.

Returns

  • a shallow copy of this Locale

See Also

public boolean equals(Object object)

Compares the specified object to this Locale and answer if they are equal. The object must be an instance of Locale and have the same language, country and variant.

Parameters

object the object to compare with this object

Returns

  • true if the specified object is equal to this Locale, false otherwise

See Also

public static Locale[] getAvailableLocales()

Gets the list of installed Locales.

Returns

  • an array of Locale

public String getCountry()

Gets the country code for this Locale.

Returns

  • a country code

public static Locale getDefault()

Gets the default Locale.

Returns

  • the default Locale

public String getDisplayCountry(Locale locale)

Gets the full country name in the specified Locale for the country code of this Locale. If there is no matching country name, the country code is returned.

Parameters

locale the Locale

Returns

  • a country name

public final String getDisplayCountry()

Gets the full country name in the default Locale for the country code of this Locale. If there is no matching country name, the country code is returned.

Returns

  • a country name

public final String getDisplayLanguage()

Gets the full language name in the default Locale for the language code of this Locale. If there is no matching language name, the language code is returned.

Returns

  • a language name

public String getDisplayLanguage(Locale locale)

Gets the full language name in the specified Locale for the language code of this Locale. If there is no matching language name, the language code is returned.

Parameters

locale the Locale

Returns

  • a language name

public final String getDisplayName()

Gets the full language, country, and variant names in the default Locale for the codes of this Locale.

Returns

  • a Locale name

public String getDisplayName(Locale locale)

Gets the full language, country, and variant names in the specified Locale for the codes of this Locale.

Parameters

locale the Locale

Returns

  • a Locale name

public String getDisplayVariant(Locale locale)

Gets the full variant name in the specified Locale for the variant code of this Locale. If there is no matching variant name, the variant code is returned.

Parameters

locale the Locale

Returns

  • a variant name

public final String getDisplayVariant()

Gets the full variant name in the default Locale for the variant code of this Locale. If there is no matching variant name, the variant code is returned.

Returns

  • a variant name

public String getISO3Country()

Gets the three letter ISO country code which corresponds to the country code for this Locale.

Returns

  • a three letter ISO language code

Throws

MissingResourceException when there is no matching three letter ISO country code

public String getISO3Language()

Gets the three letter ISO language code which corresponds to the language code for this Locale.

Returns

  • a three letter ISO language code

Throws

MissingResourceException when there is no matching three letter ISO language code

public static String[] getISOCountries()

Gets the list of two letter ISO country codes which can be used as the country code for a Locale.

Returns

  • an array of String

public static String[] getISOLanguages()

Gets the list of two letter ISO language codes which can be used as the language code for a Locale.

Returns

  • an array of String

public String getLanguage()

Gets the language code for this Locale.

Returns

  • a language code

public String getVariant()

Gets the variant code for this Locale.

Returns

  • a variant code

public synchronized int hashCode()

Returns an integer hash code for the receiver. Objects which are equal answer the same value for this method.

Returns

  • the receiver's hash

See Also

public static synchronized void setDefault(Locale locale)

Sets the default Locale to the specified Locale.

Parameters

locale the new default Locale

Throws

SecurityException when there is a security manager which does not allow this operation

public final String toString()

Returns the string representation of this Locale.

Returns

  • the string representation of this Locale
Copyright 2007 Google Inc. Build 0.9_r1-98467 - 14 Aug 2008 18:48