com.helger.commons.locale.country.CountryCache Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of ph-commons Show documentation
Show all versions of ph-commons Show documentation
Java 1.8+ Library with tons of utility classes required in all projects
/*
* Copyright (C) 2014-2024 Philip Helger (www.helger.com)
* philip[at]helger[dot]com
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.helger.commons.locale.country;
import java.util.Locale;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.annotation.concurrent.GuardedBy;
import javax.annotation.concurrent.ThreadSafe;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import com.helger.commons.ValueEnforcer;
import com.helger.commons.annotation.ReturnsMutableCopy;
import com.helger.commons.annotation.Singleton;
import com.helger.commons.annotation.VisibleForTesting;
import com.helger.commons.collection.impl.CommonsHashSet;
import com.helger.commons.collection.impl.ICommonsSet;
import com.helger.commons.concurrent.SimpleReadWriteLock;
import com.helger.commons.debug.GlobalDebug;
import com.helger.commons.locale.LocaleCache;
import com.helger.commons.locale.LocaleCache.IMissingLocaleHandler;
import com.helger.commons.locale.LocaleHelper;
import com.helger.commons.log.ConditionalLogger;
import com.helger.commons.log.IHasConditionalLogger;
import com.helger.commons.state.EChange;
import com.helger.commons.string.StringHelper;
/**
* This is a global cache for country objects to avoid too many object flowing
* around.
* This cache is application independent.
*
* @author Philip Helger
*/
@ThreadSafe
@Singleton
public class CountryCache implements IHasConditionalLogger
{
private static final class SingletonHolder
{
private static final CountryCache INSTANCE = new CountryCache ();
}
private static final Logger LOGGER = LoggerFactory.getLogger (CountryCache.class);
private static final ConditionalLogger CONDLOG = new ConditionalLogger (LOGGER, !GlobalDebug.DEFAULT_SILENT_MODE);
private static boolean s_bDefaultInstantiated = false;
private final SimpleReadWriteLock m_aRWLock = new SimpleReadWriteLock ();
/** Contains all known countries (as ISO 3166 2-letter codes). */
@GuardedBy ("m_aRWLock")
private final ICommonsSet m_aCountries = new CommonsHashSet <> ();
protected CountryCache ()
{
reinitialize ();
}
/**
* @return true if logging is disabled, false if it
* is enabled.
* @since 9.4.0
*/
public static boolean isSilentMode ()
{
return CONDLOG.isDisabled ();
}
/**
* Enable or disable certain regular log messages.
*
* @param bSilentMode
* true to disable logging, false to enable
* logging
* @return The previous value of the silent mode.
* @since 9.4.0
*/
public static boolean setSilentMode (final boolean bSilentMode)
{
return !CONDLOG.setEnabled (!bSilentMode);
}
public static boolean isInstantiated ()
{
return s_bDefaultInstantiated;
}
/**
* @return The one and only global instances. Never null.
*/
@Nonnull
public static CountryCache getInstance ()
{
final CountryCache ret = SingletonHolder.INSTANCE;
s_bDefaultInstantiated = true;
return ret;
}
@Nonnull
@VisibleForTesting
final EChange addCountry (@Nonnull final String sCountry)
{
ValueEnforcer.notNull (sCountry, "Country");
final String sValidCountry = LocaleHelper.getValidCountryCode (sCountry);
ValueEnforcer.isTrue (sValidCountry != null, () -> "illegal country code '" + sCountry + "'");
ValueEnforcer.isTrue (sCountry.equals (sValidCountry), () -> "invalid casing of '" + sCountry + "'");
return m_aRWLock.writeLockedGet ( () -> m_aCountries.addObject (sValidCountry));
}
/**
* The normed country locale associated with the provided locale.
*
* @param aCountry
* Source locale. May be null.
* @return null if the source locale is null or if
* the source locale does not contain country information.
*/
@Nullable
public Locale getCountry (@Nullable final Locale aCountry)
{
return aCountry == null ? null : getCountry (aCountry.getCountry ());
}
/**
* The normed country locale associated with the provided locale.
*
* @param aCountry
* Source locale. May be null.
* @param aMissingHandler
* The missing locale handler to be passed to {@link LocaleCache}. May
* be null to use {@link LocaleCache} default handler.
* @return null if the source locale is null or if
* the source locale does not contain country information.
* @since 9.4.2
*/
@Nullable
public Locale getCountryExt (@Nullable final Locale aCountry, @Nullable final IMissingLocaleHandler aMissingHandler)
{
return aCountry == null ? null : getCountryExt (aCountry.getCountry (), aMissingHandler);
}
/**
* Resolve the country from the provided string.
* Note: this method may be invoked recursively, if the country code contains
* a locale separator char.
*
* @param sCountry
* The country code. May be null or empty.
* @return null if the provided country code is null
* or empty.
*/
@Nullable
public Locale getCountry (@Nullable final String sCountry)
{
return getCountryExt (sCountry, null);
}
/**
* Resolve the country from the provided string.
* Note: this method may be invoked recursively, if the country code contains
* a locale separator char.
*
* @param sCountry
* The country code. May be null or empty.
* @param aMissingHandler
* The missing locale handler to be passed to {@link LocaleCache}. May
* be null to use {@link LocaleCache} default handler.
* @return null if the provided country code is null
* or empty.
* @since 9.4.2
*/
@Nullable
public Locale getCountryExt (@Nullable final String sCountry, @Nullable final IMissingLocaleHandler aMissingHandler)
{
if (StringHelper.hasNoText (sCountry))
return null;
final LocaleCache aLC = LocaleCache.getInstance ();
final IMissingLocaleHandler aMLH = aMissingHandler != null ? aMissingHandler : aLC
.getDefaultMissingLocaleHandler ();
// Was something like "_AT" (e.g. the result of getCountry (...).toString
// ()) passed in? -> indirect recursion
if (sCountry.indexOf (LocaleHelper.LOCALE_SEPARATOR) >= 0)
return getCountryExt (aLC.getLocaleExt (sCountry, aMLH), aMLH);
final String sValidCountry = LocaleHelper.getValidCountryCode (sCountry);
if (!containsCountry (sValidCountry))
CONDLOG.warn ( () -> "Trying to retrieve unsupported country '" + sCountry + "'");
// And use the locale cache
return aLC.getLocale ("", sValidCountry, "", aMLH);
}
/**
* @return a set with all contained countries. Never null.
*/
@Nonnull
@ReturnsMutableCopy
public ICommonsSet getAllCountries ()
{
return m_aRWLock.readLockedGet (m_aCountries::getClone);
}
/**
* @return a set with all contained country locales. Never null.
*/
@Nonnull
@ReturnsMutableCopy
public ICommonsSet getAllCountryLocales ()
{
return m_aRWLock.readLockedGet ( () -> {
final LocaleCache aLC = LocaleCache.getInstance ();
return new CommonsHashSet <> (m_aCountries, sCountry -> aLC.getLocale ("", sCountry, ""));
});
}
/**
* Check if the passed country is known.
*
* @param aCountry
* The country to check. May be null.
* @return true if the passed country is contained,
* false otherwise.
*/
public boolean containsCountry (@Nullable final Locale aCountry)
{
return aCountry != null && containsCountry (aCountry.getCountry ());
}
/**
* Check if the passed country is known.
*
* @param sCountry
* The country to check. May be null.
* @return true if the passed country is contained,
* false otherwise.
*/
public boolean containsCountry (@Nullable final String sCountry)
{
if (sCountry == null)
return false;
final String sValidCountry = LocaleHelper.getValidCountryCode (sCountry);
if (sValidCountry == null)
return false;
return m_aRWLock.readLockedBoolean ( () -> m_aCountries.contains (sValidCountry));
}
/**
* Reset the cache to the initial state.
*/
public final void reinitialize ()
{
m_aRWLock.writeLocked (m_aCountries::clear);
for (final Locale aLocale : LocaleCache.getAllDefaultLocales ())
{
final String sCountry = aLocale.getCountry ();
if (StringHelper.hasText (sCountry))
addCountry (sCountry);
}
CONDLOG.debug ( () -> "Reinitialized " + getClass ().getName ());
}
}