com.haulmont.cuba.core.global

Interface Messages

All Known Implementing Classes:

AbstractMessages, MessagesClientImpl, MessagesImpl, TestMessages

public interface Messages

Central infrastructure interface to work with localized messages.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME

Method Summary

Modifier and Type	Method and Description
void	clearCache()
java.lang.String	findMessage(java.lang.String packs, java.lang.String key, java.util.Locale locale) Returns localized message or null if not found.
java.lang.String	formatMainMessage(java.lang.String key, java.lang.Object... params) Get localized message from main message pack and use it as a format string for parameters provided. Locale is determined by the current user session.
java.lang.String	formatMessage(java.lang.Class caller, java.lang.String key, java.util.Locale locale, java.lang.Object... params) Get localized message and use it as a format string for parameters provided
java.lang.String	formatMessage(java.lang.Class caller, java.lang.String key, java.lang.Object... params) Get localized message and use it as a format string for parameters provided. Locale is determined by the current user session.
java.lang.String	formatMessage(java.lang.String pack, java.lang.String key, java.util.Locale locale, java.lang.Object... params) Get localized message and use it as a format string for parameters provided
java.lang.String	formatMessage(java.lang.String pack, java.lang.String key, java.lang.Object... params) Get localized message and use it as a format string for parameters provided. Locale is determined by the current user session.
int	getCacheSize()
java.lang.String	getMainMessage(java.lang.String key) Returns localized message using main message pack. Locale is determined by the current user session.
java.lang.String	getMainMessage(java.lang.String key, java.util.Locale locale) Returns localized message
java.lang.String	getMainMessagePack()
java.lang.String	getMessage(java.lang.Class caller, java.lang.String key) Returns localized message. Locale is determined by the current user session.
java.lang.String	getMessage(java.lang.Class caller, java.lang.String key, java.util.Locale locale) Returns localized message
java.lang.String	getMessage(java.lang.Enum caller) Returns localized message. Locale is determined by the current user session.
java.lang.String	getMessage(java.lang.Enum caller, java.util.Locale locale) Returns localized message
java.lang.String	getMessage(java.lang.String pack, java.lang.String key) Returns localized message. Locale is determined by the current user session.
java.lang.String	getMessage(java.lang.String packs, java.lang.String key, java.util.Locale locale) Returns localized message
MessageTools	getTools() Convenient access to MessageTools bean.

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

Method Detail

getTools

MessageTools getTools()

Convenient access to MessageTools bean.

Returns:

MessageTools instance

getMainMessagePack

java.lang.String getMainMessagePack()

Returns:

main message pack for this application tier

getMessage

java.lang.String getMessage(java.lang.Class caller,
                            java.lang.String key)

Returns localized message.
Locale is determined by the current user session.

Parameters:

caller - class determining the message pack as full package name

key - message key

Returns:

localized message or the key if the message not found

formatMessage

java.lang.String formatMessage(java.lang.Class caller,
                               java.lang.String key,
                               java.lang.Object... params)

Get localized message and use it as a format string for parameters provided.
Locale is determined by the current user session.

Parameters:

caller - class determining the message pack as full package name

key - message key

params - parameter values

Returns:

formatted string or the key in case of IllegalFormatException

getMessage

java.lang.String getMessage(java.lang.Class caller,
                            java.lang.String key,
                            java.util.Locale locale)

Returns localized message

Parameters:

caller - class determining the message pack as full package name

key - message key

locale - message locale

Returns:

localized message or the key if the message not found

formatMessage

java.lang.String formatMessage(java.lang.Class caller,
                               java.lang.String key,
                               java.util.Locale locale,
                               java.lang.Object... params)

Get localized message and use it as a format string for parameters provided

Parameters:

caller - class determining the message pack as full package name

key - message key

locale - message locale

params - parameter values

Returns:

formatted string or the key in case of IllegalFormatException

getMessage

java.lang.String getMessage(java.lang.Enum caller)

Returns localized message.
Locale is determined by the current user session.

Parameters:

caller - enum determining the message pack and key:

• pack - enum's full package name
• key - enum's short class name (after last dot), plus dot, plus enum value

Returns:

localized message or the key if the message not found

getMessage

java.lang.String getMessage(java.lang.Enum caller,
                            java.util.Locale locale)

Returns localized message

Parameters:

caller - enum determining the message pack and key:

• pack - enum's full package name
• key - enum's short class name (after last dot), plus dot, plus enum value

locale - message locale

Returns:

localized message or the key if the message not found

getMessage

java.lang.String getMessage(java.lang.String pack,
                            java.lang.String key)

Returns localized message.
Locale is determined by the current user session.

Parameters:

pack - package name to start searching the message. If the key is not found in this package, it will be searched in parent package, and so forth

key - message key

Returns:

localized message or the key if the message not found

getMainMessage

java.lang.String getMainMessage(java.lang.String key)

Returns localized message using main message pack.
Locale is determined by the current user session.

Parameters:

key - message key

Returns:

localized message or the key if the message not found

getMainMessage

java.lang.String getMainMessage(java.lang.String key,
                                java.util.Locale locale)

Returns localized message

Parameters:

key - message key

locale - message locale

Returns:

localized message or the key if the message not found

formatMessage

java.lang.String formatMessage(java.lang.String pack,
                               java.lang.String key,
                               java.lang.Object... params)

Get localized message and use it as a format string for parameters provided.
Locale is determined by the current user session.

Parameters:

pack - package name to start searching the message. If the key is not found in this package, it will be searched in parent package, and so forth

key - message key

params - parameter values

Returns:

formatted string or the key in case of IllegalFormatException

formatMainMessage

java.lang.String formatMainMessage(java.lang.String key,
                                   java.lang.Object... params)

Get localized message from main message pack and use it as a format string for parameters provided.
Locale is determined by the current user session.

Parameters:

key - message key

params - parameter values

Returns:

formatted string or the key in case of IllegalFormatException

getMessage

java.lang.String getMessage(java.lang.String packs,
                            java.lang.String key,
                            java.util.Locale locale)

Returns localized message

Parameters:

packs - list of whitespace-separated package names. Searching of message is performed in reverse order - starts from last name in the list. Each package is searched for the key, if the key is not found in this package, it is searched in parent package, and so forth

key - message key

locale - message locale

Returns:

localized message or the key if the message not found

findMessage

@Nullable
java.lang.String findMessage(java.lang.String packs,
                                       java.lang.String key,
                                       @Nullable
                                       java.util.Locale locale)

Returns localized message or null if not found.

Parameters:

packs - list of whitespace-separated package names. Searching of message is performed in reverse order - starts from last name in the list. Each package is searched for the key, if the key is not found in this package, it is searched in parent package, and so forth

key - message key

locale - message locale. If null, current user locale is used.

Returns:

localized message or null if the message not found

formatMessage

java.lang.String formatMessage(java.lang.String pack,
                               java.lang.String key,
                               java.util.Locale locale,
                               java.lang.Object... params)

Get localized message and use it as a format string for parameters provided

Parameters:

pack - package name to start searching the message. If the key is not found in this package, it will be searched in parent package, and so forth

key - message key

locale - message locale

params - parameter values

Returns:

formatted string or the key in case of IllegalFormatException

getCacheSize

int getCacheSize()

clearCache

void clearCache()