org.helenus.commons.lang3

Class LocaleUtils

java.lang.Object

org.apache.commons.lang3.LocaleUtils

org.helenus.commons.lang3.LocaleUtils

public class LocaleUtils
extends LocaleUtils

The LocaleUtils class extends Apache's LocaleUtils to either provide new functionality or replace existing one.

Since:

1.0

Version:

1 - Nov 16, 2015 - paouelle - Creation

Author:

The Helenus Driver Project Authors

Copyright:

2015-2015 The Helenus Driver Project Authors

Constructor Summary

Constructors

Constructor and Description
LocaleUtils() Instantiates a new LocaleUtils object.

Method Summary

Modifier and Type	Method and Description
static Locale	toLocale(String str) Converts a string to a Locale.

Methods inherited from class org.apache.commons.lang3.LocaleUtils

availableLocaleList, availableLocaleSet, countriesByLanguage, isAvailableLocale, languagesByCountry, localeLookupList, localeLookupList

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LocaleUtils

public LocaleUtils()

Instantiates a new LocaleUtils object.

Method Detail

toLocale

public static Locale toLocale(String str)

Converts a string to a Locale.

This method takes the string format of a locale and creates the locale object from it. It also properly supports scripts and extensions. It also fixes some problems with Apache's version which didn't properly support locale without a country but with an extension. It also ensures that all locales that are returned by Locale.getAvailableLocales() can be properly decoded and returned in such a way that the Locale.equals(java.lang.Object) method will result to true.

   LocaleUtils.toLocale("")           = Locale.ROOT
   LocaleUtils.toLocale("en")         = new Locale("en", "")
   LocaleUtils.toLocale("en_GB")      = new Locale("en", "GB")
   LocaleUtils.toLocale("en_GB_xxx")  = new Locale("en", "GB", "xxx")   (#)
 

This method validates the input strictly. The language code must be lowercase. The country code must be uppercase. The separator must be an underscore. The length must be correct.

Parameters:

str - the locale string to convert

Returns:

a corresponding locale or null if str is null

Throws:

IllegalArgumentException - if the string is an invalid format