| java.lang.Object | |
| ↳ | org.springframework.context.support.MessageSourceAccessor |
Class Overview
Helper class for easy access to messages from a MessageSource, providing various overloaded getMessage methods.
Available from ApplicationObjectSupport, but also reusable as a standalone helper to delegate to in application objects.
See Also
Summary
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Create a new MessageSourceAccessor, using LocaleContextHolder's locale
as default locale.
| |||||||||||
Create a new MessageSourceAccessor, using the given default locale.
| |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Retrieve the message for the given code and the default Locale.
| |||||||||||
Retrieve the message for the given code and the default Locale.
| |||||||||||
Retrieve the message for the given code and the default Locale.
| |||||||||||
Retrieve the message for the given code and the given Locale.
| |||||||||||
Retrieve the message for the given code and the given Locale.
| |||||||||||
Retrieve the message for the given code and the given Locale.
| |||||||||||
Retrieve the given MessageSourceResolvable (e.g.
| |||||||||||
Retrieve the message for the given code and the given Locale.
| |||||||||||
Retrieve the message for the given code and the default Locale.
| |||||||||||
Retrieve the given MessageSourceResolvable (e.g.
| |||||||||||
| Protected Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Return the default locale to use if no explicit locale has been given.
| |||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
Public Constructors
public MessageSourceAccessor (MessageSource messageSource)
Create a new MessageSourceAccessor, using LocaleContextHolder's locale as default locale.
Parameters
| messageSource | the MessageSource to wrap |
|---|
See Also
public MessageSourceAccessor (MessageSource messageSource, Locale defaultLocale)
Create a new MessageSourceAccessor, using the given default locale.
Parameters
| messageSource | the MessageSource to wrap |
|---|---|
| defaultLocale | the default locale to use for message access |
Public Methods
public String getMessage (String code, Object[] args, String defaultMessage)
Retrieve the message for the given code and the default Locale.
Parameters
| code | code of the message |
|---|---|
| args | arguments for the message, or null if none |
| defaultMessage | String to return if the lookup fails |
Returns
- the message
public String getMessage (String code)
Retrieve the message for the given code and the default Locale.
Parameters
| code | code of the message |
|---|
Returns
- the message
Throws
| NoSuchMessageException | if not found |
|---|
public String getMessage (String code, String defaultMessage)
Retrieve the message for the given code and the default Locale.
Parameters
| code | code of the message |
|---|---|
| defaultMessage | String to return if the lookup fails |
Returns
- the message
public String getMessage (String code, String defaultMessage, Locale locale)
Retrieve the message for the given code and the given Locale.
Parameters
| code | code of the message |
|---|---|
| defaultMessage | String to return if the lookup fails |
| locale | Locale in which to do lookup |
Returns
- the message
public String getMessage (String code, Object[] args, Locale locale)
Retrieve the message for the given code and the given Locale.
Parameters
| code | code of the message |
|---|---|
| args | arguments for the message, or null if none |
| locale | Locale in which to do lookup |
Returns
- the message
Throws
| NoSuchMessageException | if not found |
|---|
public String getMessage (String code, Locale locale)
Retrieve the message for the given code and the given Locale.
Parameters
| code | code of the message |
|---|---|
| locale | Locale in which to do lookup |
Returns
- the message
Throws
| NoSuchMessageException | if not found |
|---|
public String getMessage (MessageSourceResolvable resolvable, Locale locale)
Retrieve the given MessageSourceResolvable (e.g. an ObjectError instance) in the given Locale.
Parameters
| resolvable | the MessageSourceResolvable |
|---|---|
| locale | Locale in which to do lookup |
Returns
- the message
Throws
| NoSuchMessageException | if not found |
|---|
public String getMessage (String code, Object[] args, String defaultMessage, Locale locale)
Retrieve the message for the given code and the given Locale.
Parameters
| code | code of the message |
|---|---|
| args | arguments for the message, or null if none |
| defaultMessage | String to return if the lookup fails |
| locale | Locale in which to do lookup |
Returns
- the message
public String getMessage (String code, Object[] args)
Retrieve the message for the given code and the default Locale.
Parameters
| code | code of the message |
|---|---|
| args | arguments for the message, or null if none |
Returns
- the message
Throws
| NoSuchMessageException | if not found |
|---|
public String getMessage (MessageSourceResolvable resolvable)
Retrieve the given MessageSourceResolvable (e.g. an ObjectError instance) in the default Locale.
Parameters
| resolvable | the MessageSourceResolvable |
|---|
Returns
- the message
Throws
| NoSuchMessageException | if not found |
|---|
Protected Methods
protected Locale getDefaultLocale ()
Return the default locale to use if no explicit locale has been given.
The default implementation returns the default locale passed into the corresponding constructor, or LocaleContextHolder's locale as fallback. Can be overridden in subclasses.