Eclipse
Eclipse
IDEA
IntelliJ
NetBeans
NetBeans
XpoLog
XpoLog
org.springframework.context
Interface MessageSource
Tab mode
public interface MessageSource
Interface to be implemented by objects that can resolve messages. This enables parameterization and internationalization of messages.

Spring provides two out-of-the-box implementations for production:

  • ResourceBundleMessageSource, built on standard java.util.ResourceBundle
  • ReloadableResourceBundleMessageSource, being able to reload message definitions without restarting the VM
SinceNot specified.
VersionNot specified.
AuthorRod Johnson, Juergen Hoeller
Wiki javadoc Use textile entry format.
Add your comments here.
Method Summary
String getMessage( String code, Object [] args, String defaultMessage, Locale locale )
Try to resolve the message.
String getMessage( String code, Object [] args, Locale locale )
Try to resolve the message.
String getMessage( MessageSourceResolvable resolvable, Locale locale )
Try to resolve the message using all the attributes contained within the MessageSourceResolvable argument that was passed in.
Method Detail
getMessage
public String getMessage ( String code, Object [] args, String defaultMessage, Locale locale )
Try to resolve the message. Return default message if no message was found.
Parameters
TypeNameDescription
String 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.
Object [] 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.
String defaultMessage String to return if the lookup fails
Locale locale the Locale in which to do the lookup
See also
Wiki javadoc Use textile entry format.
Add your comments here.
getMessage
public String getMessage ( String code, Object [] args, Locale locale )
throws
Try to resolve the message. Treat as an error if the message can't be found.
Parameters
TypeNameDescription
String code the code to lookup up, such as 'calculator.noRateSet'
Object [] 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 locale the Locale in which to do the lookup
Exceptions
NoSuchMessageException if the message wasn't found
See also
Wiki javadoc Use textile entry format.
Add your comments here.
getMessage
public String getMessage ( MessageSourceResolvable resolvable, Locale locale )
throws
Try to resolve the message using all the attributes contained within the 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.

Parameters
TypeNameDescription
MessageSourceResolvable resolvable value object storing attributes required to properly resolve a message
Locale locale the Locale in which to do the lookup
Exceptions
NoSuchMessageException if the message wasn't found
See also
Wiki javadoc Use textile entry format.
Add your comments here.