ninja.i18n

Interface Lang

All Known Implementing Classes:

LangImpl

public interface Lang

Method Summary

Methods

Modifier and Type	Method and Description
void	clearLanguage(Result result) Clears the current language.
String	get(String key, String language, Object... parameter) Deprecated. Now lives in Messages
Map<Object,Object>	getAll(String language) Deprecated. Now lives in Messages
String	getLanguage(Context context, Result result) Retrieve the current language or null if not set.
String	getWithDefault(String key, String defaultMessage, String language, Object... params) Deprecated. Now lives in Messages
boolean	isLanguageDirectlySupportedByThisApplication(String language) application.conf usually contains the following: application.languages=en,de This little helper checks if the language is supported.
Result	setLanguage(String locale, Result result) Force a language in Ninja framwork.

Method Detail

get

@Deprecated
String get(String key,
                    @Nullable
                    String language,
                    Object... parameter)

Deprecated. Now lives in Messages

getWithDefault

@Deprecated
String getWithDefault(String key,
                               String defaultMessage,
                               @Nullable
                               String language,
                               Object... params)

Deprecated. Now lives in Messages

getAll

@Deprecated
Map<Object,Object> getAll(@Nullable
                                   String language)

Deprecated. Now lives in Messages

getLanguage

String getLanguage(Context context,
                 Result result)

Retrieve the current language or null if not set. It will try to determine the language by: 1) Checking if result contains a forced language 2) Checking if context has a NINJA_LANG cookie with a forced language 3) Getting the first language from the Accept-Language header

Returns:

The current language (fr, ja, it ...) or null

setLanguage

Result setLanguage(String locale,
                 Result result)

Force a language in Ninja framwork. This is usually done by a cookie NINJA_LANG. This overrides any Accept-Language languages.

Parameters:

locale - (fr, ja, it ...)

clearLanguage

void clearLanguage(Result result)

Clears the current language. This will trigger resolving language from request (Accept lang) if not manually set. Note: The language is set by a cookie. To delete a cookie the max-age is set to 0. It can therefore be the case that the lang cookie still exists in the thread. Make sure your module / app handles this properly.

Parameters:

Result - result clear language commands merged into result.

isLanguageDirectlySupportedByThisApplication

boolean isLanguageDirectlySupportedByThisApplication(String language)

application.conf usually contains the following: application.languages=en,de This little helper checks if the language is supported.

Parameters:

language - The language to check (en, en-US etc)

Returns:

true if supported directly, false if not