| java.lang.Object
 com.ibm.icu.util.ULocale
| ULocale | | final public class ULocale implements Serializable(Code) | | A class analogous to
java.util.Locale that provides additional
support for ICU protocol. In ICU 3.0 this class is enhanced to support
RFC 3066 language identifiers.
Many classes and services in ICU follow a factory idiom, in
which a factory method or object responds to a client request with
an object. The request includes a locale (the requested
locale), and the returned object is constructed using data for that
locale. The system may lack data for the requested locale, in
which case the locale fallback mechanism will be invoked until a
populated locale is found (the valid locale). Furthermore,
even when a populated locale is found (the valid locale),
further fallback may be required to reach a locale containing the
specific data required by the service (the actual locale).
ULocale performs 'normalization' and 'canonicalization' of locale ids.
Normalization 'cleans up' ICU locale ids as follows:
- language, script, country, variant, and keywords are properly cased
(lower, title, upper, upper, and lower case respectively)
- hyphens used as separators are converted to underscores
- three-letter language and country ids are converted to two-letter
equivalents where available
- surrounding spaces are removed from keywords and values
- if there are multiple keywords, they are put in sorted order
Canonicalization additionally performs the following:
- POSIX ids are converted to ICU format IDs
- 'grandfathered' 3066 ids are converted to ICU standard form
- 'PREEURO' and 'EURO' variants are converted to currency keyword form, with the currency
id appropriate to the country of the locale (for PREEURO) or EUR (for EURO).
All ULocale constructors automatically normalize the locale id. To handle
POSIX ids, canonicalize can be called to convert the id
to canonical form, or the canonicalInstance factory method
can be called.
This class provides selectors
ULocale.VALID_LOCALE and
ULocale.ACTUAL_LOCALE intended for use in methods named
getLocale(). These methods exist in several ICU classes,
including
com.ibm.icu.util.Calendar ,
com.ibm.icu.util.Currency ,
com.ibm.icu.text.UFormat ,
com.ibm.icu.text.BreakIterator ,
com.ibm.icu.text.Collator ,
com.ibm.icu.text.DateFormatSymbols , and
com.ibm.icu.text.DecimalFormatSymbols and their subclasses, if
any. Once an object of one of these classes has been created,
getLocale() may be called on it to determine the valid and
actual locale arrived at during the object's construction.
Note: The getLocale() method will be implemented in ICU
3.0; ICU 2.8 contains a partial preview implementation. The
actual locale is returned correctly, but the valid
locale is not, in most cases.
See Also: java.util.Locale
author:
weiv
author:
Alan Liu
author:
Ram Viswanadha |
| Inner Class :final public static class Type | |
| Field Summary | |
| public static Type | ACTUAL_LOCALE
Selector for getLocale() indicating the locale of the
resource containing the data. | | final public static ULocale | CANADA
Useful constant for country/region. | | final public static ULocale | CANADA_FRENCH
Useful constant for country/region. | | final public static ULocale | CHINA
Useful constant for country/region. | | final public static ULocale | CHINESE
Useful constant for language. | | final public static ULocale | ENGLISH
Useful constant for language. | | final public static ULocale | FRANCE
Useful constant for country/region. | | final public static ULocale | FRENCH
Useful constant for language. | | final public static ULocale | GERMAN
Useful constant for language. | | final public static ULocale | GERMANY
Useful constant for country/region. | | final public static ULocale | ITALIAN
Useful constant for language. | | final public static ULocale | ITALY
Useful constant for country/region. | | final public static ULocale | JAPAN
Useful constant for country/region. | | final public static ULocale | JAPANESE
Useful constant for language. | | final public static ULocale | KOREA
Useful constant for country/region. | | final public static ULocale | KOREAN
Useful constant for language. | | final public static ULocale | PRC
Useful constant for country/region. | | final public static ULocale | ROOT
The root ULocale. | | final public static ULocale | SIMPLIFIED_CHINESE
Useful constant for language. | | final public static ULocale | TAIWAN
Useful constant for country/region. | | final public static ULocale | TRADITIONAL_CHINESE
Useful constant for language. | | final public static ULocale | UK
Useful constant for country/region. | | final public static ULocale | US
Useful constant for country/region. | | public static Type | VALID_LOCALE
Selector for getLocale() indicating the most specific
locale for which any data exists. |
| Constructor Summary | |
| public | ULocale(String localeID)
Construct a ULocale from a RFC 3066 locale ID. | | public | ULocale(String a, String b)
Convenience overload of ULocale(String, String, String) for
compatibility with java.util.Locale. | | public | ULocale(String a, String b, String c)
Construct a ULocale from a localeID constructed from the three 'fields' a, b, and c. |
| Method Summary | |
| public static ULocale | acceptLanguage(String acceptLanguageList, ULocale[] availableLocales, boolean[] fallback)
Based on a HTTP formatted list of acceptable locales, determine an available locale for the user.
NullPointerException is thrown if acceptLanguageList or availableLocales is
null. | | public static ULocale | acceptLanguage(ULocale[] acceptLanguageList, ULocale[] availableLocales, boolean[] fallback)
Based on a list of acceptable locales, determine an available locale for the user.
NullPointerException is thrown if acceptLanguageList or availableLocales is
null. | | public static ULocale | acceptLanguage(String acceptLanguageList, boolean[] fallback)
Based on a HTTP formatted list of acceptable locales, determine an available locale for the user.
NullPointerException is thrown if acceptLanguageList or availableLocales is
null. | | public static ULocale | acceptLanguage(ULocale[] acceptLanguageList, boolean[] fallback)
Based on an ordered array of acceptable locales, determine an available locale for the user.
NullPointerException is thrown if acceptLanguageList or availableLocales is
null. | | public static String | canonicalize(String localeID)
Returns the canonical name for the specified locale ID. | | public Object | clone()
This is for compatibility with Locale-- in actuality, since ULocale is
immutable, there is no reason to clone it, so this API returns 'this'. | | public static ULocale | createCanonical(String nonCanonicalID)
Create a ULocale from the id by first canonicalizing the id. | | public boolean | equals(Object obj)
Returns true if the other object is another ULocale with the
same full name, or is a String localeID that matches the full name. | | public static ULocale | forLocale(Locale loc)
Return a ULocale object for a
java.util.Locale . | | public static ULocale[] | getAvailableLocales()
Returns a list of all installed locales. | | public String | getBaseName()
Returns the (normalized) base name for this locale. | | public static String | getBaseName(String localeID)
Returns the (normalized) base name for the specified locale. | | public String | getCountry()
Returns the country/region code for this locale, which will either be the empty string
or an uppercase ISO 3166 2-letter code. | | public static String | getCountry(String localeID)
Returns the country/region code for this locale, which will either be the empty string
or an uppercase ISO 3166 2-letter code. | | static String | getCurrentCountryID(String oldID)
| | static String | getCurrentLanguageID(String oldID)
| | public static ULocale | getDefault()
Returns the current default ULocale. | | public String | getDisplayCountry()
Returns this locale's country localized for display in the default locale. | | public String | getDisplayCountry(ULocale displayLocale)
Returns this locale's country localized for display in the provided locale.
Parameters:
displayLocale - the locale in which to display the name. | | public static String | getDisplayCountry(String localeID, String displayLocaleID)
Returns a locale's country localized for display in the provided locale.
This is a cover for the ICU4C API.
Parameters:
localeID - the id of the locale whose country will be displayed
Parameters:
displayLocaleID - the id of the locale in which to display the name. | | public static String | getDisplayCountry(String localeID, ULocale displayLocale)
Returns a locale's country localized for display in the provided locale.
This is a cover for the ICU4C API.
Parameters:
localeID - the id of the locale whose country will be displayed.
Parameters:
displayLocale - the locale in which to display the name. | | public static String | getDisplayKeyword(String keyword)
Returns a keyword localized for display in the default locale.
Parameters:
keyword - the keyword to be displayed. | | public static String | getDisplayKeyword(String keyword, String displayLocaleID)
Returns a keyword localized for display in the specified locale.
Parameters:
keyword - the keyword to be displayed.
Parameters:
displayLocaleID - the id of the locale in which to display the keyword. | | public static String | getDisplayKeyword(String keyword, ULocale displayLocale)
Returns a keyword localized for display in the specified locale.
Parameters:
keyword - the keyword to be displayed.
Parameters:
displayLocale - the locale in which to display the keyword. | | public String | getDisplayKeywordValue(String keyword)
Returns a keyword value localized for display in the default locale.
Parameters:
keyword - the keyword whose value is to be displayed. | | public String | getDisplayKeywordValue(String keyword, ULocale displayLocale)
Returns a keyword value localized for display in the specified locale.
Parameters:
keyword - the keyword whose value is to be displayed.
Parameters:
displayLocale - the locale in which to display the value. | | public static String | getDisplayKeywordValue(String localeID, String keyword, String displayLocaleID)
Returns a keyword value localized for display in the specified locale.
This is a cover for the ICU4C API.
Parameters:
localeID - the id of the locale whose keyword value is to be displayed.
Parameters:
keyword - the keyword whose value is to be displayed.
Parameters:
displayLocaleID - the id of the locale in which to display the value. | | public static String | getDisplayKeywordValue(String localeID, String keyword, ULocale displayLocale)
Returns a keyword value localized for display in the specified locale.
This is a cover for the ICU4C API.
Parameters:
localeID - the id of the locale whose keyword value is to be displayed.
Parameters:
keyword - the keyword whose value is to be displayed.
Parameters:
displayLocale - the id of the locale in which to display the value. | | public String | getDisplayLanguage()
Returns this locale's language localized for display in the default locale. | | public String | getDisplayLanguage(ULocale displayLocale)
Returns this locale's language localized for display in the provided locale.
Parameters:
displayLocale - the locale in which to display the name. | | public static String | getDisplayLanguage(String localeID, String displayLocaleID)
Returns a locale's language localized for display in the provided locale.
This is a cover for the ICU4C API.
Parameters:
localeID - the id of the locale whose language will be displayed
Parameters:
displayLocaleID - the id of the locale in which to display the name. | | public static String | getDisplayLanguage(String localeID, ULocale displayLocale)
Returns a locale's language localized for display in the provided locale.
This is a cover for the ICU4C API.
Parameters:
localeID - the id of the locale whose language will be displayed.
Parameters:
displayLocale - the locale in which to display the name. | | public String | getDisplayName()
Returns this locale name localized for display in the default locale. | | public String | getDisplayName(ULocale displayLocale)
Returns this locale name localized for display in the provided locale.
Parameters:
displayLocale - the locale in which to display the locale name. | | public static String | getDisplayName(String localeID, String displayLocaleID)
Returns the locale ID localized for display in the provided locale.
This is a cover for the ICU4C API.
Parameters:
localeID - the locale whose name is to be displayed.
Parameters:
displayLocaleID - the id of the locale in which to display the locale name. | | public static String | getDisplayName(String localeID, ULocale displayLocale)
Returns the locale ID localized for display in the provided locale.
This is a cover for the ICU4C API.
Parameters:
localeID - the locale whose name is to be displayed.
Parameters:
displayLocale - the locale in which to display the locale name. | | public String | getDisplayScript()
Returns this locale's script localized for display in the default locale. | | public String | getDisplayScript(ULocale displayLocale)
Returns this locale's script localized for display in the provided locale.
Parameters:
displayLocale - the locale in which to display the name. | | public static String | getDisplayScript(String localeID, String displayLocaleID)
Returns a locale's script localized for display in the provided locale.
This is a cover for the ICU4C API.
Parameters:
localeID - the id of the locale whose script will be displayed
Parameters:
displayLocaleID - the id of the locale in which to display the name. | | public static String | getDisplayScript(String localeID, ULocale displayLocale)
Returns a locale's script localized for display in the provided locale.
Parameters:
localeID - the id of the locale whose script will be displayed.
Parameters:
displayLocale - the locale in which to display the name. | | public String | getDisplayVariant()
Returns this locale's variant localized for display in the default locale. | | public String | getDisplayVariant(ULocale displayLocale)
Returns this locale's variant localized for display in the provided locale.
Parameters:
displayLocale - the locale in which to display the name. | | public static String | getDisplayVariant(String localeID, String displayLocaleID)
Returns a locale's variant localized for display in the provided locale.
This is a cover for the ICU4C API.
Parameters:
localeID - the id of the locale whose variant will be displayed
Parameters:
displayLocaleID - the id of the locale in which to display the name. | | public static String | getDisplayVariant(String localeID, ULocale displayLocale)
Returns a locale's variant localized for display in the provided locale.
This is a cover for the ICU4C API.
Parameters:
localeID - the id of the locale whose variant will be displayed.
Parameters:
displayLocale - the locale in which to display the name. | | public static String | getFallback(String localeID)
Returns the fallback locale for the specified locale, which might be the empty string. | | public ULocale | getFallback()
Returns the fallback locale for this locale. | | public String | getISO3Country()
Returns a three-letter abbreviation for this locale's country/region. | | public static String | getISO3Country(String localeID)
Returns a three-letter abbreviation for this locale's country/region. | | public String | getISO3Language()
Returns a three-letter abbreviation for this locale's language. | | public static String | getISO3Language(String localeID)
Returns a three-letter abbreviation for this locale's language. | | public static String[] | getISOCountries()
Returns a list of all 2-letter country codes defined in ISO 3166. | | public static String[] | getISOLanguages()
Returns a list of all 2-letter language codes defined in ISO 639. | | public String | getKeywordValue(String keywordName)
Returns the value for a keyword in this locale. | | public static String | getKeywordValue(String localeID, String keywordName)
Returns the value for a keyword in the specified locale. | | public Iterator | getKeywords()
Returns an iterator over keywords for this locale. | | public static Iterator | getKeywords(String localeID)
Returns an iterator over keywords for the specified locale. | | public String | getLanguage()
Returns the language code for this locale, which will either be the empty string
or a lowercase ISO 639 code. | | public static String | getLanguage(String localeID)
Returns the language code for the locale ID,
which will either be the empty string
or a lowercase ISO 639 code. | | public String | getName()
Returns the (normalized) full name for this locale. | | public static String | getName(String localeID)
Returns the (normalized) full name for the specified locale. | | public String | getScript()
Returns the script code for this locale, which might be the empty string. | | public static String | getScript(String localeID)
Returns the script code for the specified locale, which might be the empty string. | | public String | getVariant()
Returns the variant code for this locale, which might be the empty string. | | public static String | getVariant(String localeID)
Returns the variant code for the specified locale, which might be the empty string. | | public int | hashCode()
Returns the hashCode. | | public static synchronized void | setDefault(ULocale newLocale)
Sets the default ULocale. | | public ULocale | setKeywordValue(String keyword, String value)
Given a keyword and a value, return a new locale with an updated
keyword and value. | | public static String | setKeywordValue(String localeID, String keyword, String value)
Given a locale id, a keyword, and a value, return a new locale id with an updated
keyword and value. | | public Locale | toLocale()
Convert this ULocale object to a
java.util.Locale . | | public String | toString()
Returns a string representation of this object. |
| ACTUAL_LOCALE | | public static Type ACTUAL_LOCALE(Code) | | Selector for getLocale() indicating the locale of the
resource containing the data. This is always at or above the
valid locale. If the valid locale does not contain the
specific data being requested, then the actual locale will be
above the valid locale. If the object was not constructed from
locale data, then the valid locale is null.
|
| CANADA | | final public static ULocale CANADA(Code) | | Useful constant for country/region.
|
| CANADA_FRENCH | | final public static ULocale CANADA_FRENCH(Code) | | Useful constant for country/region.
|
| CHINA | | final public static ULocale CHINA(Code) | | Useful constant for country/region.
|
| CHINESE | | final public static ULocale CHINESE(Code) | | Useful constant for language.
|
| ENGLISH | | final public static ULocale ENGLISH(Code) | | Useful constant for language.
|
| FRANCE | | final public static ULocale FRANCE(Code) | | Useful constant for country/region.
|
| FRENCH | | final public static ULocale FRENCH(Code) | | Useful constant for language.
|
| GERMAN | | final public static ULocale GERMAN(Code) | | Useful constant for language.
|
| GERMANY | | final public static ULocale GERMANY(Code) | | Useful constant for country/region.
|
| ITALIAN | | final public static ULocale ITALIAN(Code) | | Useful constant for language.
|
| ITALY | | final public static ULocale ITALY(Code) | | Useful constant for country/region.
|
| JAPAN | | final public static ULocale JAPAN(Code) | | Useful constant for country/region.
|
| JAPANESE | | final public static ULocale JAPANESE(Code) | | Useful constant for language.
|
| KOREA | | final public static ULocale KOREA(Code) | | Useful constant for country/region.
|
| KOREAN | | final public static ULocale KOREAN(Code) | | Useful constant for language.
|
| PRC | | final public static ULocale PRC(Code) | | Useful constant for country/region.
|
| SIMPLIFIED_CHINESE | | final public static ULocale SIMPLIFIED_CHINESE(Code) | | Useful constant for language.
|
| TAIWAN | | final public static ULocale TAIWAN(Code) | | Useful constant for country/region.
|
| TRADITIONAL_CHINESE | | final public static ULocale TRADITIONAL_CHINESE(Code) | | Useful constant for language.
|
| UK | | final public static ULocale UK(Code) | | Useful constant for country/region.
|
| US | | final public static ULocale US(Code) | | Useful constant for country/region.
|
| VALID_LOCALE | | public static Type VALID_LOCALE(Code) | | Selector for getLocale() indicating the most specific
locale for which any data exists. This is always at or above
the requested locale, and at or below the actual locale. If
the requested locale does not correspond to any resource data,
then the valid locale will be above the requested locale. If
the object was not constructed from locale data, then the
actual locale is null.
Note: The valid locale will be returned correctly in ICU
3.0 or later. In ICU 2.8, it is not returned correctly.
|
| ULocale | | public ULocale(String localeID)(Code) | | Construct a ULocale from a RFC 3066 locale ID. The locale ID consists
of optional language, script, country, and variant fields in that order,
separated by underscores, followed by an optional keyword list. The
script, if present, is four characters long-- this distinguishes it
from a country code, which is two characters long. Other fields
are distinguished by position as indicated by the underscores. The
start of the keyword list is indicated by '@', and consists of one
or more keyword/value pairs separated by commas.
This constructor does not canonicalize the localeID.
Parameters:
localeID - string representation of the locale, e.g:"en_US", "sy_Cyrl_YU", "zh__pinyin", "es_ES@currency=EUR,collation=traditional" |
| ULocale | | public ULocale(String a, String b, String c)(Code) | | Construct a ULocale from a localeID constructed from the three 'fields' a, b, and c. These
fields are concatenated using underscores to form a localeID of
the form a_b_c, which is then handled like the localeID passed
to ULocale(String localeID).
Java locale strings consisting of language, country, and
variant will be handled by this form, since the country code
(being shorter than four letters long) will not be interpreted
as a script code. If a script code is present, the final
argument ('c') will be interpreted as the country code. It is
recommended that this constructor only be used to ease porting,
and that clients instead use the single-argument constructor
when constructing a ULocale from a localeID.
Parameters:
a - first component of the locale id
Parameters:
b - second component of the locale id
Parameters:
c - third component of the locale id
See Also: ULocale.ULocale(String) |
| acceptLanguage | | public static ULocale acceptLanguage(String acceptLanguageList, ULocale[] availableLocales, boolean[] fallback)(Code) | | Based on a HTTP formatted list of acceptable locales, determine an available locale for the user.
NullPointerException is thrown if acceptLanguageList or availableLocales is
null. If fallback is non-null, it will contain true if a fallback locale (one
not in the acceptLanguageList) was returned. The value on entry is ignored.
ULocale will be one of the locales in availableLocales, or the ROOT ULocale if
if a ROOT locale was used as a fallback (because nothing else in
availableLocales matched). No ULocale array element should be null; behavior
is undefined if this is the case.
Parameters:
acceptLanguageList - list in HTTP "Accept-Language:" format of acceptable locales
Parameters:
availableLocales - list of available locales. One of these will be returned.
Parameters:
fallback - if non-null, a 1-element array containing a boolean to be set with the fallback status one of the locales from the availableLocales list, or null if none match |
| acceptLanguage | | public static ULocale acceptLanguage(ULocale[] acceptLanguageList, ULocale[] availableLocales, boolean[] fallback)(Code) | | Based on a list of acceptable locales, determine an available locale for the user.
NullPointerException is thrown if acceptLanguageList or availableLocales is
null. If fallback is non-null, it will contain true if a fallback locale (one
not in the acceptLanguageList) was returned. The value on entry is ignored.
ULocale will be one of the locales in availableLocales, or the ROOT ULocale if
if a ROOT locale was used as a fallback (because nothing else in
availableLocales matched). No ULocale array element should be null; behavior
is undefined if this is the case.
Parameters:
acceptLanguageList - list of acceptable locales
Parameters:
availableLocales - list of available locales. One of these will be returned.
Parameters:
fallback - if non-null, a 1-element array containing a boolean to be set with the fallback status one of the locales from the availableLocales list, or null if none match |
| acceptLanguage | | public static ULocale acceptLanguage(String acceptLanguageList, boolean[] fallback)(Code) | | Based on a HTTP formatted list of acceptable locales, determine an available locale for the user.
NullPointerException is thrown if acceptLanguageList or availableLocales is
null. If fallback is non-null, it will contain true if a fallback locale (one
not in the acceptLanguageList) was returned. The value on entry is ignored.
ULocale will be one of the locales in availableLocales, or the ROOT ULocale if
if a ROOT locale was used as a fallback (because nothing else in
availableLocales matched). No ULocale array element should be null; behavior
is undefined if this is the case.
This function will choose a locale from the ULocale.getAvailableLocales() list as available.
Parameters:
acceptLanguageList - list in HTTP "Accept-Language:" format of acceptable locales
Parameters:
fallback - if non-null, a 1-element array containing a boolean to be set with the fallback status one of the locales from the ULocale.getAvailableLocales() list, or null if none match |
| acceptLanguage | | public static ULocale acceptLanguage(ULocale[] acceptLanguageList, boolean[] fallback)(Code) | | Based on an ordered array of acceptable locales, determine an available locale for the user.
NullPointerException is thrown if acceptLanguageList or availableLocales is
null. If fallback is non-null, it will contain true if a fallback locale (one
not in the acceptLanguageList) was returned. The value on entry is ignored.
ULocale will be one of the locales in availableLocales, or the ROOT ULocale if
if a ROOT locale was used as a fallback (because nothing else in
availableLocales matched). No ULocale array element should be null; behavior
is undefined if this is the case.
This function will choose a locale from the ULocale.getAvailableLocales() list as available.
Parameters:
acceptLanguageList - ordered array of acceptable locales (preferred are listed first)
Parameters:
fallback - if non-null, a 1-element array containing a boolean to be set with the fallback status one of the locales from the ULocale.getAvailableLocales() list, or null if none match |
| canonicalize | | public static String canonicalize(String localeID)(Code) | | Returns the canonical name for the specified locale ID. This is used to convert POSIX
and other grandfathered IDs to standard ICU form.
Parameters:
localeID - the locale id the canonicalized id |
| clone | | public Object clone()(Code) | | This is for compatibility with Locale-- in actuality, since ULocale is
immutable, there is no reason to clone it, so this API returns 'this'.
|
| createCanonical | | public static ULocale createCanonical(String nonCanonicalID)(Code) | | Create a ULocale from the id by first canonicalizing the id.
Parameters:
nonCanonicalID - the locale id to canonicalize the locale created from the canonical version of the ID. |
| equals | | public boolean equals(Object obj)(Code) | | Returns true if the other object is another ULocale with the
same full name, or is a String localeID that matches the full name.
Note that since names are not canonicalized, two ULocales that
function identically might not compare equal.
true if this Locale is equal to the specified object. |
| getAvailableLocales | | public static ULocale[] getAvailableLocales()(Code) | | Returns a list of all installed locales.
|
| getBaseName | | public String getBaseName()(Code) | | Returns the (normalized) base name for this locale.
the base name as a String. |
| getBaseName | | public static String getBaseName(String localeID)(Code) | | Returns the (normalized) base name for the specified locale.
Parameters:
localeID - the locale ID as a string the base name as a String. |
| getCountry | | public String getCountry()(Code) | | Returns the country/region code for this locale, which will either be the empty string
or an uppercase ISO 3166 2-letter code.
See Also: ULocale.getDisplayCountry |
| getCountry | | public static String getCountry(String localeID)(Code) | | Returns the country/region code for this locale, which will either be the empty string
or an uppercase ISO 3166 2-letter code.
Parameters:
localeID -
See Also: ULocale.getDisplayCountry |
| getDefault | | public static ULocale getDefault()(Code) | | Returns the current default ULocale.
|
| getDisplayCountry | | public String getDisplayCountry()(Code) | | Returns this locale's country localized for display in the default locale.
the localized country name. |
| getDisplayCountry | | public String getDisplayCountry(ULocale displayLocale)(Code) | | Returns this locale's country localized for display in the provided locale.
Parameters:
displayLocale - the locale in which to display the name. the localized country name. |
| getDisplayCountry | | public static String getDisplayCountry(String localeID, String displayLocaleID)(Code) | | Returns a locale's country localized for display in the provided locale.
This is a cover for the ICU4C API.
Parameters:
localeID - the id of the locale whose country will be displayed
Parameters:
displayLocaleID - the id of the locale in which to display the name. the localized country name. |
| getDisplayCountry | | public static String getDisplayCountry(String localeID, ULocale displayLocale)(Code) | | Returns a locale's country localized for display in the provided locale.
This is a cover for the ICU4C API.
Parameters:
localeID - the id of the locale whose country will be displayed.
Parameters:
displayLocale - the locale in which to display the name. the localized country name. |
| getDisplayKeyword | | public static String getDisplayKeyword(String keyword)(Code) | | Returns a keyword localized for display in the default locale.
Parameters:
keyword - the keyword to be displayed. the localized keyword name.
See Also: ULocale.getKeywords |
| getDisplayKeyword | | public static String getDisplayKeyword(String keyword, String displayLocaleID)(Code) | | Returns a keyword localized for display in the specified locale.
Parameters:
keyword - the keyword to be displayed.
Parameters:
displayLocaleID - the id of the locale in which to display the keyword. the localized keyword name.
See Also: ULocale.getKeywords |
| getDisplayKeyword | | public static String getDisplayKeyword(String keyword, ULocale displayLocale)(Code) | | Returns a keyword localized for display in the specified locale.
Parameters:
keyword - the keyword to be displayed.
Parameters:
displayLocale - the locale in which to display the keyword. the localized keyword name.
See Also: ULocale.getKeywords |
| getDisplayKeywordValue | | public String getDisplayKeywordValue(String keyword)(Code) | | Returns a keyword value localized for display in the default locale.
Parameters:
keyword - the keyword whose value is to be displayed. the localized value name. |
| getDisplayKeywordValue | | public String getDisplayKeywordValue(String keyword, ULocale displayLocale)(Code) | | Returns a keyword value localized for display in the specified locale.
Parameters:
keyword - the keyword whose value is to be displayed.
Parameters:
displayLocale - the locale in which to display the value. the localized value name. |
| getDisplayKeywordValue | | public static String getDisplayKeywordValue(String localeID, String keyword, String displayLocaleID)(Code) | | Returns a keyword value localized for display in the specified locale.
This is a cover for the ICU4C API.
Parameters:
localeID - the id of the locale whose keyword value is to be displayed.
Parameters:
keyword - the keyword whose value is to be displayed.
Parameters:
displayLocaleID - the id of the locale in which to display the value. the localized value name. |
| getDisplayKeywordValue | | public static String getDisplayKeywordValue(String localeID, String keyword, ULocale displayLocale)(Code) | | Returns a keyword value localized for display in the specified locale.
This is a cover for the ICU4C API.
Parameters:
localeID - the id of the locale whose keyword value is to be displayed.
Parameters:
keyword - the keyword whose value is to be displayed.
Parameters:
displayLocale - the id of the locale in which to display the value. the localized value name. |
| getDisplayLanguage | | public String getDisplayLanguage()(Code) | | Returns this locale's language localized for display in the default locale.
the localized language name. |
| getDisplayLanguage | | public String getDisplayLanguage(ULocale displayLocale)(Code) | | Returns this locale's language localized for display in the provided locale.
Parameters:
displayLocale - the locale in which to display the name. the localized language name. |
| getDisplayLanguage | | public static String getDisplayLanguage(String localeID, String displayLocaleID)(Code) | | Returns a locale's language localized for display in the provided locale.
This is a cover for the ICU4C API.
Parameters:
localeID - the id of the locale whose language will be displayed
Parameters:
displayLocaleID - the id of the locale in which to display the name. the localized language name. |
| getDisplayLanguage | | public static String getDisplayLanguage(String localeID, ULocale displayLocale)(Code) | | Returns a locale's language localized for display in the provided locale.
This is a cover for the ICU4C API.
Parameters:
localeID - the id of the locale whose language will be displayed.
Parameters:
displayLocale - the locale in which to display the name. the localized language name. |
| getDisplayName | | public String getDisplayName()(Code) | | Returns this locale name localized for display in the default locale.
the localized locale name. |
| getDisplayName | | public String getDisplayName(ULocale displayLocale)(Code) | | Returns this locale name localized for display in the provided locale.
Parameters:
displayLocale - the locale in which to display the locale name. the localized locale name. |
| getDisplayName | | public static String getDisplayName(String localeID, String displayLocaleID)(Code) | | Returns the locale ID localized for display in the provided locale.
This is a cover for the ICU4C API.
Parameters:
localeID - the locale whose name is to be displayed.
Parameters:
displayLocaleID - the id of the locale in which to display the locale name. the localized locale name. |
| getDisplayName | | public static String getDisplayName(String localeID, ULocale displayLocale)(Code) | | Returns the locale ID localized for display in the provided locale.
This is a cover for the ICU4C API.
Parameters:
localeID - the locale whose name is to be displayed.
Parameters:
displayLocale - the locale in which to display the locale name. the localized locale name. |
| getDisplayScript | | public String getDisplayScript()(Code) | | Returns this locale's script localized for display in the default locale.
the localized script name. |
| getDisplayScript | | public String getDisplayScript(ULocale displayLocale)(Code) | | Returns this locale's script localized for display in the provided locale.
Parameters:
displayLocale - the locale in which to display the name. the localized script name. |
| getDisplayScript | | public static String getDisplayScript(String localeID, String displayLocaleID)(Code) | | Returns a locale's script localized for display in the provided locale.
This is a cover for the ICU4C API.
Parameters:
localeID - the id of the locale whose script will be displayed
Parameters:
displayLocaleID - the id of the locale in which to display the name. the localized script name. |
| getDisplayScript | | public static String getDisplayScript(String localeID, ULocale displayLocale)(Code) | | Returns a locale's script localized for display in the provided locale.
Parameters:
localeID - the id of the locale whose script will be displayed.
Parameters:
displayLocale - the locale in which to display the name. the localized script name. |
| getDisplayVariant | | public String getDisplayVariant()(Code) | | Returns this locale's variant localized for display in the default locale.
the localized variant name. |
| getDisplayVariant | | public String getDisplayVariant(ULocale displayLocale)(Code) | | Returns this locale's variant localized for display in the provided locale.
Parameters:
displayLocale - the locale in which to display the name. the localized variant name. |
| getDisplayVariant | | public static String getDisplayVariant(String localeID, String displayLocaleID)(Code) | | Returns a locale's variant localized for display in the provided locale.
This is a cover for the ICU4C API.
Parameters:
localeID - the id of the locale whose variant will be displayed
Parameters:
displayLocaleID - the id of the locale in which to display the name. the localized variant name. |
| getDisplayVariant | | public static String getDisplayVariant(String localeID, ULocale displayLocale)(Code) | | Returns a locale's variant localized for display in the provided locale.
This is a cover for the ICU4C API.
Parameters:
localeID - the id of the locale whose variant will be displayed.
Parameters:
displayLocale - the locale in which to display the name. the localized variant name. |
| getFallback | | public static String getFallback(String localeID)(Code) | | Returns the fallback locale for the specified locale, which might be the empty string.
|
| getFallback | | public ULocale getFallback()(Code) | | Returns the fallback locale for this locale. If this locale is root, returns null.
|
| getISO3Country | | public String getISO3Country()(Code) | | Returns a three-letter abbreviation for this locale's country/region. If the locale
doesn't specify a country, returns the empty string. Otherwise, returns
an uppercase ISO 3166 3-letter country code.
exception:
MissingResourceException - Throws MissingResourceException if thethree-letter country abbreviation is not available for this locale. |
| getISO3Country | | public static String getISO3Country(String localeID)(Code) | | Returns a three-letter abbreviation for this locale's country/region. If the locale
doesn't specify a country, returns the empty string. Otherwise, returns
an uppercase ISO 3166 3-letter country code.
exception:
MissingResourceException - Throws MissingResourceException if thethree-letter country abbreviation is not available for this locale. |
| getISO3Language | | public String getISO3Language()(Code) | | Returns a three-letter abbreviation for this locale's language. If the locale
doesn't specify a language, returns the empty string. Otherwise, returns
a lowercase ISO 639-2/T language code.
The ISO 639-2 language codes can be found on-line at
ftp://dkuug.dk/i18n/iso-639-2.txt
exception:
MissingResourceException - Throws MissingResourceException if thethree-letter language abbreviation is not available for this locale. |
| getISO3Language | | public static String getISO3Language(String localeID)(Code) | | Returns a three-letter abbreviation for this locale's language. If the locale
doesn't specify a language, returns the empty string. Otherwise, returns
a lowercase ISO 639-2/T language code.
The ISO 639-2 language codes can be found on-line at
ftp://dkuug.dk/i18n/iso-639-2.txt
exception:
MissingResourceException - Throws MissingResourceException if thethree-letter language abbreviation is not available for this locale. |
| getISOCountries | | public static String[] getISOCountries()(Code) | | Returns a list of all 2-letter country codes defined in ISO 3166.
Can be used to create Locales.
|
| getISOLanguages | | public static String[] getISOLanguages()(Code) | | Returns a list of all 2-letter language codes defined in ISO 639.
Can be used to create Locales.
[NOTE: ISO 639 is not a stable standard-- 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.]
|
| getKeywordValue | | public String getKeywordValue(String keywordName)(Code) | | Returns the value for a keyword in this locale. If the keyword is not defined, returns null.
Parameters:
keywordName - name of the keyword whose value is desired. Case insensitive. the value of the keyword, or null. |
| getKeywordValue | | public static String getKeywordValue(String localeID, String keywordName)(Code) | | Returns the value for a keyword in the specified locale. If the keyword is not defined, returns null.
The locale name does not need to be normalized.
Parameters:
keywordName - name of the keyword whose value is desired. Case insensitive. String the value of the keyword as a string |
| getKeywords | | public Iterator getKeywords()(Code) | | Returns an iterator over keywords for this locale. If there
are no keywords, returns null.
iterator over keywords, or null if there are no keywords. |
| getKeywords | | public static Iterator getKeywords(String localeID)(Code) | | Returns an iterator over keywords for the specified locale. If there
are no keywords, returns null.
an iterator over the keywords in the specified locale, or nullif there are no keywords. |
| getLanguage | | public String getLanguage()(Code) | | Returns the language code for this locale, which will either be the empty string
or a lowercase ISO 639 code.
See Also: ULocale.getDisplayLanguage |
| getName | | public String getName()(Code) | | Returns the (normalized) full name for this locale.
String the full name of the localeID |
| getName | | public static String getName(String localeID)(Code) | | Returns the (normalized) full name for the specified locale.
Parameters:
localeID - the localeID as a string String the full name of the localeID |
| hashCode | | public int hashCode()(Code) | | Returns the hashCode.
|
| setDefault | | public static synchronized void setDefault(ULocale newLocale)(Code) | | Sets the default ULocale. This also sets the default Locale.
If the caller does not have write permission to the
user.language property, a security exception will be thrown,
and the default ULocale will remain unchanged.
Parameters:
newLocale - the new default locale
throws:
SecurityException - if a security manager exists and itscheckPermission method doesn't allow the operation.
throws:
NullPointerException - if newLocale is null
See Also: SecurityManager.checkPermission
See Also: java.util.PropertyPermission |
| setKeywordValue | | public ULocale setKeywordValue(String keyword, String value)(Code) | | Given a keyword and a value, return a new locale with an updated
keyword and value. If keyword is null, this removes all keywords from the locale id.
Otherwise, if the value is null, this removes the value for this keyword from the
locale id. Otherwise, this adds/replaces the value for this keyword in the locale id.
The keyword and value must not be empty.
Parameters:
keyword - the keyword to add/remove, or null to remove all keywords.
Parameters:
value - the value to add/set, or null to remove this particular keyword. the updated locale |
| setKeywordValue | | public static String setKeywordValue(String localeID, String keyword, String value)(Code) | | Given a locale id, a keyword, and a value, return a new locale id with an updated
keyword and value. If keyword is null, this removes all keywords from the locale id.
Otherwise, if the value is null, this removes the value for this keyword from the
locale id. Otherwise, this adds/replaces the value for this keyword in the locale id.
The keyword and value must not be empty.
Parameters:
localeID - the locale id to modify
Parameters:
keyword - the keyword to add/remove, or null to remove all keywords.
Parameters:
value - the value to add/set, or null to remove this particular keyword. the updated locale id |
| toLocale | | public Locale toLocale()(Code) | | Convert this ULocale object to a
java.util.Locale .
a JDK locale that either exactly represents this objector is the closest approximation. |
| toString | | public String toString()(Code) | | Returns a string representation of this object.
|
|
|