Top Description Methods
org.springframework.context

public Interface MessageSource

Known Direct Subinterfaces
org.springframework.context.HierarchicalMessageSource, org.springframework.context.ApplicationContext
Imports
java.util.Locale, org.springframework.lang.Nullable
Strategy interface for resolving messages, with support for the parameterization and internationalization of such messages.

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

Authors
Rod Johnson, Juergen Hoeller
See Also
org.springframework.context.support.ResourceBundleMessageSource, org.springframework.context.support.ReloadableResourceBundleMessageSource

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

the resolved message if the lookup was successful, otherwise the default message passed as a parameter (which may be null)
getMessage(String
the message code to look up, e.g. 'calculator.noRateSet'. MessageSource users are encouraged to base message names on qualified class or package names, avoiding potential conflicts and ensuring maximum clarity.
code, Object[]
an 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
args, String
a default message to return if the lookup fails
defaultMessage, Locale
the locale in which to do the lookup
locale)

Try to resolve the message.

public String

Returns:

the resolved message (never null)
getMessage(String
the message code to look up, e.g. 'calculator.noRateSet'. MessageSource users are encouraged to base message names on qualified class or package names, avoiding potential conflicts and ensuring maximum clarity.
code, Object[]
an 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
args, Locale
the locale in which to do the lookup
locale)

Try to resolve the message.

public String

Returns:

the resolved message (never null since even a MessageSourceResolvable-provided default message needs to be non-null)
getMessage(MessageSourceResolvable
the value object storing attributes required to resolve a message (may include a default message)
resolvable, Locale
the locale in which to do the lookup
locale)

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.

Method Detail

getMessageback to summary
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
code:String

the message code to look up, e.g. 'calculator.noRateSet'. MessageSource users are encouraged to base message names on qualified class or package names, avoiding potential conflicts and ensuring maximum clarity.

args:Object[]

an 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

a default message to return if the lookup fails

locale:Locale

the locale in which to do the lookup

Returns:String

the resolved message if the lookup was successful, otherwise the default message passed as a parameter (which may be null)

Annotations
@Nullable
See Also
getMessage(MessageSourceResolvable, Locale), java.text.MessageFormat
getMessageback to summary
public String getMessage(String code, Object[] args, Locale locale) throws NoSuchMessageException

Try to resolve the message. Treat as an error if the message can't be found.

Parameters
code:String

the message code to look up, e.g. 'calculator.noRateSet'. MessageSource users are encouraged to base message names on qualified class or package names, avoiding potential conflicts and ensuring maximum clarity.

args:Object[]

an 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

Returns:String

the resolved message (never null)

Exceptions
NoSuchMessageException:
if no corresponding message was found
See Also
getMessage(MessageSourceResolvable, Locale), java.text.MessageFormat
getMessageback to summary
public String getMessage(MessageSourceResolvable resolvable, Locale locale) throws NoSuchMessageException

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
resolvable:MessageSourceResolvable

the value object storing attributes required to resolve a message (may include a default message)

locale:Locale

the locale in which to do the lookup

Returns:String

the resolved message (never null since even a MessageSourceResolvable-provided default message needs to be non-null)

Exceptions
NoSuchMessageException:
if no corresponding message was found (and no default message was provided by the MessageSourceResolvable)
See Also
MessageSourceResolvable#getCodes(), MessageSourceResolvable#getArguments(), MessageSourceResolvable#getDefaultMessage(), java.text.MessageFormat