com.helger.commons.locale

Class LocaleCache

java.lang.Object

com.helger.commons.locale.LocaleCache

@ThreadSafe
 @Singleton
public final class LocaleCache
extends Object

This is a global cache for Locale objects to avoid too many object flowing around.
This cache is application independent.

Author:

Philip Helger

Method Summary

Modifier and Type	Method and Description
boolean	containsLocale(String sLanguage) Check if the passed language is in the cache.
boolean	containsLocale(String sLanguage, String sCountry) Check if the passed language is in the cache.
boolean	containsLocale(String sLanguage, String sCountry, String sVariant) Check if the passed language is in the cache.
ICommonsSet<Locale>	getAllLanguages() Get all contained locales that consist only of a non-empty language.
ICommonsList<Locale>	getAllLocales() Get all contained locales except the locales "all" and "independent"
static LocaleCache	getInstance()
Locale	getLocale(String sLanguage) Get the Locale object matching the given language.
Locale	getLocale(String sLanguage, String sCountry) Get the Locale object matching the given language and country.
Locale	getLocale(String sLanguage, String sCountry, String sVariant) Get the Locale object matching the given locale string
static boolean	isInstantiated()
void	reinitialize() Reset the cache to the initial state.

Methods inherited from class java.lang.Object

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

Method Detail

isInstantiated

public static boolean isInstantiated()

getInstance

@Nonnull
public static LocaleCache getInstance()

getLocale

@Nullable
public Locale getLocale(@Nullable
                                   String sLanguage)

Get the Locale object matching the given language.

Parameters:

sLanguage - The language to use. May be null or empty.

Returns:

null if the passed language string is null or empty

getLocale

@Nullable
public Locale getLocale(@Nullable
                                   String sLanguage,
                                   @Nullable
                                   String sCountry)

Get the Locale object matching the given language and country.

Parameters:

sLanguage - The language to use. May be null or empty.

sCountry - The country to use. May be null.

Returns:

null if the passed language string is null or empty

getLocale

@Nullable
public Locale getLocale(@Nullable
                                   String sLanguage,
                                   @Nullable
                                   String sCountry,
                                   @Nullable
                                   String sVariant)

Get the Locale object matching the given locale string

Parameters:

sLanguage - The language to use. May be null or empty.

sCountry - Optional country to use. May be null.

sVariant - Optional variant. May be null.

Returns:

null if all the passed parameters are null or empty

getAllLocales

@Nonnull
 @ReturnsMutableCopy
public ICommonsList<Locale> getAllLocales()

Get all contained locales except the locales "all" and "independent"

Returns:

a set with all contained locales, except "all" and "independent"

getAllLanguages

@Nonnull
 @ReturnsMutableCopy
public ICommonsSet<Locale> getAllLanguages()

Get all contained locales that consist only of a non-empty language.

Returns:

a set with all contained languages, except "all" and "independent"

containsLocale

public boolean containsLocale(@Nullable
                              String sLanguage)

Check if the passed language is in the cache.

Parameters:

sLanguage - The language to check.

Returns:

true if it is in the cache, false otherwise.

containsLocale

public boolean containsLocale(@Nullable
                              String sLanguage,
                              @Nullable
                              String sCountry)

Check if the passed language is in the cache.

Parameters:

sLanguage - The language to check.

sCountry - The country to check.

Returns:

true if it is in the cache, false otherwise.

containsLocale

public boolean containsLocale(@Nullable
                              String sLanguage,
                              @Nullable
                              String sCountry,
                              @Nullable
                              String sVariant)

Check if the passed language is in the cache.

Parameters:

sLanguage - The language to check.

sCountry - The country to check.

sVariant - The variant to check.

Returns:

true if it is in the cache, false otherwise.

reinitialize

public void reinitialize()

Reset the cache to the initial state.