Package org.apache.tapestry5.commons
Interface Messages
- All Known Implementing Classes:
AbstractMessages
,MapMessages
,MessagesImpl
public interface Messages
Provides access to a messages catalog, a set of properties files that provide localized messages for a particular
locale. The message catalog consists of keys and values and follows the semantics of a Java
ResourceBundle
with some changes.-
Method Summary
Modifier and TypeMethodDescriptionboolean
Returns true if the bundle contains the named key.Convenience for accessing a formatter and formatting a localized message with arguments.Returns the localized message for the given key.getFormatter
(String key) Returns a formatter for the message, which can be used to substitute arguments (as perFormatter
).getKeys()
Returns a set of all the keys for which this instance may provide a value.
-
Method Details
-
contains
Returns true if the bundle contains the named key. -
get
Returns the localized message for the given key. If catalog does not contain such a key, then a modified version of the key is returned (converted to upper case and enclosed in brackets).- Parameters:
key
-- Returns:
- localized message for key, or placeholder
-
getFormatter
Returns a formatter for the message, which can be used to substitute arguments (as perFormatter
).- Parameters:
key
-- Returns:
- formattable object
-
format
Convenience for accessing a formatter and formatting a localized message with arguments. -
getKeys
Returns a set of all the keys for which this instance may provide a value.- Returns:
- set of keys
- Since:
- 5.4
-