org.weda.message
Interface Messages

All Known Subinterfaces:

MessagesRegistry

All Known Implementing Classes:

AbstractMessages, MessagesImpl, MessagesSubset

public interface Messages

Цель: передоставление локализованного сообщения по его ключу

Author:

Mikhail Titov

Method Summary

java.lang.String	extractMessageKey(java.lang.String str) Метод вернет ключ сообщения если строка соотвествует формату prefix:message-key иначе метод вернет NULL.
java.lang.String	format(java.lang.String messageKey, java.lang.Object... args) Возвращает локализованное сообщение по его ключу предварительно отформивав его.
java.lang.String	getInPlacePrefix() Метод возвращает prefix который используется для указания ключа сообщения в строке.
java.lang.String	getMessage(java.lang.String messageKey) Возвращает локализованное сообщение по его ключу.
java.lang.String	replaceInPlace(java.lang.String str) Если str представлена в виде prefix:message-key (где prefix это по умолчанию message) тогда метод вернет локализованное сообщение соотвествующее ключу message-key

Method Detail

getMessage

java.lang.String getMessage(java.lang.String messageKey)

Возвращает локализованное сообщение по его ключу. Если локализованного сообщения для заданного ключа не существует тогда метод вернет [MESSAGE_KEY]

Parameters:

messageKey - ключ сообщения внутри элемента. Message key должен иметь следующий формат: message_category:message_element:element_target

format

java.lang.String format(java.lang.String messageKey,
                        java.lang.Object... args)

Возвращает локализованное сообщение по его ключу предварительно отформивав его. Иными словами, после того как метод найдет локализованное сообщение, вызвав getMessage(String), он попытается его отформатировать методом java.lang.String#format().

Parameters:

messageKey - ключ сообщение

args - знаачения которые будут подставлены вместо placeholder'ов.

extractMessageKey

java.lang.String extractMessageKey(java.lang.String str)

Метод вернет ключ сообщения если строка соотвествует формату prefix:message-key иначе метод вернет NULL.

replaceInPlace

java.lang.String replaceInPlace(java.lang.String str)

Если str представлена в виде prefix:message-key (где prefix это по умолчанию message) тогда метод вернет локализованное сообщение соотвествующее ключу message-key

See Also:

getMessage(String)

getInPlacePrefix

java.lang.String getInPlacePrefix()

Метод возвращает prefix который используется для указания ключа сообщения в строке.

See Also:

replaceInPlace(String)