com.helger.commons.locale.country

Class CountryCache

java.lang.Object

com.helger.commons.locale.country.CountryCache

@ThreadSafe
 @Singleton
public class CountryCache
extends Object

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

Author:

Philip Helger

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CountryCache()

Method Summary

Modifier and Type	Method and Description
boolean	containsCountry(Locale aCountry) Check if the passed country is known.
boolean	containsCountry(String sCountry) Check if the passed country is known.
ICommonsSet<String>	getAllCountries()
ICommonsSet<Locale>	getAllCountryLocales()
Locale	getCountry(Locale aCountry) The normed country locale associated with the provided locale.
Locale	getCountry(String sCountry) Resolve the country from the provided string.
static CountryCache	getInstance()
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

Constructor Detail

CountryCache

protected CountryCache()

Method Detail

isInstantiated

public static boolean isInstantiated()

getInstance

@Nonnull
public static CountryCache getInstance()

Returns:

The one and only global instances. Never null.

getCountry

@Nullable
public Locale getCountry(@Nullable
                                    Locale aCountry)

The normed country locale associated with the provided locale.

Parameters:

aCountry - Source locale. May be null.

Returns:

null if the source locale is null or if the source locale does not contain country information.

getCountry

@Nullable
public Locale getCountry(@Nullable
                                    String sCountry)

Resolve the country from the provided string.
Note: this method may be invoked recursively, if the country code contains a locale spearator char.

Parameters:

sCountry - The country code. May be null or empty.

Returns:

null if the provided country code is null or empty.

getAllCountries

@Nonnull
 @ReturnsMutableCopy
public ICommonsSet<String> getAllCountries()

Returns:

a set with all contained countries. Never null.

getAllCountryLocales

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

Returns:

a set with all contained country locales. Never null.

containsCountry

public boolean containsCountry(@Nullable
                               Locale aCountry)

Check if the passed country is known.

Parameters:

aCountry - The country to check. May be null.

Returns:

true if the passed country is contained, false otherwise.

containsCountry

public boolean containsCountry(@Nullable
                               String sCountry)

Check if the passed country is known.

Parameters:

sCountry - The country to check. May be null.

Returns:

true if the passed country is contained, false otherwise.

reinitialize

public final void reinitialize()

Reset the cache to the initial state.