play.i18n

Class Messages

java.lang.Object

play.i18n.Messages

public class Messages
extends java.lang.Object

A messages and a language. This class serves two purposes. One is for backwards compatibility, it serves the old static API for accessing messages. The other is a new API, which carries an inject messages, and a selected language. The methods for looking up messages on the old API are called get, on the new API, they are called at. In Play 3.0, when we remove the old API, we may alias the at methods to the get names.

Constructor Summary

Constructors

Constructor and Description
Messages(Lang lang, MessagesApi messages)

Method Summary

Modifier and Type	Method and Description
java.lang.String	at(java.util.List<java.lang.String> keys, java.lang.Object... args) Get the message at the first defined key.
java.lang.String	at(java.lang.String key, java.lang.Object... args) Get the message at the given key.
static java.lang.String	get(Lang lang, java.util.List<java.lang.String> keys, java.lang.Object... args) Deprecated. Please use messages.at(keys, args)
static java.lang.String	get(Lang lang, java.lang.String key, java.lang.Object... args) Deprecated. Please use messages.at(key, args). since 2.5.0
static java.lang.String	get(java.util.List<java.lang.String> keys, java.lang.Object... args) Deprecated. use messages.at(keys, args). Deprecated since 2.5.0
static java.lang.String	get(java.lang.String key, java.lang.Object... args) Deprecated. use messages.at(key, args). Deprecated since 2.5.0
static java.lang.Boolean	isDefined(Lang lang, java.lang.String key) Deprecated. Use messages.isDefinedAt(key). Deprecated since 2.5.0
static java.lang.Boolean	isDefined(java.lang.String key) Deprecated. Use messages.isDefinedAt(key). Deprecated since 2.5.0
java.lang.Boolean	isDefinedAt(java.lang.String key) Check if a message key is defined.
Lang	lang() The lang for these messages
MessagesApi	messagesApi()

Methods inherited from class java.lang.Object

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

Constructor Detail

Messages

public Messages(Lang lang,
                MessagesApi messages)

Method Detail

get

@Deprecated
public static java.lang.String get(Lang lang,
                                               java.lang.String key,
                                               java.lang.Object... args)

Deprecated. Please use messages.at(key, args). since 2.5.0

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

@Deprecated
public static java.lang.String get(Lang lang,
                                               java.util.List<java.lang.String> keys,
                                               java.lang.Object... args)

Deprecated. Please use messages.at(keys, 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

get

@Deprecated
public static java.lang.String get(java.lang.String key,
                                               java.lang.Object... args)

Deprecated. use messages.at(key, args). Deprecated since 2.5.0

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

Parameters:

key - the message key

args - the message arguments

Returns:

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

get

@Deprecated
public static java.lang.String get(java.util.List<java.lang.String> keys,
                                               java.lang.Object... args)

Deprecated. use messages.at(keys, args). Deprecated since 2.5.0

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

Parameters:

keys - the messages keys

args - the message arguments

Returns:

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

isDefined

@Deprecated
public static java.lang.Boolean isDefined(Lang lang,
                                                      java.lang.String key)

Deprecated. Use messages.isDefinedAt(key). Deprecated since 2.5.0

Check if a message key is defined.

Parameters:

lang - the message lang

key - the message key

Returns:

a Boolean

isDefined

@Deprecated
public static java.lang.Boolean isDefined(java.lang.String key)

Deprecated. Use messages.isDefinedAt(key). Deprecated since 2.5.0

Check if a message key is defined.

Parameters:

key - the message key

Returns:

a Boolean

lang

public Lang lang()

The lang for these messages

Returns:

the language

messagesApi

public MessagesApi messagesApi()

Returns:

The underlying API

at

public java.lang.String at(java.lang.String key,
                           java.lang.Object... args)

Get the message at the given key. Uses `java.text.MessageFormat` internally to format the message.

Parameters:

key - the message key

args - the message arguments

Returns:

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

at

public java.lang.String at(java.util.List<java.lang.String> keys,
                           java.lang.Object... args)

Get the message at the first defined key. Uses `java.text.MessageFormat` internally to format the message.

Parameters:

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(java.lang.String key)

Check if a message key is defined.

Parameters:

key - the message key

Returns:

a Boolean