Obtains an unmodifiable and sorted 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:List<Locale>

the unmodifiable and sorted list of available locales.

Obtains 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:Set<Locale>

the unmodifiable set of available locales.

Obtains 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:String

the 2 letter language code, null returns empty.

Returns:List<Locale>

an unmodifiable List of Locale objects, not null.

Checks if the locale specified is in the set of available locales.

Parameters

locale:Locale

the Locale object to check if it is available.

Returns:boolean

true if the locale is a known locale.

Tests 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:Locale

the locale to test.

Returns:boolean

whether a Locale's language is undetermined.

Since

3.14.0

See Also

Locale#toLanguageTag()

Obtains 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:String

the 2-letter country code, null returns empty.

Returns:List<Locale>

an unmodifiable List of Locale objects, not null.

Obtains 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:Locale

the locale to start from.

Returns:List<Locale>

the unmodifiable list of Locale objects, 0 being locale, not null.

Obtains 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:Locale

the locale to start from, null returns empty list.

defaultLocale:Locale

the default locale to use if no other is found.

Returns:List<Locale>

the unmodifiable list of Locale objects, 0 being locale, not null.

Returns the given locale if non-null, otherwise Locale#getDefault().

Parameters

locale:Locale

a locale or null.

Returns:Locale

the given locale if non-null, otherwise Locale#getDefault().

Since

3.12.0

Converts 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")   (#)
  LocaleUtils.toLocale("US")         = new Locale("", "US") // Because "US" is Locale.getISOCountries()

(#) 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:String

the locale String to convert, null returns null.

Returns:Locale

a Locale, null if null input.

Exceptions

IllegalArgumentException:

if the string is an invalid format.

See Also

Locale#forLanguageTag(String), Locale#getISOCountries()