Package ninja.i18n

Interface Messages

All Known Implementing Classes:

MessagesImpl

public interface Messages

Method Summary

Modifier and Type	Method	Description
Optional<String>	get(String key, Optional<String> language, Object... parameter)	Get a translated string.
Optional<String>	get(String key, Context context, Optional<Result> result, Object... parameter)	Get a translated string.
Map<Object,Object>	getAll(Optional<String> language)	Deprecated. Might be removed from further releases.
Map<Object,Object>	getAll(Context context, Optional<Result> result)	Returns all messages for the default language in that context / result.
String	getWithDefault(String key, String defaultMessage, Optional<String> language, Object... params)	Gets a message for a message key.
String	getWithDefault(String key, String defaultMessage, Context context, Optional<Result> result, Object... params)	Gets a message for a message key.

Method Detail

get

Optional<String> get(String key,
                     Optional<String> language,
                     Object... parameter)

Get a translated string. The language is determined by the provided locale or a suitable fallback. values of keys can use the MessageFormat. More here: http://docs.oracle.com/javase/6/docs/api/java/text/MessageFormat.html But in short you can use something like mymessage=my message with a placeholder {0} parameter will then be used to fill {0} with the content. Note: If you don't want to determine the language yourself please use Messages#get(String, Context, Result, Object...)

Parameters:

key - The key used in your message file (conf/messages.properties)

language - The language to get. Can be null - then the default language is returned. It also looks for a fallback. Eg. A request for "en-US" will fallback to "en" if there is no matching language file.

parameter - Parameters to use in formatting the message of the key (in MessageFormat).

Returns:

The matching and formatted value or absent if not found.

get

Optional<String> get(String key,
                     Context context,
                     Optional<Result> result,
                     Object... parameter)

Get a translated string. The language is determined by the provided locale or a suitable fallback. values of keys can use the MessageFormat. More here: http://docs.oracle.com/javase/6/docs/api/java/text/MessageFormat.html But in short you can use something like mymessage=my message with a placeholder {0}

Parameters:

key - The key used in your message file (conf/messages.properties)

context - The context used to determine the language.

result - The result used to determine the language.

parameter - Parameters to use in formatting the message of the key (in MessageFormat).

Returns:

The matching and formatted value or absent if not found.

getWithDefault

String getWithDefault(String key,
                      String defaultMessage,
                      Optional<String> language,
                      Object... params)

Gets a message for a message key. Returns a defaultValue if not found. Note: If you don't want to determine the language yourself please use Messages#getWithDefault(String, Context, Result, Object...)

Parameters:

key - The key used in your message file (conf/messages.properties)

defaultMessage - A default message that will be used when no matching message can be retrieved.

language - The language to get. May be absent - then the default language is returned. It also looks for a fallback. Eg. A request for "en-US" will fallback to "en" if there is no matching language file.

parameter - Parameters to use in formatting the message of the key (in MessageFormat).

Returns:

The matching and formatted value (either from messages or the default one).

getWithDefault

String getWithDefault(String key,
                      String defaultMessage,
                      Context context,
                      Optional<Result> result,
                      Object... params)

Gets a message for a message key. Returns a defaultValue if not found.

Parameters:

key - The key used in your message file (conf/messages.properties)

defaultMessage - A default message that will be used when no matching message can be retrieved.

context - The context used to determine the language.

result - The result used to determine the language. May be absent

params - Parameters to use in formatting the message of the key (in MessageFormat).

Returns:

The matching and formatted value (either from messages or the default one).

getAll

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

Deprecated.

Might be removed from further releases. Usually is not implemented in a thread safe way and is error prone. Returns all messages for a language we have. Please note that this method does NOT format any MessageFormat values. You have to do that yourself in the controller logic most likely. Note: If you don't want to determine the language yourself please use Messages#getAll(Context, Result)

Parameters:

language - The language to get. May be absent - then the default language is returned. It also looks for a fallback. Eg. A request for "en-US" will fallback to "en" if there is no matching language file. language can also be the complete Accept-Language header: en-US,en;q=0.8,de;q=0.6

Returns:

A map with all messages as

getAll

Map<Object,Object> getAll(Context context,
                                Optional<Result> result)

Returns all messages for the default language in that context / result. Does NOT format any MessageFormat values. You have to do that yourself in the controller logic most likely.

Parameters:

context - The context

result - The result - bay be absent

Returns:

A map with all messages as