play.i18n

Class MessagesApi

java.lang.Object

play.i18n.MessagesApi

@Singleton
public class MessagesApi
extends java.lang.Object

The messages API.

Constructor Summary

Constructors

Constructor and Description
MessagesApi(play.api.i18n.MessagesApi messages)

Method Summary

Modifier and Type	Method and Description
java.lang.String	get(play.api.i18n.Lang lang, java.util.List<java.lang.String> keys, java.lang.Object... args) Translates the first defined message.
java.lang.String	get(play.api.i18n.Lang lang, java.lang.String key, java.lang.Object... args) Translates a message.
java.lang.Boolean	isDefinedAt(play.api.i18n.Lang lang, java.lang.String key) Check if a message key is defined.
boolean	langCookieHttpOnly()
java.lang.String	langCookieName()
boolean	langCookieSecure()
Messages	preferred(java.util.Collection<Lang> candidates) Get a messages context appropriate for the given candidates.
Messages	preferred(Http.RequestHeader request) Get a messages context appropriate for the given candidates.
play.api.i18n.MessagesApi	scalaApi()

Methods inherited from class java.lang.Object

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

Constructor Detail

MessagesApi

@Inject
public MessagesApi(play.api.i18n.MessagesApi messages)

Method Detail

scalaApi

public play.api.i18n.MessagesApi scalaApi()

get

public java.lang.String get(play.api.i18n.Lang lang,
                            java.lang.String key,
                            java.lang.Object... args)

Translates a message. Uses `java.text.MessageFormat` internally to format the message.

Parameters:

lang - the message lang

key - the message key

args - the message arguments

Returns:

the formatted message or a default rendering if the key wasn't defined

get

public java.lang.String get(play.api.i18n.Lang lang,
                            java.util.List<java.lang.String> keys,
                            java.lang.Object... args)

Translates the first defined message. Uses `java.text.MessageFormat` internally to format the message.

Parameters:

lang - the message lang

keys - the messages keys

args - the message arguments

Returns:

the formatted message or a default rendering if the key wasn't defined

isDefinedAt

public java.lang.Boolean isDefinedAt(play.api.i18n.Lang lang,
                                     java.lang.String key)

Check if a message key is defined.

Parameters:

lang - the message lang

key - the message key

Returns:

a Boolean

preferred

public Messages preferred(java.util.Collection<Lang> candidates)

Get a messages context appropriate for the given candidates. Will select a language from the candidates, based on the languages available, and fallback to the default language if none of the candidates are available.

Parameters:

candidates - the candidate languages

Returns:

the most appropriate Messages instance given the candidate languages

preferred

public Messages preferred(Http.RequestHeader request)

Get a messages context appropriate for the given candidates. Will select a language from the candidates, based on the languages available, and fallback to the default language if none of the candidates are available.

Parameters:

request - the incoming request

Returns:

the preferred messages context for the request

langCookieName

public java.lang.String langCookieName()

langCookieSecure

public boolean langCookieSecure()

langCookieHttpOnly

public boolean langCookieHttpOnly()