Package org.ametys.core.util.language

Class UserLanguagesManager

java.lang.Object

org.ametys.core.util.language.UserLanguagesManager

All Implemented Interfaces:

Component, Configurable

public class UserLanguagesManager
extends Object
implements Configurable, Component

Handle possible languages for user preferences

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ROLE	The component role

Constructor Summary

Constructors

Constructor	Description
UserLanguagesManager()

Method Summary

Modifier and Type	Method	Description
void	configure(Configuration configuration)
Map<String,Language>	getAvailableLanguages()	Get the list of possible languages
List<Map<String,Object>>	getAvailableLanguagesAsJsonObject()	Get the list of available languages as a JSON object
Language	getLanguage(String code)	Get the language by its code
protected Map<String,Object>	toJson(Language language)	Return the JSON representation of a language

Methods inherited from class java.lang.Object

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

Field Details

ROLE

public static final String ROLE

The component role

Constructor Details

UserLanguagesManager

public UserLanguagesManager()

Method Details

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Throws:

ConfigurationException

getLanguage

public Language getLanguage(String code)

Get the language by its code

Parameters:

code - The language code

Returns:

The language or null if not found

getAvailableLanguages

public Map<String,Language> getAvailableLanguages()

Get the list of possible languages

Returns:

the association language-code Language object

getAvailableLanguagesAsJsonObject

public List<Map<String,Object>> getAvailableLanguagesAsJsonObject()

Get the list of available languages as a JSON object

Returns:

The available languages

toJson

protected Map<String,Object> toJson(Language language)

Return the JSON representation of a language

Parameters:

language - The language

Returns:

The json object representing the language