org.josef.util

Class CLocale

java.lang.Object

org.josef.util.CLocale

@Status(stage=PRODUCTION,
        unitTests=PARTIAL)
 @Review(by="Kees Schotanus",
        at="2009-09-28")
public final class CLocale
extends Object

Collection of Locale related methods.

Version:

1.1 $Revision: 5877 $

Author:

Kees Schotanus

Method Summary

Modifier and Type	Method and Description
static Locale	addMissingCountry(Locale locale) Adds the country to the supplied locale, but only when it is missing.
static Locale	getLocale(Locale locale) Gets the supplied locale or the default locale when the supplied locale is null.
static boolean	isInstalledLocale(Locale locale) Determines whether the supplied locale is one of the installed locales.
static boolean	isValidIsoCountry(String alpha2Code) Determines whether the supplied alpha2Code is a valid 2 letter ISO-3166 country or not.
static Locale	valueOf(String locale) Converts the supplied locale from a String to a Locale.

Methods inherited from class java.lang.Object

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

Method Detail

valueOf

public static Locale valueOf(String locale)

Converts the supplied locale from a String to a Locale.

Parameters:

locale - String representation of a Locale.
See: Locale.toString() for the format that this method expects, with the exception that the language must be present.

Returns:

The Locale corresponding to the supplied locale.

Throws:

IllegalArgumentException - When no locale can be created from the supplied locale.

NullPointerException - When the supplied locale is null.

addMissingCountry

public static Locale addMissingCountry(Locale locale)

Adds the country to the supplied locale, but only when it is missing.
The algorithm to find the country corresponding to the language is this:

• Use the upper case language code as the country code
• If the language is "EN", then "US" (United States) is assumed
• If the country is a valid (supported) country, add it
• If the country is invalid a warning is logged and no country info is added.

Parameters:

locale - The locale to add the missing country information to.

Returns:

The supplied locale with a possibly added country.
See algorithm above.

Throws:

NullPointerException - When the supplied locale is null.

isValidIsoCountry

public static boolean isValidIsoCountry(String alpha2Code)

Determines whether the supplied alpha2Code is a valid 2 letter ISO-3166 country or not.

Parameters:

alpha2Code - The 2 letter code to check.

Returns:

True when the supplied alpha2Code is a valid 2 letter ISO-3166 country, false when it is not.

See Also:

Locale.getISOCountries()

getLocale

public static Locale getLocale(Locale locale)

Gets the supplied locale or the default locale when the supplied locale is null.

Parameters:

locale - The locale.
When null, the default locale is returned.

Returns:

The supplied locale or the default locale when the supplied locale is null.

isInstalledLocale

public static boolean isInstalledLocale(Locale locale)

Determines whether the supplied locale is one of the installed locales.
Note: Even though the Dutch locale ("nl") is installedm that doesn't mean that all localized information like the names of all the countries for example is present.

Parameters:

locale - The locale to check.

Returns:

True when the supplied locale is an installed locale, false when the supplied locale is not installed.