org.seedstack.i18n

Interface LocaleService

@Service
public interface LocaleService

This service allows to manage the application's locales. A locale is just a String identifying a region. Some examples include fr-FR, en-GB, en-US-pouet, zn, any string you want to use.

Author:

yves.dautremay@mpsa.com

Method Summary

Modifier and Type	Method and Description
void	addLocale(String locale) Adds a new available locale.
void	changeDefaultLocaleTo(String locale) Changes the current default locale.
void	deleteLocale(String locale) Deletes an available locale.
Set<String>	getAvailableLocales() Returns all the available locales for the application.
String	getClosestLocale(String locale) Returns the closest locale from the given locale which is supported by the application.
String	getDefaultLocale() Returns the application's default locale.
Set<String>	getSupportedLocales() Returns all the locales supported by the platform.
boolean	isAvailable(String localeCode) Indicates whether the locale is available.

Method Detail

isAvailable

boolean isAvailable(String localeCode)

Indicates whether the locale is available. Returns false if the given code is null.

Parameters:

localeCode - the locale code, e.g. "fr-BE"

Returns:

true is the locale exists, false otherwise.

getAvailableLocales

Set<String> getAvailableLocales()

Returns all the available locales for the application.

Returns:

a set with all the locales.

getSupportedLocales

Set<String> getSupportedLocales()

Returns all the locales supported by the platform.

Returns:

a set with the supported locales.

getDefaultLocale

String getDefaultLocale()

Returns the application's default locale.

Returns:

The default locale or null if there is no default locale

getClosestLocale

String getClosestLocale(String locale)

Returns the closest locale from the given locale which is supported by the application.

Parameters:

locale - The locale to match.

Returns:

The supported locale or null if there is no close locale

changeDefaultLocaleTo

void changeDefaultLocaleTo(String locale)

Changes the current default locale.

Parameters:

locale - the locale to define as default.

Throws:

IllegalArgumentException - if the locale is null.

addLocale

void addLocale(String locale)

Adds a new available locale.

Does nothing if locale already exists.

Parameters:

locale - the locale to add.

Throws:

IllegalArgumentException - if the locale argument is null.

deleteLocale

void deleteLocale(String locale)

Deletes an available locale.

Does nothing if the given locale does not exist.

Parameters:

locale - the locale to delete.

Throws:

IllegalArgumentException - if the locale argument is null.