com.helger.photon.basic.app.locale

Class LocaleManager

java.lang.Object

com.helger.photon.basic.app.locale.LocaleManager

All Implemented Interfaces:

ILocaleManager

@NotThreadSafe
public class LocaleManager
extends Object
implements ILocaleManager

This class manages the locales available in the application.

Author:

Philip Helger

Constructor Summary

Constructors

Constructor and Description
LocaleManager()

Method Summary

Modifier and Type	Method and Description
com.helger.commons.collection.ext.ICommonsList<Locale>	getAllAvailableLocales()
Locale	getDefaultLocale()
boolean	hasLocales()
boolean	isSupportedLocale(Locale aLocale) Check if the passed locale is a supported locale.
com.helger.commons.state.EChange	registerLocale(Locale aLocale) Register a new locale
com.helger.commons.state.EChange	setDefaultLocale(Locale aDefaultLocale) Set the default locale.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

LocaleManager

public LocaleManager()

Method Detail

registerLocale

@Nonnull
public com.helger.commons.state.EChange registerLocale(@Nonnull
                                                                 Locale aLocale)

Description copied from interface: ILocaleManager

Register a new locale

Specified by:

registerLocale in interface ILocaleManager

Parameters:

aLocale - The locale to be added. May not be null.

Returns:

EChange.

setDefaultLocale

@Nonnull
public com.helger.commons.state.EChange setDefaultLocale(@Nonnull
                                                                   Locale aDefaultLocale)

Description copied from interface: ILocaleManager

Set the default locale. Must be one of the previously registered locales!

Specified by:

setDefaultLocale in interface ILocaleManager

Parameters:

aDefaultLocale - The locale to be used as the default. May not be null.

Returns:

EChange

getDefaultLocale

@Nullable
public Locale getDefaultLocale()

Specified by:

getDefaultLocale in interface ILocaleManager

Returns:

The application default locale. May be null if non is defined

getAllAvailableLocales

@Nonnull
 @ReturnsMutableCopy
public com.helger.commons.collection.ext.ICommonsList<Locale> getAllAvailableLocales()

Specified by:

getAllAvailableLocales in interface ILocaleManager

Returns:

All available locales for the application.

hasLocales

public boolean hasLocales()

Specified by:

hasLocales in interface ILocaleManager

Returns:

true if at least one locale is present, false otherwise

isSupportedLocale

public boolean isSupportedLocale(@Nullable
                                 Locale aLocale)

Description copied from interface: ILocaleManager

Check if the passed locale is a supported locale.

Specified by:

isSupportedLocale in interface ILocaleManager

Parameters:

aLocale - The locale to check

Returns:

true if the passed locale is supported, false otherwise.

toString

public String toString()

Overrides:

toString in class Object