org.apache.struts.util
public abstract class MessageResources extends Object implements Serializable
MessageFormat
class to produce internationalized messages with parametric replacement.
Calls to getMessage()
variants without a Locale
argument are presumed to be requesting a message string in the default
Locale
for this JVM.
Calls to getMessage()
with an unknown key, or an unknown
Locale
will return null
if the
returnNull
property is set to true
. Otherwise,
a suitable error message will be returned instead.
IMPLEMENTATION NOTE - Classes that extend this class must be Serializable so that instances may be used in distributable application server environments.
Version: $Rev: 264684 $ $Date: 2005-08-30 04:08:01 +0100 (Tue, 30 Aug 2005) $
Field Summary | |
---|---|
protected String | config
The configuration parameter used to initialize this MessageResources. |
protected static MessageResourcesFactory | defaultFactory
The default MessageResourcesFactory used to create MessageResources
instances. |
protected Locale | defaultLocale
The default Locale for our environment. |
boolean | escape
Indicates whether 'escape processing' should be performed on
the error message string. |
protected MessageResourcesFactory | factory
The MessageResourcesFactory that created this instance. |
protected HashMap | formats
The set of previously created MessageFormat objects, keyed by the
key computed in messageKey() . |
protected static Log | log
Commons Logging instance. |
protected boolean | returnNull
Indicate is a null is returned instead of an error message string
when an unknown Locale or key is requested. |
Constructor Summary | |
---|---|
MessageResources(MessageResourcesFactory factory, String config)
Construct a new MessageResources according to the specified parameters.
| |
MessageResources(MessageResourcesFactory factory, String config, boolean returnNull)
Construct a new MessageResources according to the specified parameters.
|
Method Summary | |
---|---|
protected String | escape(String string)
Escape any single quote characters that are included in the specified
message string.
|
String | getConfig()
The configuration parameter used to initialize this MessageResources. |
MessageResourcesFactory | getFactory()
The MessageResourcesFactory that created this instance. |
String | getMessage(String key)
Returns a text message for the specified key, for the default Locale.
|
String | getMessage(String key, Object[] args)
Returns a text message after parametric replacement of the specified
parameter placeholders.
|
String | getMessage(String key, Object arg0)
Returns a text message after parametric replacement of the specified
parameter placeholders.
|
String | getMessage(String key, Object arg0, Object arg1)
Returns a text message after parametric replacement of the specified
parameter placeholders.
|
String | getMessage(String key, Object arg0, Object arg1, Object arg2)
Returns a text message after parametric replacement of the specified
parameter placeholders.
|
String | getMessage(String key, Object arg0, Object arg1, Object arg2, Object arg3)
Returns a text message after parametric replacement of the specified
parameter placeholders.
|
abstract String | getMessage(Locale locale, String key)
Returns a text message for the specified key, for the default Locale.
|
String | getMessage(Locale locale, String key, Object[] args)
Returns a text message after parametric replacement of the specified
parameter placeholders. |
String | getMessage(Locale locale, String key, Object arg0)
Returns a text message after parametric replacement of the specified
parameter placeholders. |
String | getMessage(Locale locale, String key, Object arg0, Object arg1)
Returns a text message after parametric replacement of the specified
parameter placeholders. |
String | getMessage(Locale locale, String key, Object arg0, Object arg1, Object arg2)
Returns a text message after parametric replacement of the specified
parameter placeholders. |
String | getMessage(Locale locale, String key, Object arg0, Object arg1, Object arg2, Object arg3)
Returns a text message after parametric replacement of the specified
parameter placeholders. |
static MessageResources | getMessageResources(String config)
Create and return an instance of MessageResources for the
created by the default MessageResourcesFactory .
|
boolean | getReturnNull()
Indicates that a null is returned instead of an error message string
if an unknown Locale or key is requested. |
boolean | isEscape()
Indicates whether 'escape processing' should be performed on
the error message string.
|
boolean | isPresent(String key)
Return true if there is a defined message for the specified
key in the system default locale.
|
boolean | isPresent(Locale locale, String key)
Return true if there is a defined message for the specified
key in the specified Locale.
|
protected String | localeKey(Locale locale)
Compute and return a key to be used in caching information by a Locale.
|
void | log(String message)
Log a message to the Writer that has been configured for our use.
|
void | log(String message, Throwable throwable)
Log a message and exception to the Writer that has been configured
for our use.
|
protected String | messageKey(Locale locale, String key)
Compute and return a key to be used in caching information
by Locale and message key.
|
protected String | messageKey(String localeKey, String key)
Compute and return a key to be used in caching information
by locale key and message key.
|
void | setEscape(boolean escape)
Set whether 'escape processing' should be performed on
the error message string.
|
void | setReturnNull(boolean returnNull)
Indicates that a null is returned instead of an error message string
if an unknown Locale or key is requested. |
MessageResourcesFactory
that created this instance.messageKey()
.null
is returned instead of an error message string
when an unknown Locale or key is requested.Parameters: factory The MessageResourcesFactory that created us config The configuration parameter for this MessageResources
Parameters: factory The MessageResourcesFactory that created us config The configuration parameter for this MessageResources returnNull The returnNull property we should initialize with
Parameters: string The string to be escaped
Returns: parameter used to initialize this MessageResources
MessageResourcesFactory
that created this instance.Returns: MessageResourcesFactory
that created instance
Parameters: key The message key to look up
Parameters: key The message key to look up args An array of replacement parameters for placeholders
Parameters: key The message key to look up arg0 The replacement for placeholder {0} in the message
Parameters: key The message key to look up arg0 The replacement for placeholder {0} in the message arg1 The replacement for placeholder {1} in the message
Parameters: key The message key to look up arg0 The replacement for placeholder {0} in the message arg1 The replacement for placeholder {1} in the message arg2 The replacement for placeholder {2} in the message
Parameters: key The message key to look up arg0 The replacement for placeholder {0} in the message arg1 The replacement for placeholder {1} in the message arg2 The replacement for placeholder {2} in the message arg3 The replacement for placeholder {3} in the message
returnNull
property is set. Otherwise, an appropriate
error message will be returned.
This method must be implemented by a concrete subclass.
Parameters: locale The requested message Locale, or null
for the system default Locale key The message key to look up
Parameters: locale The requested message Locale, or null
for the system default Locale key The message key to look up args An array of replacement parameters for placeholders
Parameters: locale The requested message Locale, or null
for the system default Locale key The message key to look up arg0 The replacement for placeholder {0} in the message
Parameters: locale The requested message Locale, or null
for the system default Locale key The message key to look up arg0 The replacement for placeholder {0} in the message arg1 The replacement for placeholder {1} in the message
Parameters: locale The requested message Locale, or null
for the system default Locale key The message key to look up arg0 The replacement for placeholder {0} in the message arg1 The replacement for placeholder {1} in the message arg2 The replacement for placeholder {2} in the message
Parameters: locale The requested message Locale, or null
for the system default Locale key The message key to look up arg0 The replacement for placeholder {0} in the message arg1 The replacement for placeholder {1} in the message arg2 The replacement for placeholder {2} in the message arg3 The replacement for placeholder {3} in the message
MessageResources
for the
created by the default MessageResourcesFactory
.
Parameters: config Configuration parameter for this message bundle.
null
is returned instead of an error message string
if an unknown Locale or key is requested.Returns: true if null is returned if unknown key or locale is requested
Since: Struts 1.2.8
true
if there is a defined message for the specified
key in the system default locale.
Parameters: key The message key to look up
true
if there is a defined message for the specified
key in the specified Locale.
Parameters: locale The requested message Locale, or null
for the system default Locale key The message key to look up
Parameters: locale The locale for which a key is desired
Parameters: message The message to be logged
Parameters: message The message to be logged throwable The exception to be logged
Parameters: locale The Locale for which this format key is calculated key The message key for which this format key is calculated
Parameters: localeKey The locale key for which this cache key is calculated key The message key for which this cache key is calculated
Since: Struts 1.2.8
null
is returned instead of an error message string
if an unknown Locale or key is requested.Parameters: returnNull true Indicates that a null
is returned
if an unknown Locale or key is requested.