java.util
Class Locale

java.lang.Object
  extended by java.util.Locale
All Implemented Interfaces:
Serializable, Cloneable

public final class Locale
extends Object
implements Cloneable, Serializable

A Locale object represents a specific geographical, political, or cultural region. An operation that requires a Locale to perform its task is called locale-sensitive and uses the Locale to tailor information for the user. For example, displaying a number is a locale-sensitive operation--the number should be formatted according to the customs/conventions of the user's native country, region, or culture.

The Locale class implements identifiers interchangeable with the IETF BCP 47 Tags for Identifying Languages, with support for the LDML ( UTS#35 Locale Data Markup Language)'s BCP 47-compatible extensions for locale data exchange.

A Locale object logically consists of the fields described below.

language
ISO 639 alpha-2 or alpha-3 language code, or registered language subtags up to 8 alpha letters (for future enhancements). When a language has both an alpha-2 code and an alpha-3 code, the alpha-2 code must be used. You can find a full list of valid language codes in the IANA Language Subtag Registry (See "Type: language"). The language field is case insensitive, but Locale always canonicalizes to lower case.
Example: "en" (English), "ja" (Japanese), "kok" (Konkani)
script
ISO 15924 alpha-4 script code. You can find a full list of valid script codes in the IANA Language Subtag Registry (See "Type: script"). The script field is case insensitive, but Locale always canonicalizes to title case (the first letter is upper case and the rest of the letters are lower case).
Example: "Latn" (Latin), "Cyrl" (Cyrillic)
country (region)
ISO 3166 alpha-2 country code or UN M.49 numeric-3 area code. You can find a full list of valid country and region codes in the IANA Language Subtag Registry (See "Type: region"). The country (region) field is case insensitive, but Locale always canonicalizes to upper case.
Example: "US" (United States), "FR" (France), "029" (Caribbean)
variant
Any arbitrary value used to indicate a variation of a Locale. Where there are two or more variant values each indicating its own semantics, these values should be ordered by importance, with most important first, separated by underscore('_'). The variant field is case sensitive.
Note: IETF BCP 47 places syntactic restrictions on variant subtags. Also BCP 47 subtags are strictly used to indicate additional variations that define a language or its dialects that are not covered by any combinations of language, script and region subtags. However, the variant field in Locale has historically been used for any kind of variations, not just language variations. For example, some supported variants available in Java SE Runtime Environments indicate alternative cultural behaviors such as calendar type or number script. In BCP 47 this kind of information, which does not identify the language, is supported by extension subtags or private use subtags.
Example: "polyton" (Polytonic Greek), "POSIX", "Traditional_WIN"
extensions
A map from single character keys to string values, indicating extensions apart from language identification. The extensions in Locale implement the semantics and syntax of BCP 47 extension subtags and private use subtags. A key must be a single alphanumeric character from the set [0-9a-zA-Z], and is case-insensitive. A value may consist of multiple subtags separated by hyphen('-'). When the key is "x" or "X", each subtag must be 1 to 8 alphanumeric character(s). For all other keys, each subtag must be 2 to 8 alphanumeric characters. The extensions are case insensitive, but Locale canonicalizes to all extension keys and values to lower case.
Example: key="u"/value="ca-japanese" (Japanese Calendar), key="x"/value="java-1-7"
Note: Although above specification requires field values to be registered in the IANA Language Subtag Registry, the Locale class does not provide any validation features. The Builder only checks if an individual field satisfies the syntactical requirement, but does not validate the value itself. See the Locale.Builder for details.

Unicode locale/language extension

UTS#35 Unicode Locale Data Markup defines optional keywords to override or refine the default behavior associated with a locale. A keyword is represented by a pair of key and type. For example, "nu-thai" indicates that Thai local digits (value:"thai") should be used for formatting numbers (key:"nu"). The keywords are mapped to a BCP 47 extension value using the extension singleton key 'u'. The above example, "nu-thai", is mapped to the BCP 47 extension using a singleton extension key 'u', as the extension "u-nu-thai".

The key/type pairs are stored in a Locale object as an extension value with the key UNICODE_LOCALE_EXTENSION ('u'). Thus, when a Locale object contains Unicode locale keywords, getExtension(UNICODE_LOCALE_EXTENSION) will return a String representing keyword(s), such as "nu-thai". The Locale class also provides getUnicodeLocaleKeys and getUnicodeLocaleType which allow you to access Unicode locale keywords directly.

The Unicode locale extension specifies optional behavior in locale-sensitive services. Although the LDML specification defines various keys and values, actual locale-sensitive service implementations in a Java Runtime Environment might not support any particular Unicode locale key/type pairs.

Creating a Locale

There are several different ways to create a Locale object.

Builder

Using Locale.Builder you can construct a Locale object that conforms to BCP 47 syntax.

Constructors

The Locale class provides three constructors:

     Locale(String language)
     Locale(String language, String country)
     Locale(String language, String country, String variant)
 
These constructors allow you to create a Locale object with language, country and variant, but you cannot specify script or extensions.
Factory Methods

The method forLanguageTag creates a Locale object for a well-formed BCP 47 language tag.

Locale Constants

The Locale class provides a number of convenient constants that you can use to create Locale objects for commonly used locales. For example, the following creates a Locale object for the United States:

     Locale.US
 

Use of Locale

Once you've created a Locale you can query it for information about itself. Use getCountry to get the country (or region) code and getLanguage to get the language code. You can use getDisplayCountry to get the name of the country suitable for displaying to the user. Similarly, you can use getDisplayLanguage to get the name of the language suitable for displaying to the user. Interestingly, the getDisplayXXX methods are themselves locale-sensitive and have two versions: one that uses the default locale and one that uses the locale specified as an argument.

The Java Platform provides a number of classes that perform locale-sensitive operations. For example, the NumberFormat class formats numbers, currency, and percentages in a locale-sensitive manner. Classes such as NumberFormat have several convenience methods for creating a default object of that type. For example, the NumberFormat class provides these three convenience methods for creating a default NumberFormat object:

     NumberFormat.getInstance()
     NumberFormat.getCurrencyInstance()
     NumberFormat.getPercentInstance()
 
Each of these methods has two variants; one with an explicit locale and one without; the latter uses the default locale.
     NumberFormat.getInstance(myLocale)
     NumberFormat.getCurrencyInstance(myLocale)
     NumberFormat.getPercentInstance(myLocale)
 
A Locale is the mechanism for identifying the kind of object (NumberFormat) that you would like to get. The locale is just a mechanism for identifying objects, not a container for the objects themselves.

Compatibility

For compatibility reasons, two non-conforming locales are treated as special cases. These are ja_JP_JP and th_TH_TH. These are ill-formed in BCP 47 since the variants are too short. To ease migration to BCP 47, these are treated specially during construction.

Java has used ja_JP_JP to represent Japanese as used in Japan together with the Japanese Imperial calendar. This is now representable using a Unicode locale extension, by specifying the Unicode locale key ca (for "calendar") and type japanese. When the Locale constructor is called with the arguments "ja", "JP", "JP", this extension is automatically added.

Java has used th_TH_TH to represent Thai as used in Thailand together with Thai digits. This is also now representable using a Unicode locale extension, by specifying the Unicode locale key nu (for "number") and value thai. When the Locale constructor is called with the arguments "th", "TH", "TH", this extension is automatically added.

Legacy language codes

Locale's constructor has always converted three language codes to their earlier, obsoleted forms: he maps to iw, yi maps to ji, and id maps to in. This continues to be the case, in order to not break backwards compatibility.

The new BCP 47 APIs map between the old and new language codes, maintaining the old codes internal to Locale (so that getLanguage and toString reflect the old code), but using the new codes in the BCP 47 language tag APIs (so that toLanguageTag reflects the new one). This preserves the equivalence between Locales no matter which code or API is used to construct them. Java's default resource bundle lookup mechanism also implements this mapping, so that resources can be named using either convention, see ResourceBundle.Control.

Three-letter language/country(region) codes

The Locale constructors have always specified that the language and the country param be two characters in length, although in practice they have accepted any length. The specification has now been relaxed to allow language codes of two to eight characters and country (region) codes of two to three characters, and in particular, three-letter language codes and three-letter region codes as specified in the IANA Language Subtag Registry. For compatibility, the implementation still does not impose a length constraint.

Since:
1.1
Author:
Mark Davis
See Also:
Locale.Builder, ResourceBundle, Format, NumberFormat, Collator, Serialized Form

Nested Class Summary
Modifier and Type Class and Description
static class Locale.Builder
          Builder is used to build instances of Locale from values configured by the setter.
 
Field Summary
Modifier and Type Field and Description
static Locale CANADA
          Useful constant for country.
static Locale CANADA_FRENCH
          Useful constant for country.
static Locale CHINA
          Useful constant for country.
static Locale CHINESE
          Useful constant for language.
static Locale ENGLISH
          Useful constant for language.
static Locale FRANCE
          Useful constant for country.
static Locale FRENCH
          Useful constant for language.
static Locale GERMAN
          Useful constant for language.
static Locale GERMANY
          Useful constant for country.
static Locale ITALIAN
          Useful constant for language.
static Locale ITALY
          Useful constant for country.
static Locale JAPAN
          Useful constant for country.
static Locale JAPANESE
          Useful constant for language.
static Locale KOREA
          Useful constant for country.
static Locale KOREAN
          Useful constant for language.
static Locale PRC
          Useful constant for country.
static char PRIVATE_USE_EXTENSION
          The key for the private use extension ('x').
static Locale ROOT
          Useful constant for the root locale.
static Locale SIMPLIFIED_CHINESE
          Useful constant for language.
static Locale TAIWAN
          Useful constant for country.
static Locale TRADITIONAL_CHINESE
          Useful constant for language.
static Locale UK
          Useful constant for country.
static char UNICODE_LOCALE_EXTENSION
          The key for Unicode locale extension ('u').
static Locale US
          Useful constant for country.
 
Constructor Summary
Constructor and Description
Locale(String language)
          Construct a locale from a language code.
Locale(String language, String country)
          Construct a locale from language and country.
Locale(String language, String country, String variant)
          Construct a locale from language, country and variant.
 
Method Summary
Modifier and Type Method and Description
 Object clone()
          Overrides Cloneable
 boolean equals(Object obj)
          Returns true if this Locale is equal to another object.
static Locale forLanguageTag(String languageTag)
          Returns a locale for the specified IETF BCP 47 language tag string.
static Locale[] getAvailableLocales()
          Returns an array of all installed locales.
 String getCountry()
          Returns the country/region code for this locale, which should be empty string, or an uppercase ISO 3166 2-letter code, or a UN M.49 3-digits code.
static Locale getDefault()
          Gets the current value of the default locale for this instance of the Java Virtual Machine.
 String getDisplayCountry()
          Returns a name for the locale's country that is appropriate for display to the user.
 String getDisplayCountry(Locale inLocale)
          Returns a name for the locale's country that is appropriate for display to the user.
 String getDisplayLanguage()
          Returns a name for the locale's language that is appropriate for display to the user.
 String getDisplayLanguage(Locale inLocale)
          Returns a name for the locale's language that is appropriate for display to the user.
 String getDisplayName()
          Returns a name for the locale that is appropriate for display to the user.
 String getDisplayName(Locale inLocale)
          Returns a name for the locale that is appropriate for display to the user.
 String getDisplayScript()
          Returns a name for the the locale's script code that is appropriate for display to the user.
 String getDisplayScript(Locale inLocale)
          Returns a name for the locale's script code that is appropriate for display to the user.
 String getDisplayVariant()
          Returns a name for the locale's variant code that is appropriate for display to the user.
 String getDisplayVariant(Locale inLocale)
          Returns a name for the locale's variant code that is appropriate for display to the user.
 String getExtension(char key)
          Returns the extension (or private use) value associated with the specified singleton key, or null if there is no extension associated with the key.
 Set<Character> getExtensionKeys()
          Returns the set of extension keys associated with this locale, or the empty set if it has no extensions.
 String getISO3Country()
          Returns a three-letter abbreviation for this locale's country.
 String getISO3Language()
          Returns a three-letter abbreviation of this locale's language.
static String[] getISOCountries()
          Returns a list of all 2-letter country codes defined in ISO 3166.
static String[] getISOLanguages()
          Returns a list of all 2-letter language codes defined in ISO 639.
 String getLanguage()
          Returns the language code of this Locale.
 String getScript()
          Returns the script code for this locale, which should either be the empty string or an ISO 15924 4-letter script code.
 Set<String> getUnicodeLocaleKeys()
          Returns the set of keys for Unicode locale keywords defined by this locale, or null if this locale has no locale extension.
 String getUnicodeLocaleType(String key)
          Returns the Unicode locale type associated with the specified Unicode locale key for this locale.
 String getVariant()
          Returns the variant code for this locale.
 int hashCode()
          Override hashCode.
static void setDefault(Locale newLocale)
          Sets the default locale for this instance of the Java Virtual Machine.
 String toLanguageTag()
          Returns a well-formed IETF BCP 47 language tag representing this locale.
 String toString()
          Returns a string representation of this Locale object, consisting of language, country, variant, script, and extensions as below:
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

ENGLISH

public static final Locale ENGLISH
Useful constant for language.


FRENCH

public static final Locale FRENCH
Useful constant for language.


GERMAN

public static final Locale GERMAN
Useful constant for language.


ITALIAN

public static final Locale ITALIAN
Useful constant for language.


JAPANESE

public static final Locale JAPANESE
Useful constant for language.


KOREAN

public static final Locale KOREAN
Useful constant for language.


CHINESE

public static final Locale CHINESE
Useful constant for language.


SIMPLIFIED_CHINESE

public static final Locale SIMPLIFIED_CHINESE
Useful constant for language.


TRADITIONAL_CHINESE

public static final Locale TRADITIONAL_CHINESE
Useful constant for language.


FRANCE

public static final Locale FRANCE
Useful constant for country.


GERMANY

public static final Locale GERMANY
Useful constant for country.


ITALY

public static final Locale ITALY
Useful constant for country.


JAPAN

public static final Locale JAPAN
Useful constant for country.


KOREA

public static final Locale KOREA
Useful constant for country.


CHINA

public static final Locale CHINA
Useful constant for country.


PRC

public static final Locale PRC
Useful constant for country.


TAIWAN

public static final Locale TAIWAN
Useful constant for country.


UK

public static final Locale UK
Useful constant for country.


US

public static final Locale US
Useful constant for country.


CANADA

public static final Locale CANADA
Useful constant for country.


CANADA_FRENCH

public static final Locale CANADA_FRENCH
Useful constant for country.


ROOT

public static final Locale ROOT
Useful constant for the root locale. The root locale is the locale whose language, country, and variant are empty ("") strings. This is regarded as the base locale of all locales, and is used as the language/country neutral locale for the locale sensitive operations.

Since:
1.6

PRIVATE_USE_EXTENSION

public static final char PRIVATE_USE_EXTENSION
The key for the private use extension ('x').

Since:
1.7
See Also:
getExtension(char), Locale.Builder.setExtension(char, String), Constant Field Values

UNICODE_LOCALE_EXTENSION

public static final char UNICODE_LOCALE_EXTENSION
The key for Unicode locale extension ('u').

Since:
1.7
See Also:
getExtension(char), Locale.Builder.setExtension(char, String), Constant Field Values
Constructor Detail

Locale

public Locale(String language,
              String country,
              String variant)
Construct a locale from language, country and variant. This constructor normalizes the language value to lowercase and the country value to uppercase.

Note:

Parameters:
language - An ISO 639 alpha-2 or alpha-3 language code, or a language subtag up to 8 characters in length. See the Locale class description about valid language values.
country - An ISO 3166 alpha-2 country code or a UN M.49 numeric-3 area code. See the Locale class description about valid country values.
variant - Any arbitrary value used to indicate a variation of a Locale. See the Locale class description for the details.
Throws:
NullPointerException - thrown if any argument is null.

Locale

public Locale(String language,
              String country)
Construct a locale from language and country. This constructor normalizes the language value to lowercase and the country value to uppercase.

Note:

Parameters:
language - An ISO 639 alpha-2 or alpha-3 language code, or a language subtag up to 8 characters in length. See the Locale class description about valid language values.
country - An ISO 3166 alpha-2 country code or a UN M.49 numeric-3 area code. See the Locale class description about valid country values.
Throws:
NullPointerException - thrown if either argument is null.

Locale

public Locale(String language)
Construct a locale from a language code. This constructor normalizes the language value to lowercase.

Note:

Parameters:
language - An ISO 639 alpha-2 or alpha-3 language code, or a language subtag up to 8 characters in length. See the Locale class description about valid language values.
Throws:
NullPointerException - thrown if argument is null.
Since:
1.4
Method Detail

getDefault

public static Locale getDefault()
Gets the current value of the default locale for this instance of the Java Virtual Machine.

The Java Virtual Machine sets the default locale during startup based on the host environment. It is used by many locale-sensitive methods if no locale is explicitly specified. It can be changed using the setDefault method.

Returns:
the default locale for this instance of the Java Virtual Machine

setDefault

public static void setDefault(Locale newLocale)
Sets the default locale for this instance of the Java Virtual Machine. This does not affect the host locale.

If there is a security manager, its checkPermission method is called with a PropertyPermission("user.language", "write") permission before the default locale is changed.

The Java Virtual Machine sets the default locale during startup based on the host environment. It is used by many locale-sensitive methods if no locale is explicitly specified.

Since changing the default locale may affect many different areas of functionality, this method should only be used if the caller is prepared to reinitialize locale-sensitive code running within the same Java Virtual Machine.

Parameters:
newLocale - the new default locale
Throws:
SecurityException - if a security manager exists and its checkPermission method doesn't allow the operation.
NullPointerException - if newLocale is null
See Also:
SecurityManager.checkPermission(java.security.Permission), PropertyPermission

getAvailableLocales

public static Locale[] getAvailableLocales()
Returns an array of all installed locales. The returned array represents the union of locales supported by the Java runtime environment and by installed LocaleServiceProvider implementations. It must contain at least a Locale instance equal to Locale.US.

Returns:
An array of installed locales.

getISOCountries

public static String[] getISOCountries()
Returns a list of all 2-letter country codes defined in ISO 3166. Can be used to create Locales.

Note: The Locale class also supports other codes for country (region), such as 3-letter numeric UN M.49 area codes. Therefore, the list returned by this method does not contain ALL valid codes that can be used to create Locales.


getISOLanguages

public static String[] getISOLanguages()
Returns a list of all 2-letter language codes defined in ISO 639. Can be used to create Locales.

Note:


getLanguage

public String getLanguage()
Returns the language code of this Locale.

Note: ISO 639 is not a stable standard-- some languages' codes have changed. Locale's constructor recognizes both the new and the old codes for the languages whose codes have changed, but this function always returns the old code. If you want to check for a specific language whose code has changed, don't do

 if (locale.getLanguage().equals("he"))
    ...
 
Instead, do
 if (locale.getLanguage().equals(new Locale("he").getLanguage()))
    ...
 

Returns:
The language code, or the empty string if none is defined.
See Also:
getDisplayLanguage()

getScript

public String getScript()
Returns the script code for this locale, which should either be the empty string or an ISO 15924 4-letter script code. The first letter is uppercase and the rest are lowercase, for example, 'Latn', 'Cyrl'.

Returns:
The script code, or the empty string if none is defined.
Since:
1.7
See Also:
getDisplayScript()

getCountry

public String getCountry()
Returns the country/region code for this locale, which should be empty string, or an uppercase ISO 3166 2-letter code, or a UN M.49 3-digits code.

Returns:
The country/region code, or the empty string if none is defined.
See Also:
getDisplayCountry()

getVariant

public String getVariant()
Returns the variant code for this locale.

See Also:
getDisplayVariant()

getExtension

public String getExtension(char key)
Returns the extension (or private use) value associated with the specified singleton key, or null if there is no extension associated with the key. To be valid, the key must be one of [0-9A-Za-z]. Keys are case-insensitive, so for example 'z' and 'Z' represent the same extension.

Parameters:
key - the extension key
Returns:
the extension, or null if this locale defines no extension for the specified key
Throws:
IllegalArgumentException - if the key is not valid
Since:
1.7
See Also:
PRIVATE_USE_EXTENSION, UNICODE_LOCALE_EXTENSION

getExtensionKeys

public Set<Character> getExtensionKeys()
Returns the set of extension keys associated with this locale, or the empty set if it has no extensions. The returned set is unmodifiable.

Returns:
the set of extension keys, or the empty set if this locale has no extensions
Since:
1.7

getUnicodeLocaleType

public String getUnicodeLocaleType(String key)
Returns the Unicode locale type associated with the specified Unicode locale key for this locale. Unicode locale keywrods are specified by the 'u' extension and consist of key/type pairs. The key must be two alphanumeric characters in length, or an IllegalArgumentException is thrown.

Parameters:
key - the Unicode locale key
Returns:
the Unicode locale type associated with the key, or null if the locale does not define a value for the key.
Throws:
IllegalArgumentException - if the key is not valid.
NullPointerException - if key is null
Since:
1.7

getUnicodeLocaleKeys

public Set<String> getUnicodeLocaleKeys()
Returns the set of keys for Unicode locale keywords defined by this locale, or null if this locale has no locale extension. The returned set is immutable.

Returns:
the set of the Unicode locale keys, or null
Since:
1.7

toString

public final String toString()
Returns a string representation of this Locale object, consisting of language, country, variant, script, and extensions as below:

language + "_" + country + "_" + variant + "_#" + script + "-" + extensions
Language is always lower case, country is always upper case, script is always title case, and extensions is always lower case.

If the language is missing, the string will begin with an underscore. If both the language and country fields are missing, this function will return the empty string, even if the variant or script or extensions field is filled in (you can't have a locale with just a variant-- the variant must accompany a valid language or country code).

Examples: "en", "de_DE", "_GB", "en_US_WIN", "de__POSIX", "fr__MAC", "zh_CN_#Hans", "zh_TW_#Hant-x-java", "th_TH_TH_#u-nu-thai"

Overrides:
toString in class Object
See Also:
getDisplayName()

toLanguageTag

public String toLanguageTag()
Returns a well-formed IETF BCP 47 language tag representing this locale.

If this Locale object has language, country, or variant that does not satisfy the IETF BCP 47 language tag syntax requirements, this method handles these fields as described below:

Language: If language is empty or ill-formed (for example "a" or "e2"), it will be emitted as "und" (Undetermined).

Country: If country is ill-formed (for example "12" or "USA"), it will be omitted.

Variant: Variant is treated as consisting of subtags separated by underscore. 'Well-formed' subtags consist of either an ASCII letter followed by 4-7 ASCII characters, or an ASCII digit followed by 3-7 ASCII characters. If well-formed, the variant is emitted as each subtag in order (separated by hyphen). Otherwise:

Note: Although the language tag created by this method satisfies the syntax requirements defined by the IETF BCP 47 specification, it is not always a valid BCP 47 language tag. For example,

   new Locale("xx", "YY").toLanguageTag();
 
will return "xx-YY", but the language subtag "xx" and the region subtag "YY" are invalid because they are not registered in the IANA Language Subtag Registry.

Returns:
a BCP47 language tag representing the locale
Since:
1.7
See Also:
forLanguageTag(String)

forLanguageTag

public static Locale forLanguageTag(String languageTag)
Returns a locale for the specified IETF BCP 47 language tag string. If the specified language tag contains any ill-formed subtags, the first such subtag and all following subtags are ignored.

This implements the 'Language-Tag' production of BCP47, and so supports grandfathered (regular and irregular) as well as private use language tags. Stand alone private use tags are represented as empty language and extension 'x-whatever', and grandfathered tags are converted to their canonical replacements where they exist. Note that a few grandfathered tags have no modern replacement; these will be converted using the fallback described above so some information might be lost.

For a list of grandfathered tags, see the IANA Language Subtag Registry.

Notes: This method converts private use subtags prefixed by "variant" to variant field in the result locale. For example, the code below will return "POSIX".

   Locale.forLanguageTag("en-US-x-variant-POSIX).getVariant();
 

Parameters:
languageTag - the language tag
Returns:
the locale that best represents the language tag
Throws:
NullPointerException - if languageTag is null
Since:
1.7
See Also:
toLanguageTag()

getISO3Language

public String getISO3Language()
                       throws MissingResourceException
Returns a three-letter abbreviation of this locale's language. If the language matches an ISO 639-1 two-letter code, the corresponding ISO 639-2/T three-letter lowercase code is returned. The ISO 639-2 language codes can be found on-line at http://www.loc.gov/standards/iso639-2/langhome.html. If the locale specifies a three-letter language, the language is returned as is. If the locale does not specify a language the empty string is returned.

Returns:
A three-letter abbreviation of this locale's language.
Throws:
MissingResourceException - Throws MissingResourceException if three-letter language abbreviation is not available for this locale.

getISO3Country

public String getISO3Country()
                      throws MissingResourceException
Returns a three-letter abbreviation for this locale's country. If the country matches an ISO 3166-1 alpha-2 code, the corresponding ISO 3166-1 alpha-3 uppercase code is returned. The ISO 3166-1 codes can be found on-line at http://en.wikipedia.org/wiki/ISO_3166-1. If the locale doesn't specify a country, this will be the empty string.

Returns:
A three-letter abbreviation of this locale's country.
Throws:
MissingResourceException - Throws MissingResourceException if the three-letter country abbreviation is not available for this locale.

getDisplayLanguage

public final String getDisplayLanguage()
Returns a name for the locale's language that is appropriate for display to the user. If possible, the name returned will be localized for the default locale. For example, if the locale is fr_FR and the default locale is en_US, getDisplayLanguage() will return "French"; if the locale is en_US and the default locale is fr_FR, getDisplayLanguage() will return "anglais". If the name returned cannot be localized for the default locale, (say, we don't have a Japanese name for Croatian), this function falls back on the English name, and uses the ISO code as a last-resort value. If the locale doesn't specify a language, this function returns the empty string.


getDisplayLanguage

public String getDisplayLanguage(Locale inLocale)
Returns a name for the locale's language that is appropriate for display to the user. If possible, the name returned will be localized according to inLocale. For example, if the locale is fr_FR and inLocale is en_US, getDisplayLanguage() will return "French"; if the locale is en_US and inLocale is fr_FR, getDisplayLanguage() will return "anglais". If the name returned cannot be localized according to inLocale, (say, we don't have a Japanese name for Croatian), this function falls back on the English name, and finally on the ISO code as a last-resort value. If the locale doesn't specify a language, this function returns the empty string.

Throws:
NullPointerException - if inLocale is null

getDisplayScript

public String getDisplayScript()
Returns a name for the the locale's script code that is appropriate for display to the user. If possible, the name will be localized for the default locale. Returns the empty string if this locale doesn't specify a script code.

Returns:
the display name of the script code for the current default locale
Since:
1.7

getDisplayScript

public String getDisplayScript(Locale inLocale)
Returns a name for the locale's script code that is appropriate for display to the user. If possible, the name will be localized for the given locale. Returns the empty string if this locale doesn't specify a script code.

Returns:
the display name of the script code for the current default locale
Throws:
NullPointerException - if inLocale is null
Since:
1.7

getDisplayCountry

public final String getDisplayCountry()
Returns a name for the locale's country that is appropriate for display to the user. If possible, the name returned will be localized for the default locale. For example, if the locale is fr_FR and the default locale is en_US, getDisplayCountry() will return "France"; if the locale is en_US and the default locale is fr_FR, getDisplayCountry() will return "Etats-Unis". If the name returned cannot be localized for the default locale, (say, we don't have a Japanese name for Croatia), this function falls back on the English name, and uses the ISO code as a last-resort value. If the locale doesn't specify a country, this function returns the empty string.


getDisplayCountry

public String getDisplayCountry(Locale inLocale)
Returns a name for the locale's country that is appropriate for display to the user. If possible, the name returned will be localized according to inLocale. For example, if the locale is fr_FR and inLocale is en_US, getDisplayCountry() will return "France"; if the locale is en_US and inLocale is fr_FR, getDisplayCountry() will return "Etats-Unis". If the name returned cannot be localized according to inLocale. (say, we don't have a Japanese name for Croatia), this function falls back on the English name, and finally on the ISO code as a last-resort value. If the locale doesn't specify a country, this function returns the empty string.

Throws:
NullPointerException - if inLocale is null

getDisplayVariant

public final String getDisplayVariant()
Returns a name for the locale's variant code that is appropriate for display to the user. If possible, the name will be localized for the default locale. If the locale doesn't specify a variant code, this function returns the empty string.


getDisplayVariant

public String getDisplayVariant(Locale inLocale)
Returns a name for the locale's variant code that is appropriate for display to the user. If possible, the name will be localized for inLocale. If the locale doesn't specify a variant code, this function returns the empty string.

Throws:
NullPointerException - if inLocale is null

getDisplayName

public final String getDisplayName()
Returns a name for the locale that is appropriate for display to the user. This will be the values returned by getDisplayLanguage(), getDisplayScript(), getDisplayCountry(), and getDisplayVariant() assembled into a single string. The display name will have one of the following forms:
language (script, country, variant)
language (script, country)
langauge (script, variant)
language (script)
language (country, variant)
language (country)
language (variant)
country (variant)
language
country
variant
depending on which fields are specified in the locale. If the language, country, and variant fields are all empty, this function returns the empty string.


getDisplayName

public String getDisplayName(Locale inLocale)
Returns a name for the locale that is appropriate for display to the user. This will be the values returned by getDisplayLanguage(), getDisplayCountry(), and getDisplayVariant() assembled into a single string. The display name will have one of the following forms:

language (script, country, variant)

language (script, country)

langauge (script, variant)

language (script)

language (country, variant)

language (country)

country (variant)

language

country

variant

depending on which fields are specified in the locale. If the language, country, and variant fields are all empty, this function returns the empty string.

Throws:
NullPointerException - if inLocale is null

clone

public Object clone()
Overrides Cloneable

Overrides:
clone in class Object

hashCode

public int hashCode()
Override hashCode. Since Locales are often used in hashtables, caches the value for speed.

Overrides:
hashCode in class Object

equals

public boolean equals(Object obj)
Returns true if this Locale is equal to another object. A Locale is deemed equal to another Locale with identical language, script, country, variant and extensions, and unequal to all other objects.

Overrides:
equals in class Object
Returns:
true if this Locale is equal to the specified object.