com.helger.photon.basic.app.locale

Interface ILocaleManager

All Known Implementing Classes:

LocaleManager

public interface ILocaleManager

Method Summary

Methods

Modifier and Type	Method and Description
List<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.

Method Detail

registerLocale

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

Register a new locale

Parameters:

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

Returns:

EChange.

setDefaultLocale

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

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

Parameters:

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

Returns:

EChange

getDefaultLocale

@Nullable
Locale getDefaultLocale()

Returns:

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

getAllAvailableLocales

@Nonnull
@ReturnsMutableCopy
List<Locale> getAllAvailableLocales()

Returns:

All available locales for the application.

hasLocales

boolean hasLocales()

Returns:

true if at least one locale is present, false otherwise

isSupportedLocale

boolean isSupportedLocale(@Nullable
                        Locale aLocale)

Check if the passed locale is a supported locale.

Parameters:

aLocale - The locale to check

Returns:

true if the passed locale is supported, false otherwise.