public abstract class MessageSourceSupport extends Object
MessageFormat
handling but not implementing concrete
methods defined in the MessageSource
.
AbstractMessageSource
derives from this class, providing concrete
getMessage
implementations that delegate to a central template
method for message code resolution.
Modifier and Type | Field and Description |
---|---|
protected Log |
logger
Logger available to subclasses.
|
Constructor and Description |
---|
MessageSourceSupport() |
Modifier and Type | Method and Description |
---|---|
protected MessageFormat |
createMessageFormat(String msg,
Locale locale)
Create a
MessageFormat for the given message and Locale. |
protected String |
formatMessage(String msg,
Object[] args,
Locale locale)
Format the given message String, using cached MessageFormats.
|
protected boolean |
isAlwaysUseMessageFormat()
Return whether to always apply the
MessageFormat rules, parsing even
messages without arguments. |
protected String |
renderDefaultMessage(String defaultMessage,
Object[] args,
Locale locale)
Render the given default message String.
|
protected Object[] |
resolveArguments(Object[] args,
Locale locale)
Template method for resolving argument objects.
|
void |
setAlwaysUseMessageFormat(boolean alwaysUseMessageFormat)
Set whether to always apply the
MessageFormat rules, parsing even
messages without arguments. |
protected final Log logger
public void setAlwaysUseMessageFormat(boolean alwaysUseMessageFormat)
MessageFormat
rules, parsing even
messages without arguments.
Default is false
: Messages without arguments are by default
returned as-is, without parsing them through MessageFormat
.
Set this to true
to enforce MessageFormat
for all messages,
expecting all message texts to be written with MessageFormat
escaping.
For example, MessageFormat
expects a single quote to be escaped
as two adjacent single quotes ("''"
). If your message texts are all
written with such escaping, even when not defining argument placeholders,
you need to set this flag to true
. Otherwise, only message texts
with actual arguments are supposed to be written with MessageFormat
escaping.
MessageFormat
protected boolean isAlwaysUseMessageFormat()
MessageFormat
rules, parsing even
messages without arguments.protected String renderDefaultMessage(String defaultMessage, @Nullable Object[] args, Locale locale)
The default implementation passes the String to formatMessage
,
resolving any argument placeholders found in them. Subclasses may override
this method to plug in custom processing of default messages.
defaultMessage
- the passed-in default message Stringargs
- array of arguments that will be filled in for params within
the message, or null
if none.locale
- the Locale used for formattingformatMessage(String, Object[], java.util.Locale)
protected String formatMessage(String msg, @Nullable Object[] args, Locale locale)
msg
- the message to formatargs
- array of arguments that will be filled in for params within
the message, or null
if nonelocale
- the Locale used for formattingprotected MessageFormat createMessageFormat(String msg, Locale locale)
MessageFormat
for the given message and Locale.msg
- the message to create a MessageFormat
forlocale
- the Locale to create a MessageFormat
forMessageFormat
instanceprotected Object[] resolveArguments(@Nullable Object[] args, Locale locale)
The default implementation simply returns the given argument array as-is. Can be overridden in subclasses in order to resolve special argument types.
args
- the original argument arraylocale
- the Locale to resolve against