Class LocaleUtils
Locale.
 This class tries to handle null input gracefully.
 An exception will not be thrown for a null input.
 Each method documents its behavior in more detail.
- Since:
- 2.2
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionObtains an unmodifiable list of installed locales.Obtains an unmodifiable set of installed locales.countriesByLanguage(String languageCode) Obtains the list of countries supported for a given language.static booleanisAvailableLocale(Locale locale) Checks if the locale specified is in the set of available locales.static booleanisLanguageUndetermined(Locale locale) Tests whether a Locale's language is undetermined.languagesByCountry(String countryCode) Obtains the list of languages supported for a given country.localeLookupList(Locale locale) Obtains the list of locales to search through when performing a locale search.localeLookupList(Locale locale, Locale defaultLocale) Obtains the list of locales to search through when performing a locale search.static LocaleConverts a String to a Locale.static LocaleReturns the given locale if non-null, otherwiseLocale.getDefault().
- 
Constructor Details- 
LocaleUtilsDeprecated.TODO Make private in 4.0.LocaleUtilsinstances should NOT be constructed in standard programming. Instead, the class should be used asLocaleUtils.toLocale("en_GB");.This constructor is public to permit tools that require a JavaBean instance to operate. 
 
- 
- 
Method Details- 
availableLocaleListObtains an unmodifiable list of installed locales.This method is a wrapper around Locale.getAvailableLocales(). It is more efficient, as the JDK method must create a new array each time it is called.- Returns:
- the unmodifiable list of available locales
 
- 
availableLocaleSetObtains an unmodifiable set of installed locales.This method is a wrapper around Locale.getAvailableLocales(). It is more efficient, as the JDK method must create a new array each time it is called.- Returns:
- the unmodifiable set of available locales
 
- 
countriesByLanguageObtains the list of countries supported for a given language.This method takes a language code and searches to find the countries available for that language. Variant locales are removed. - Parameters:
- languageCode- the 2 letter language code, null returns empty
- Returns:
- an unmodifiable List of Locale objects, not null
 
- 
isAvailableLocaleChecks if the locale specified is in the set of available locales.- Parameters:
- locale- the Locale object to check if it is available
- Returns:
- true if the locale is a known locale
 
- 
isLanguageUndeterminedTests whether a Locale's language is undetermined.A Locale's language tag is undetermined if it's value is "und". If a language is empty, or not well-formed (for example, "a" or"e2"), it will be equal to"und".- Parameters:
- locale- the locale to test.
- Returns:
- whether a Locale's language is undetermined.
- Since:
- 3.14.0
- See Also:
 
- 
languagesByCountryObtains the list of languages supported for a given country.This method takes a country code and searches to find the languages available for that country. Variant locales are removed. - Parameters:
- countryCode- the 2-letter country code, null returns empty
- Returns:
- an unmodifiable List of Locale objects, not null
 
- 
localeLookupListObtains the list of locales to search through when performing a locale search.localeLookupList(Locale("fr", "CA", "xxx")) = [Locale("fr", "CA", "xxx"), Locale("fr", "CA"), Locale("fr")]- Parameters:
- locale- the locale to start from
- Returns:
- the unmodifiable list of Locale objects, 0 being locale, not null
 
- 
localeLookupListObtains the list of locales to search through when performing a locale search.localeLookupList(Locale("fr", "CA", "xxx"), Locale("en")) = [Locale("fr", "CA", "xxx"), Locale("fr", "CA"), Locale("fr"), Locale("en"]The result list begins with the most specific locale, then the next more general and so on, finishing with the default locale. The list will never contain the same locale twice. - Parameters:
- locale- the locale to start from, null returns empty list
- defaultLocale- the default locale to use if no other is found
- Returns:
- the unmodifiable list of Locale objects, 0 being locale, not null
 
- 
toLocaleReturns the given locale if non-null, otherwiseLocale.getDefault().- Parameters:
- locale- a locale or- null.
- Returns:
- the given locale if non-null, otherwiseLocale.getDefault().
- Since:
- 3.12.0
 
- 
toLocaleConverts a String to a Locale.This method takes the string format of a locale and creates the locale object from it. LocaleUtils.toLocale("") = new Locale("", "") LocaleUtils.toLocale("en") = new Locale("en", "") LocaleUtils.toLocale("en_GB") = new Locale("en", "GB") LocaleUtils.toLocale("en-GB") = new Locale("en", "GB") LocaleUtils.toLocale("en_001") = new Locale("en", "001") LocaleUtils.toLocale("en_GB_xxx") = new Locale("en", "GB", "xxx") (#)(#) The behavior of the JDK variant constructor changed between JDK1.3 and JDK1.4. In JDK1.3, the constructor upper cases the variant, in JDK1.4, it doesn't. Thus, the result from getVariant() may vary depending on your JDK. This method validates the input strictly. The language code must be lowercase. The country code must be uppercase. The separator must be an underscore or a dash. The length must be correct. - Parameters:
- str- the locale String to convert, null returns null
- Returns:
- a Locale, null if null input
- Throws:
- IllegalArgumentException- if the string is an invalid format
- See Also:
 
 
-