| Method from java.util.Locale Detail: |
|---|
 public Object clone() {
try {
Locale that = (Locale)super.clone();
return that;
} catch (CloneNotSupportedException e) {
throw new InternalError();
}
}
|
public boolean equals(Object obj) {
if (this == obj) // quick check
return true;
if (!(obj instanceof Locale))
return false;
Locale other = (Locale) obj;
return language == other.language
&& country == other.country
&& variant == other.variant;
} Returns true if this Locale is equal to another object. A Locale is
deemed equal to another Locale with identical language, country,
and variant, and unequal to all other objects. |
public static Locale[] getAvailableLocales() {
return LocaleServiceProviderPool.getAllAvailableLocales();
} 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 . |
public String getCountry() {
return country;
} 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 Locale getDefault() {
// do not synchronize this method - see 4071298
// it's OK if more than one default locale happens to be created
if (defaultLocale == null) {
String language, region, country, variant;
language = AccessController.doPrivileged(
new GetPropertyAction("user.language", "en"));
// for compatibility, check for old user.region property
region = AccessController.doPrivileged(
new GetPropertyAction("user.region"));
if (region != null) {
// region can be of form country, country_variant, or _variant
int i = region.indexOf('_");
if (i >= 0) {
country = region.substring(0, i);
variant = region.substring(i + 1);
} else {
country = region;
variant = "";
}
} else {
country = AccessController.doPrivileged(
new GetPropertyAction("user.country", ""));
variant = AccessController.doPrivileged(
new GetPropertyAction("user.variant", ""));
}
defaultLocale = getInstance(language, country, variant);
}
return defaultLocale;
} 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. |
public final String getDisplayCountry() {
return getDisplayCountry(getDefault());
} 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. |
public String getDisplayCountry(Locale inLocale) {
return getDisplayString(country, inLocale, DISPLAY_COUNTRY);
} 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. |
public final String getDisplayLanguage() {
return getDisplayLanguage(getDefault());
} 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. |
public String getDisplayLanguage(Locale inLocale) {
return getDisplayString(language, inLocale, DISPLAY_LANGUAGE);
} 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. |
public final String getDisplayName() {
return getDisplayName(getDefault());
} 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 (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. |
public String getDisplayName(Locale inLocale) {
OpenListResourceBundle bundle = LocaleData.getLocaleNames(inLocale);
String languageName = getDisplayLanguage(inLocale);
String countryName = getDisplayCountry(inLocale);
String[] variantNames = getDisplayVariantArray(bundle, inLocale);
// Get the localized patterns for formatting a display name.
String displayNamePattern = null;
String listPattern = null;
String listCompositionPattern = null;
try {
displayNamePattern = bundle.getString("DisplayNamePattern");
listPattern = bundle.getString("ListPattern");
listCompositionPattern = bundle.getString("ListCompositionPattern");
} catch (MissingResourceException e) {
}
// The display name consists of a main name, followed by qualifiers.
// Typically, the format is "MainName (Qualifier, Qualifier)" but this
// depends on what pattern is stored in the display locale.
String mainName = null;
String[] qualifierNames = null;
// The main name is the language, or if there is no language, the country.
// If there is neither language nor country (an anomalous situation) then
// the display name is simply the variant's display name.
if (languageName.length() != 0) {
mainName = languageName;
if (countryName.length() != 0) {
qualifierNames = new String[variantNames.length + 1];
System.arraycopy(variantNames, 0, qualifierNames, 1, variantNames.length);
qualifierNames[0] = countryName;
}
else qualifierNames = variantNames;
}
else if (countryName.length() != 0) {
mainName = countryName;
qualifierNames = variantNames;
}
else {
return formatList(variantNames, listPattern, listCompositionPattern);
}
// Create an array whose first element is the number of remaining
// elements. This serves as a selector into a ChoiceFormat pattern from
// the resource. The second and third elements are the main name and
// the qualifier; if there are no qualifiers, the third element is
// unused by the format pattern.
Object[] displayNames = {
new Integer(qualifierNames.length != 0 ? 2 : 1),
mainName,
// We could also just call formatList() and have it handle the empty
// list case, but this is more efficient, and we want it to be
// efficient since all the language-only locales will not have any
// qualifiers.
qualifierNames.length != 0 ? formatList(qualifierNames, listPattern, listCompositionPattern) : null
};
if (displayNamePattern != null) {
return new MessageFormat(displayNamePattern).format(displayNames);
}
else {
// If we cannot get the message format pattern, then we use a simple
// hard-coded pattern. This should not occur in practice unless the
// installation is missing some core files (FormatData etc.).
StringBuilder result = new StringBuilder();
result.append((String)displayNames[1]);
if (displayNames.length > 2) {
result.append(" (");
result.append((String)displayNames[2]);
result.append(')");
}
return result.toString();
}
} 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 (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. |
public final String getDisplayVariant() {
return getDisplayVariant(getDefault());
} 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. |
public String getDisplayVariant(Locale inLocale) {
if (variant.length() == 0)
return "";
OpenListResourceBundle bundle = LocaleData.getLocaleNames(inLocale);
String names[] = getDisplayVariantArray(bundle, inLocale);
// Get the localized patterns for formatting a list, and use
// them to format the list.
String listPattern = null;
String listCompositionPattern = null;
try {
listPattern = bundle.getString("ListPattern");
listCompositionPattern = bundle.getString("ListCompositionPattern");
} catch (MissingResourceException e) {
}
return formatList(names, listPattern, listCompositionPattern);
} 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. |
public String getISO3Country() throws MissingResourceException {
String country3 = getISO3Code(country, LocaleISOData.isoCountryTable);
if (country3 == null) {
throw new MissingResourceException("Couldn't find 3-letter country code for "
+ country, "FormatData_" + toString(), "ShortCountry");
}
return country3;
} Returns a three-letter abbreviation for this locale's country. If the locale
doesn't specify a country, this will be the empty string. Otherwise, this will
be an uppercase ISO 3166 3-letter country code.
The ISO 3166-2 country codes can be found on-line at
http://www.davros.org/misc/iso3166.txt. |
public String getISO3Language() throws MissingResourceException {
String language3 = getISO3Code(language, LocaleISOData.isoLanguageTable);
if (language3 == null) {
throw new MissingResourceException("Couldn't find 3-letter language code for "
+ language, "FormatData_" + toString(), "ShortLanguage");
}
return language3;
} Returns a three-letter abbreviation for this locale's language. If the locale
doesn't specify a language, this will be the empty string. Otherwise, this will
be a lowercase ISO 639-2/T language code.
The ISO 639-2 language codes can be found on-line at
http://www.loc.gov/standards/iso639-2/englangn.html. |
public static String[] getISOCountries() {
if (isoCountries == null) {
isoCountries = getISO2Table(LocaleISOData.isoCountryTable);
}
String[] result = new String[isoCountries.length];
System.arraycopy(isoCountries, 0, result, 0, isoCountries.length);
return result;
} Returns a list of all 2-letter country codes defined in ISO 3166.
Can be used to create Locales. |
public static String[] getISOLanguages() {
if (isoLanguages == null) {
isoLanguages = getISO2Table(LocaleISOData.isoLanguageTable);
}
String[] result = new String[isoLanguages.length];
System.arraycopy(isoLanguages, 0, result, 0, isoLanguages.length);
return result;
} 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.] |
static Locale getInstance(String language,
String country,
String variant) {
if (language== null || country == null || variant == null) {
throw new NullPointerException();
}
StringBuilder sb = new StringBuilder();
sb.append(language).append('_").append(country).append('_").append(variant);
String key = sb.toString();
Locale locale = cache.get(key);
if (locale == null) {
locale = new Locale(language, country, variant);
Locale l = cache.putIfAbsent(key, locale);
if (l != null) {
locale = l;
}
}
return locale;
} Returns a Locale constructed from the given
language, country and
variant. If the same Locale instance
is available in the cache, then that instance is
returned. Otherwise, a new Locale instance is
created and cached. |
public String getLanguage() {
return language;
} Returns the language code for this locale, which will either be the empty string
or a lowercase ISO 639 code.
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()))
... |
public String getVariant() {
return variant;
} Returns the variant code for this locale. |
public int hashCode() {
int hc = hashCodeValue;
if (hc == 0) {
hc = (language.hashCode() < < 8) ^ country.hashCode() ^ (variant.hashCode() < < 4);
hashCodeValue = hc;
}
return hc;
} Override hashCode.
Since Locales are often used in hashtables, caches the value
for speed. |
public static synchronized void setDefault(Locale newLocale) {
if (newLocale == null)
throw new NullPointerException("Can't set default locale to NULL");
SecurityManager sm = System.getSecurityManager();
if (sm != null) sm.checkPermission(new PropertyPermission
("user.language", "write"));
defaultLocale = 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. |
public final String toString() {
boolean l = language.length() != 0;
boolean c = country.length() != 0;
boolean v = variant.length() != 0;
StringBuilder result = new StringBuilder(language);
if (c||(l&&v)) {
result.append('_").append(country); // This may just append '_'
}
if (v&&(l||c)) {
result.append('_").append(variant);
}
return result.toString();
} Getter for the programmatic name of the entire locale,
with the language, country and variant separated by underbars.
Language is always lower case, and country is always upper case.
If the language is missing, the string will begin with an underbar.
If both the language and country fields are missing, this function
will return the empty string, even if the variant 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" |
java.util.Locale
Save This Page