|
The Spring Framework | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.springframework.context.support.AbstractMessageSource
public abstract class AbstractMessageSource
Abstract implementation of the HierarchicalMessageSource interface, implementing common handling of message variants, making it easy to implement a specific strategy for a concrete MessageSource.
Subclasses must implement the abstract resolveCode
method. For efficient resolution of messages without arguments, the
resolveCodeWithoutArguments
method should be overridden
as well, resolving messages without a MessageFormat being involved.
Note: By default, message texts are only parsed through MessageFormat if arguments have been passed in for the message. In case of no arguments, message texts will be returned as-is. As a consequence, you should only use MessageFormat escaping for messages with actual arguments, and keep all other messages unescaped. If you prefer to escape all messages, set the "alwaysUseMessageFormat" flag to "true".
Supports not only MessageSourceResolvables as primary messages but also resolution of message arguments that are in turn MessageSourceResolvables themselves.
This class does not implement caching of messages per code, thus subclasses can dynamically change messages over time. Subclasses are encouraged to cache their messages in a modification-aware fashion, allowing for hot deployment of updated messages.
resolveCode(String, java.util.Locale)
,
resolveCodeWithoutArguments(String, java.util.Locale)
,
setAlwaysUseMessageFormat(boolean)
,
MessageFormat
Field Summary | |
---|---|
protected Log |
logger
Logger available to subclasses |
Constructor Summary | |
---|---|
AbstractMessageSource()
|
Method Summary | |
---|---|
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 String |
getDefaultMessage(String code)
Return a fallback default message for the given code, if any. |
String |
getMessage(MessageSourceResolvable resolvable,
Locale locale)
Try to resolve the message using all the attributes contained within the MessageSourceResolvable argument that was passed in. |
String |
getMessage(String code,
Object[] args,
Locale locale)
Try to resolve the message. |
String |
getMessage(String code,
Object[] args,
String defaultMessage,
Locale locale)
Try to resolve the message. |
protected String |
getMessageFromParent(String code,
Object[] args,
Locale locale)
Try to retrieve the given message from the parent MessageSource, if any. |
protected String |
getMessageInternal(String code,
Object[] args,
Locale locale)
Resolve the given code and arguments as message in the given Locale, returning null if not found. |
MessageSource |
getParentMessageSource()
Return the parent of this MessageSource, or null if none. |
protected boolean |
isAlwaysUseMessageFormat()
Return whether to always apply the MessageFormat rules, parsing even messages without arguments. |
protected boolean |
isUseCodeAsDefaultMessage()
Return whether to use the message code as default message instead of throwing a NoSuchMessageException. |
protected String |
renderDefaultMessage(String defaultMessage,
Object[] args,
Locale locale)
Render the given default message String. |
protected Object[] |
resolveArguments(Object[] args,
Locale locale)
Search through the given array of objects, find any MessageSourceResolvable objects and resolve them. |
protected abstract MessageFormat |
resolveCode(String code,
Locale locale)
Subclasses must implement this method to resolve a message. |
protected String |
resolveCodeWithoutArguments(String code,
Locale locale)
Subclasses can override this method to resolve a message without arguments in an optimized fashion, that is, to resolve a message without involving a MessageFormat. |
void |
setAlwaysUseMessageFormat(boolean alwaysUseMessageFormat)
Set whether to always apply the MessageFormat rules, parsing even messages without arguments. |
void |
setParentMessageSource(MessageSource parent)
Set the parent that will be used to try to resolve messages that this object can't resolve. |
void |
setUseCodeAsDefaultMessage(boolean useCodeAsDefaultMessage)
Set whether to use the message code as default message instead of throwing a NoSuchMessageException. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected final Log logger
Constructor Detail |
---|
public AbstractMessageSource()
Method Detail |
---|
public void setParentMessageSource(MessageSource parent)
HierarchicalMessageSource
setParentMessageSource
in interface HierarchicalMessageSource
parent
- the parent MessageSource that will be used to
resolve messages that this object can't resolve.
May be null
, in which case no further resolution is possible.public MessageSource getParentMessageSource()
HierarchicalMessageSource
null
if none.
getParentMessageSource
in interface HierarchicalMessageSource
public void setUseCodeAsDefaultMessage(boolean useCodeAsDefaultMessage)
Note: In case of a MessageSourceResolvable with multiple codes (like a FieldError) and a MessageSource that has a parent MessageSource, do not activate "useCodeAsDefaultMessage" in the parent: Else, you'll get the first code returned as message by the parent, without attempts to check further codes.
To be able to work with "useCodeAsDefaultMessage" turned on in the parent,
AbstractMessageSource and AbstractApplicationContext contain special checks
to delegate to the internal getMessageInternal
method if available.
In general, it is recommended to just use "useCodeAsDefaultMessage" during
development and not rely on it in production in the first place, though.
getMessage(String, Object[], Locale)
,
getMessageInternal(java.lang.String, java.lang.Object[], java.util.Locale)
,
FieldError
protected boolean isUseCodeAsDefaultMessage()
Alternatively, consider overriding the getDefaultMessage
method to return a custom fallback message for an unresolvable code.
getDefaultMessage(String)
public void setAlwaysUseMessageFormat(boolean alwaysUseMessageFormat)
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 "''". If your message texts are all written with such escaping, even when not defining argument placeholders, you need to set this flag to "true". Else, only message texts with actual arguments are supposed to be written with MessageFormat escaping.
MessageFormat
protected boolean isAlwaysUseMessageFormat()
public final String getMessage(String code, Object[] args, String defaultMessage, Locale locale)
MessageSource
getMessage
in interface MessageSource
code
- the code to lookup up, such as 'calculator.noRateSet'. Users of
this class are encouraged to base message names on the relevant fully
qualified class name, thus avoiding conflict and ensuring maximum clarity.args
- array of arguments that will be filled in for params within
the message (params look like "{0}", "{1,date}", "{2,time}" within a message),
or null
if none.defaultMessage
- String to return if the lookup failslocale
- the Locale in which to do the lookup
MessageFormat
public final String getMessage(String code, Object[] args, Locale locale) throws NoSuchMessageException
MessageSource
getMessage
in interface MessageSource
code
- the code to lookup up, such as 'calculator.noRateSet'args
- Array of arguments that will be filled in for params within
the message (params look like "{0}", "{1,date}", "{2,time}" within a message),
or null
if none.locale
- the Locale in which to do the lookup
NoSuchMessageException
- if the message wasn't foundMessageFormat
public final String getMessage(MessageSourceResolvable resolvable, Locale locale) throws NoSuchMessageException
MessageSource
MessageSourceResolvable
argument that was passed in.
NOTE: We must throw a NoSuchMessageException
on this method
since at the time of calling this method we aren't able to determine if the
defaultMessage
property of the resolvable is null or not.
getMessage
in interface MessageSource
resolvable
- value object storing attributes required to properly resolve a messagelocale
- the Locale in which to do the lookup
NoSuchMessageException
- if the message wasn't foundMessageFormat
protected String getMessageInternal(String code, Object[] args, Locale locale)
code
- the code to lookup up, such as 'calculator.noRateSet'args
- array of arguments that will be filled in for params
within the messagelocale
- the Locale in which to do the lookup
null
if not foundgetMessage(String, Object[], String, Locale)
,
getMessage(String, Object[], Locale)
,
getMessage(MessageSourceResolvable, Locale)
,
setUseCodeAsDefaultMessage(boolean)
protected String getMessageFromParent(String code, Object[] args, Locale locale)
code
- the code to lookup up, such as 'calculator.noRateSet'args
- array of arguments that will be filled in for params
within the messagelocale
- the Locale in which to do the lookup
null
if not foundgetParentMessageSource()
protected String getDefaultMessage(String code)
Default is to return the code itself if "useCodeAsDefaultMessage"
is activated, or return no fallback else. In case of no fallback,
the caller will usually receive a NoSuchMessageException from
getMessage
.
code
- the message code that we couldn't resolve
and that we didn't receive an explicit default message for
null
if nonesetUseCodeAsDefaultMessage(boolean)
protected String renderDefaultMessage(String defaultMessage, Object[] args, Locale locale)
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 formatting
formatMessage(String, Object[], java.util.Locale)
protected String formatMessage(String msg, 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 none.locale
- the Locale used for formatting
protected MessageFormat createMessageFormat(String msg, Locale locale)
This implementation creates an empty MessageFormat first, populating it with Locale and pattern afterwards, to stay compatible with J2SE 1.3.
msg
- the message to create a MessageFormat forlocale
- the Locale to create a MessageFormat for
protected Object[] resolveArguments(Object[] args, Locale locale)
Allows for messages to have MessageSourceResolvables as arguments.
args
- array of arguments for a messagelocale
- the locale to resolve through
protected String resolveCodeWithoutArguments(String code, Locale locale)
The default implementation does use MessageFormat,
through delegating to the resolveCode
method.
Subclasses are encouraged to replace this with optimized resolution.
Unfortunately, java.text.MessageFormat
is not
implemented in an efficient fashion. In particular, it does not
detect that a message pattern doesn't contain argument placeholders
in the first place. Therefore, it's advisable to circumvent
MessageFormat completely for messages without arguments.
code
- the code of the message to resolvelocale
- the Locale to resolve the code for
(subclasses are encouraged to support internationalization)
null
if not foundresolveCode(java.lang.String, java.util.Locale)
,
MessageFormat
protected abstract MessageFormat resolveCode(String code, Locale locale)
Returns a MessageFormat instance rather than a message String, to allow for appropriate caching of MessageFormats in subclasses.
Subclasses are encouraged to provide optimized resolution
for messages without arguments, not involving MessageFormat.
See resolveCodeWithoutArguments
javadoc for details.
code
- the code of the message to resolvelocale
- the Locale to resolve the code for
(subclasses are encouraged to support internationalization)
null
if not foundresolveCodeWithoutArguments(String, java.util.Locale)
|
The Spring Framework | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |