Locale

extern class java.util.Localeimplements Cloneableimplements SerializableAvailable in javaA
Locale
object represents a specific geographical, political, or cultural region. An operation that requires a
Locale
to perform its task is called <em>locale-sensitive</em> and uses the
Locale
to tailor information for the user. For example, displaying a number is a locale-sensitive operation&mdash; the number should be formatted according to the customs and conventions of the user's native country, region, or culture.
<p> The
Locale
class implements identifiers interchangeable with BCP 47 (IETF BCP 47, "Tags for Identifying Languages"), with support for the LDML (UTS#35, "Unicode Locale Data Markup Language") BCP 47-compatible extensions for locale data exchange.
<p> A
Locale
object logically consists of the fields described below.
<dl> <dt><a name="def_language"/><b>language</b></dt>
<dd>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 (search for "Type: language"). The language field is case insensitive, but
Locale
always canonicalizes to lower case.</dd><br>
<dd>Well-formed language values have the form
''a-zA-Z''{2,8}
. Note that this is not the the full BCP47 language production, since it excludes extlang. They are not needed since modern three-letter language codes replace them.</dd><br>
<dd>Example: "en" (English), "ja" (Japanese), "kok" (Konkani)</dd><br>
<dt><a name="def_script"/><b>script</b></dt>
<dd>ISO 15924 alpha-4 script code. You can find a full list of valid script codes in the IANA Language Subtag Registry (search for "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).</dd><br>
<dd>Well-formed script values have the form
''a-zA-Z''{4}
</dd><br>
<dd>Example: "Latn" (Latin), "Cyrl" (Cyrillic)</dd><br>
<dt><a name="def_region"/><b>country (region)</b></dt>
<dd>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 (search for "Type: region"). The country (region) field is case insensitive, but
Locale
always canonicalizes to upper case.</dd><br>
<dd>Well-formed country/region values have the form
''a-zA-Z''{2} | ''0-9''{3}
</dd><br>
<dd>Example: "US" (United States), "FR" (France), "029" (Caribbean)</dd><br>
<dt><a name="def_variant"/><b>variant</b></dt>
<dd>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.</dd><br>
<dd>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. You can find a full list of valid variant codes in the IANA Language Subtag Registry (search for "Type: variant").
<p>However, the variant field in
Locale
has historically been used for any kind of variation, 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.</dd><br>
<dd>Well-formed variant values have the form
SUBTAG (('_'|'-') SUBTAG)*
where
SUBTAG = ''0-9''''0-9a-zA-Z''{3} | ''0-9a-zA-Z''{5,8}
. (Note: BCP 47 only uses hyphen ('-') as a delimiter, this is more lenient).</dd><br>
<dd>Example: "polyton" (Polytonic Greek), "POSIX"</dd><br>
<dt><a name="def_extensions"/><b>extensions</b></dt>
<dd>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. The extensions are case insensitive, but
Locale
canonicalizes all extension keys and values to lower case. Note that extensions cannot have empty values.</dd><br>
<dd>Well-formed keys are single characters from the set
''0-9a-zA-Z''
. Well-formed values have the form
SUBTAG ('-' SUBTAG)*
where for the key 'x'
SUBTAG = ''0-9a-zA-Z''{1,8}
and for other keys
SUBTAG = ''0-9a-zA-Z''{2,8}
(that is, 'x' allows single-character subtags).</dd><br>
<dd>Example: key="u"/value="ca-japanese" (Japanese Calendar), key="x"/value="java-1-7"</dd> </dl>
<b>Note:</b> Although BCP 47 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 syntactic requirement (is well-formed), but does not validate the value itself. See {@link Builder} for details.
<h4><a name="def_locale_extension">Unicode locale/language extension</h4>
<p>UTS#35, "Unicode Locale Data Markup Language" defines optional attributes and 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").
<p>The keywords are mapped to a BCP 47 extension value using the extension key 'u' ({@link #UNICODE_LOCALE_EXTENSION}). The above example, "nu-thai", becomes the extension "u-nu-thai".code
<p>Thus, when a
Locale
object contains Unicode locale attributes and keywords,
getExtension(UNICODE_LOCALE_EXTENSION)
will return a String representing this information, for example, "nu-thai". The
Locale
class also provides {@link #getUnicodeLocaleAttributes}, {@link #getUnicodeLocaleKeys}, and {@link #getUnicodeLocaleType} which allow you to access Unicode locale attributes and key/type pairs directly. When represented as a string, the Unicode Locale Extension lists attributes alphabetically, followed by key/type sequences with keys listed alphabetically (the order of subtags comprising a key's type is fixed when the type is defined)
<p>A well-formed locale key has the form
''0-9a-zA-Z''{2}
. A well-formed locale type has the form
"" | ''0-9a-zA-Z''{3,8} ('-' ''0-9a-zA-Z''{3,8})*
(it can be empty, or a series of subtags 3-8 alphanums in length). A well-formed locale attribute has the form
''0-9a-zA-Z''{3,8}
(it is a single subtag with the same form as a locale type subtag).
<p>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 attributes or key/type pairs.
<h4>Creating a Locale</h4>
<p>There are several different ways to create a
Locale
object.
<h5>Builder</h5>
<p>Using {@link Builder} you can construct a
Locale
object that conforms to BCP 47 syntax.
<h5>Constructors</h5>
<p>The
Locale
class provides three constructors: <blockquote> <pre> {@link #Locale(String language)} {@link #Locale(String language, String country)} {@link #Locale(String language, String country, String variant)} </pre> </blockquote> These constructors allow you to create a
Locale
object with language, country and variant, but you cannot specify script or extensions.
<h5>Factory Methods</h5>
<p>The method {@link #forLanguageTag} creates a
Locale
object for a well-formed BCP 47 language tag.
<h5>Locale Constants</h5>
<p>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: <blockquote> <pre> Locale.US </pre> </blockquote>
<h4>Use of Locale</h4>
<p>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.
<p>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: <blockquote> <pre> NumberFormat.getInstance() NumberFormat.getCurrencyInstance() NumberFormat.getPercentInstance() </pre> </blockquote> Each of these methods has two variants; one with an explicit locale and one without; the latter uses the default locale: <blockquote> <pre> NumberFormat.getInstance(myLocale) NumberFormat.getCurrencyInstance(myLocale) NumberFormat.getPercentInstance(myLocale) </pre> </blockquote> A
Locale
is the mechanism for identifying the kind of object (
NumberFormat
) that you would like to get. The locale is <STRONG>just</STRONG> a mechanism for identifying objects, <STRONG>not</STRONG> a container for the objects themselves.
<h4>Compatibility</h4>
<p>In order to maintain compatibility with existing usage, Locale's constructors retain their behavior prior to the Java Runtime Environment version 1.7. The same is largely true for the
toString
method. Thus Locale objects can continue to be used as they were. In particular, clients who parse the output of toString into language, country, and variant fields can continue to do so (although this is strongly discouraged), although the variant field will have additional information in it if script or extensions are present.
<p>In addition, BCP 47 imposes syntax restrictions that are not imposed by Locale's constructors. This means that conversions between some Locales and BCP 47 language tags cannot be made without losing information. Thus
toLanguageTag
cannot represent the state of locales whose language, country, or variant do not conform to BCP 47.
<p>Because of these issues, it is recommended that clients migrate away from constructing non-conforming locales and use the
forLanguageTag
and
Locale.Builder
APIs instead. Clients desiring a string representation of the complete locale can then always rely on
toLanguageTag
for this purpose.
<h5><a name="special_cases_constructor"/>Special cases</h5>
<p>For compatibility reasons, two non-conforming locales are treated as special cases. These are <b><tt>ja_JP_JP</tt></b> and <b><tt>th_TH_TH</tt></b>. 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. These two cases (and only these) cause a constructor to generate an extension, all other values behave exactly as they did prior to Java 7.
<p>Java has used <tt>ja_JP_JP</tt> 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 <tt>ca</tt> (for "calendar") and type <tt>japanese</tt>. When the Locale constructor is called with the arguments "ja", "JP", "JP", the extension "u-ca-japanese" is automatically added.
<p>Java has used <tt>th_TH_TH</tt> 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 <tt>nu</tt> (for "number") and value <tt>thai</tt>. When the Locale constructor is called with the arguments "th", "TH", "TH", the extension "u-nu-thai" is automatically added.
<h5>Serialization</h5>
<p>During serialization, writeObject writes all fields to the output stream, including extensions.
<p>During deserialization, readResolve adds extensions as described in <a href="#special_cases_constructor">Special Cases</a>, only for the two cases th_TH_TH and ja_JP_JP.
<h5>Legacy language codes</h5>
<p>Locale's constructor has always converted three language codes to their earlier, obsoleted forms: <tt>he</tt> maps to <tt>iw</tt>, <tt>yi</tt> maps to <tt>ji</tt>, and <tt>id</tt> maps to <tt>in</tt>. This continues to be the case, in order to not break backwards compatibility.
<p>The APIs added in 1.7 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 {@link ResourceBundle.Control}.
<h5>Three-letter language/country(region) codes</h5>
<p>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-digit region codes as specified in the IANA Language Subtag Registry. For compatibility, the implementation still does not impose a length constraint.
see Builder see ResourceBundle see java.text.Format see java.text.NumberFormat see java.text.Collator author Mark Davis @since 1.1
function new( param1 : String, param2 : String, param3 : String ) : VoidConstruct a locale from language, country and variant. This constructor normalizes the language value to lowercase and the country value to uppercase. <p> <b>Note:</b> <ul> <li>ISO 639 is not a stable standard; some of the language codes it defines (specifically "iw", "ji", and "in") have changed. This constructor accepts both the old codes ("iw", "ji", and "in") and the new codes ("he", "yi", and "id"), but all other API on Locale will return only the OLD codes. <li>For backward compatibility reasons, this constructor does not make any syntactic checks on the input. <li>The two cases ("ja", "JP", "JP") and ("th", "TH", "TH") are handled specially, see <a href="#special_cases_constructor">Special Cases</a> for more information. </ul>
@param 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. @param 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. @param variant Any arbitrary value used to indicate a variation of a
Locale
. See the
Locale
class description for the details. @exception NullPointerException thrown if any argument is null.
function clone() : DynamicOverrides Cloneable. function equals( param1 : Dynamic ) : BoolReturns 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.
@return true if this Locale is equal to the specified object.
function getCountry() : StringReturns the country/region code for this locale, which should either be the empty string, an uppercase ISO 3166 2-letter code, or a UN M.49 3-digit code.
@return The country/region code, or the empty string if none is defined. @see #getDisplayCountry
function getDisplayCountry() : StringReturns 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. function getDisplayLanguage() : StringReturns 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. function getDisplayName() : StringReturns 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 the non-empty values are used in order, with the second and subsequent names in parentheses. For example: <blockquote> language (script, country, variant)<br> language (country)<br> language (variant)<br> script (country)<br> country<br> </blockquote> depending on which fields are specified in the locale. If the language, sacript, country, and variant fields are all empty, this function returns the empty string. function getDisplayScript() : StringReturns a name for the the locale's script 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.
return the display name of the script code for the current default locale since 1.7
function getDisplayVariant() : StringReturns 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. function getExtension( param1 : Char16 ) : StringReturns the extension (or private use) value associated with the specified key, or null if there is no extension associated with the key. To be well-formed, the key must be one of
''0-9A-Za-z''
. Keys are case-insensitive, so for example 'z' and 'Z' represent the same extension.
param key the extension key return The extension, or null if this locale defines no extension for the specified key. throws IllegalArgumentException if key is not well-formed see #PRIVATE_USE_EXTENSION @see #UNICODE_LOCALE_EXTENSION @since 1.7
function getExtensionKeys() : Set<Null<Char16>>Returns the set of extension keys associated with this locale, or the empty set if it has no extensions. The returned set is unmodifiable. The keys will all be lower-case.
@return The set of extension keys, or the empty set if this locale has no extensions. @since 1.7
function getISO3Country() : StringReturns 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. If the locale doesn't specify a country, this will be the empty string.
<p>The ISO 3166-1 codes can be found on-line.
@return A three-letter abbreviation of this locale's country. @exception MissingResourceException Throws MissingResourceException if the three-letter country abbreviation is not available for this locale.
function getISO3Language() : StringReturns 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, see "Codes for the Representation of Names of Languages Part 2: Alpha-3 Code". 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.
@return A three-letter abbreviation of this locale's language. @exception MissingResourceException Throws MissingResourceException if three-letter language abbreviation is not available for this locale.
function getLanguage() : StringReturns the language code of this Locale.
<p><b>Note:</b> ISO 639 is not a stable standard&mdash; 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 <pre> if (locale.getLanguage().equals("he")) // BAD! ... </pre> Instead, do <pre> if (locale.getLanguage().equals(new Locale("he").getLanguage())) ... </pre> @return The language code, or the empty string if none is defined. @see #getDisplayLanguage
function getScript() : StringReturns the script 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'.
@return The script code, or the empty string if none is defined. @see #getDisplayScript @since 1.7
function getUnicodeLocaleAttributes() : Set<String>Returns the set of unicode locale attributes associated with this locale, or the empty set if it has no attributes. The returned set is unmodifiable.
return The set of attributes. since 1.7
function getUnicodeLocaleKeys() : Set<String>Returns the set of Unicode locale keys defined by this locale, or the empty set if this locale has none. The returned set is immutable. Keys are all lower case.
@return The set of Unicode locale keys, or the empty set if this locale has no Unicode locale keywords. @since 1.7
function getUnicodeLocaleType( param1 : String ) : StringReturns the Unicode locale type associated with the specified Unicode locale key for this locale. Returns the empty string for keys that are defined with no type. Returns null if the key is not defined. Keys are case-insensitive. The key must be two alphanumeric characters (0-9a-zA-Z), or an IllegalArgumentException is thrown.
param key the Unicode locale key return The Unicode locale type associated with the key, or null if the locale does not define the key. throws IllegalArgumentException if the key is not well-formed throws NullPointerException if
key
is null @since 1.7
function getVariant() : StringReturns the variant code for this locale.
@return The variant code, or the empty string if none is defined. @see #getDisplayVariant
function hashCode() : IntOverride hashCode. Since Locales are often used in hashtables, caches the value for speed. function toLanguageTag() : StringReturns a well-formed IETF BCP 47 language tag representing this locale.
<p>If this
Locale
has a language, country, or variant that does not satisfy the IETF BCP 47 language tag syntax requirements, this method handles these fields as described below:
<p><b>Language:</b> If language is empty, or not <a href="#def_language" >well-formed</a> (for example "a" or "e2"), it will be emitted as "und" (Undetermined).
<p><b>Country:</b> If country is not <a href="#def_region">well-formed</a> (for example "12" or "USA"), it will be omitted.
<p><b>Variant:</b> If variant <b>is</b> <a href="#def_variant">well-formed</a>, each sub-segment (delimited by '-' or '_') is emitted as a subtag. Otherwise: <ul>
<li>if all sub-segments match
''0-9a-zA-Z''{1,8}
(for example "WIN" or "Oracle_JDK_Standard_Edition"), the first ill-formed sub-segment and all following will be appended to the private use subtag. The first appended subtag will be "lvariant", followed by the sub-segments in order, separated by hyphen. For example, "x-lvariant-WIN", "Oracle-x-lvariant-JDK-Standard-Edition".
<li>if any sub-segment does not match
''0-9a-zA-Z''{1,8}
, the variant will be truncated and the problematic sub-segment and all following sub-segments will be omitted. If the remainder is non-empty, it will be emitted as a private use subtag as above (even if the remainder turns out to be well-formed). For example, "Solaris_isjustthecoolestthing" is emitted as "x-lvariant-Solaris", not as "solaris".</li></ul>
<p><b>Special Conversions:</b> Java supports some old locale representations, including deprecated ISO language codes, for compatibility. This method performs the following conversions: <ul>
<li>Deprecated ISO language codes "iw", "ji", and "in" are converted to "he", "yi", and "id", respectively.
<li>A locale with language "no", country "NO", and variant "NY", representing Norwegian Nynorsk (Norway), is converted to a language tag "nn-NO".</li></ul>
<p><b>Note:</b> Although the language tag created by this method is well-formed (satisfies the syntax requirements defined by the IETF BCP 47 specification), it is not necessarily a valid BCP 47 language tag. For example, <pre> new Locale("xx", "YY").toLanguageTag();</pre>
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.
return a BCP47 language tag representing the locale see #forLanguageTag(String) @since 1.7
function toString() : StringReturns a string representation of this
Locale
object, consisting of language, country, variant, script, and extensions as below: <p><blockquote> language + "_" + country + "_" + (variant + "_#" | "#") + script + "-" + extensions </blockquote>
Language is always lower case, country is always upper case, script is always title case, and extensions are always lower case. Extensions and private use subtags will be in canonical order as explained in {@link #toLanguageTag}.
<p>When the locale has neither script nor extensions, the result is the same as in Java 6 and prior.
<p>If both the language and country fields are missing, this function will return the empty string, even if the variant, script, or extensions field is present (you can't have a locale with just a variant, the variant must accompany a well-formed language or country code).
<p>If script or extensions are present and variant is missing, no underscore is added before the "#".
<p>This behavior is designed to support debugging and to be compatible with previous uses of
toString
that expected language, country, and variant fields only. To represent a Locale as a String for interchange purposes, use {@link #toLanguageTag}.
<p>Examples: <ul><tt> <li>en <li>de_DE <li>_GB <li>en_US_WIN <li>de__POSIX <li>zh_CN_#Hans <li>zh_TW_#Hant-x-java <li>th_TH_TH_#u-nu-thai</tt></ul>
@return A string representation of the Locale, for debugging. @see #getDisplayName @see #toLanguageTag
static var CANADA : LocaleUseful constant for country. static var CANADA_FRENCH : LocaleUseful constant for country. static var CHINA : LocaleUseful constant for country. static var CHINESE : LocaleUseful constant for language. static var ENGLISH : LocaleUseful constant for language. static var FRANCE : LocaleUseful constant for country. static var FRENCH : LocaleUseful constant for language. static var GERMAN : LocaleUseful constant for language. static var GERMANY : LocaleUseful constant for country. static var ITALIAN : LocaleUseful constant for language. static var ITALY : LocaleUseful constant for country. static var JAPAN : LocaleUseful constant for country. static var JAPANESE : LocaleUseful constant for language. static var KOREA : LocaleUseful constant for country. static var KOREAN : LocaleUseful constant for language. static var PRC : LocaleUseful constant for country. static var PRIVATE_USE_EXTENSION(default,null) : Char16The key for the private use extension ('x').
@see #getExtension(char) @see Builder#setExtension(char, String) @since 1.7
static var ROOT : LocaleUseful 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
static var SIMPLIFIED_CHINESE : LocaleUseful constant for language. static var TAIWAN : LocaleUseful constant for country. static var TRADITIONAL_CHINESE : LocaleUseful constant for language. static var UK : LocaleUseful constant for country. static var UNICODE_LOCALE_EXTENSION(default,null) : Char16The key for Unicode locale extension ('u').
@see #getExtension(char) @see Builder#setExtension(char, String) @since 1.7
static var US : LocaleUseful constant for country. static function forLanguageTag( param1 : String ) : LocaleReturns a locale for the specified IETF BCP 47 language tag string.
<p>If the specified language tag contains any ill-formed subtags, the first such subtag and all following subtags are ignored. Compare to {@link Locale.Builder#setLanguageTag} which throws an exception in this case.
<p>The following <b>conversions</b> are performed:<ul>
<li>The language code "und" is mapped to language "".
<li>The language codes "he", "yi", and "id" are mapped to "iw", "ji", and "in" respectively. (This is the same canonicalization that's done in Locale's constructors.)
<li>The portion of a private use subtag prefixed by "lvariant", if any, is removed and appended to the variant field in the result locale (without case normalization). If it is then empty, the private use subtag is discarded:
<pre> Locale loc; loc = Locale.forLanguageTag("en-US-x-lvariant-POSIX"); loc.getVariant(); returns "POSIX" loc.getExtension('x'); returns null
loc = Locale.forLanguageTag("de-POSIX-x-URP-lvariant-Abc-Def"); loc.getVariant(); returns "POSIX_Abc_Def" loc.getExtension('x'); returns "urp" </pre>
<li>When the languageTag argument contains an extlang subtag, the first such subtag is used as the language, and the primary language subtag and other extlang subtags are ignored:
<pre> Locale.forLanguageTag("ar-aao").getLanguage(); returns "aao" Locale.forLanguageTag("en-abc-def-us").toString(); returns "abc_US" </pre>
<li>Case is normalized except for variant tags, which are left unchanged. Language is normalized to lower case, script to title case, country to upper case, and extensions to lower case.
<li>If, after processing, the locale would exactly match either ja_JP_JP or th_TH_TH with no extensions, the appropriate extensions are added as though the constructor had been called:
<pre> Locale.forLanguageTag("ja-JP-x-lvariant-JP").toLanguageTag(); returns "ja-JP-u-ca-japanese-x-lvariant-JP" Locale.forLanguageTag("th-TH-x-lvariant-TH").toLanguageTag(); returns "th-TH-u-nu-thai-x-lvariant-TH" <pre></ul>
<p>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.
<p>Grandfathered tags with canonical replacements are as follows:
<table> <tbody align="center"> <tr><th>grandfathered tag</th><th>&nbsp;</th><th>modern replacement</th></tr> <tr><td>art-lojban</td><td>&nbsp;</td><td>jbo</td></tr> <tr><td>i-ami</td><td>&nbsp;</td><td>ami</td></tr> <tr><td>i-bnn</td><td>&nbsp;</td><td>bnn</td></tr> <tr><td>i-hak</td><td>&nbsp;</td><td>hak</td></tr> <tr><td>i-klingon</td><td>&nbsp;</td><td>tlh</td></tr> <tr><td>i-lux</td><td>&nbsp;</td><td>lb</td></tr> <tr><td>i-navajo</td><td>&nbsp;</td><td>nv</td></tr> <tr><td>i-pwn</td><td>&nbsp;</td><td>pwn</td></tr> <tr><td>i-tao</td><td>&nbsp;</td><td>tao</td></tr> <tr><td>i-tay</td><td>&nbsp;</td><td>tay</td></tr> <tr><td>i-tsu</td><td>&nbsp;</td><td>tsu</td></tr> <tr><td>no-bok</td><td>&nbsp;</td><td>nb</td></tr> <tr><td>no-nyn</td><td>&nbsp;</td><td>nn</td></tr> <tr><td>sgn-BE-FR</td><td>&nbsp;</td><td>sfb</td></tr> <tr><td>sgn-BE-NL</td><td>&nbsp;</td><td>vgt</td></tr> <tr><td>sgn-CH-DE</td><td>&nbsp;</td><td>sgg</td></tr> <tr><td>zh-guoyu</td><td>&nbsp;</td><td>cmn</td></tr> <tr><td>zh-hakka</td><td>&nbsp;</td><td>hak</td></tr> <tr><td>zh-min-nan</td><td>&nbsp;</td><td>nan</td></tr> <tr><td>zh-xiang</td><td>&nbsp;</td><td>hsn</td></tr> </tbody> </table>
<p>Grandfathered tags with no modern replacement will be converted as follows:
<table> <tbody align="center"> <tr><th>grandfathered tag</th><th>&nbsp;</th><th>converts to</th></tr> <tr><td>cel-gaulish</td><td>&nbsp;</td><td>xtg-x-cel-gaulish</td></tr> <tr><td>en-GB-oed</td><td>&nbsp;</td><td>en-GB-x-oed</td></tr> <tr><td>i-default</td><td>&nbsp;</td><td>en-x-i-default</td></tr> <tr><td>i-enochian</td><td>&nbsp;</td><td>und-x-i-enochian</td></tr> <tr><td>i-mingo</td><td>&nbsp;</td><td>see-x-i-mingo</td></tr> <tr><td>zh-min</td><td>&nbsp;</td><td>nan-x-zh-min</td></tr> </tbody> </table>
<p>For a list of all grandfathered tags, see the IANA Language Subtag Registry (search for "Type: grandfathered").
<p><b>Note</b>: there is no guarantee that
toLanguageTag
and
forLanguageTag
will round-trip.
param languageTag the language tag return The locale that best represents the language tag. @throws NullPointerException if
languageTag
is
null
@see #toLanguageTag() @see java.util.Locale.Builder#setLanguageTag(String) @since 1.7
static function getAvailableLocales() : NativeArray<Locale>Returns an array of all installed locales. The returned array represents the union of locales supported by the Java runtime environment and by installed {@link java.util.spi.LocaleServiceProvider LocaleServiceProvider} implementations. It must contain at least a
Locale
instance equal to {@link java.util.Locale#US Locale.US}.
@return An array of installed locales.
static function getDefault() : LocaleGets the current value of the default locale for this instance of the Java Virtual Machine. <p> 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 {@link #setDefault(java.util.Locale) setDefault} method.
@return the default locale for this instance of the Java Virtual Machine
static function getISOCountries() : NativeArray<String>Returns a list of all 2-letter country codes defined in ISO 3166. Can be used to create Locales. <p> <b>Note:</b> 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.
static function getISOLanguages() : NativeArray<String>Returns a list of all 2-letter language codes defined in ISO 639. Can be used to create Locales. <p> <b>Note:</b> <ul> <li>ISO 639 is not a stable standard&mdash; some languages' codes have changed. The list this function returns includes both the new and the old codes for the languages whose codes have changed. <li>The
Locale
class also supports language codes up to 8 characters in length. Therefore, the list returned by this method does not contain ALL valid codes that can be used to create Locales. </ul>
static function setDefault( param1 : Locale ) : VoidSets the default locale for this instance of the Java Virtual Machine. This does not affect the host locale. <p> If there is a security manager, its
checkPermission
method is called with a
PropertyPermission("user.language", "write")
permission before the default locale is changed. <p> 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. <p> 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. <p> By setting the default locale with this method, all of the default locales for each Category are also set to the specified default locale.
@throws SecurityException if a security manager exists and its
checkPermission
method doesn't allow the operation. @throws NullPointerException if
newLocale
is null param newLocale the new default locale see SecurityManager#checkPermission @see java.util.PropertyPermission
version #19104, modified 2013-05-08 10:59:23 by api
0 comment