com.interface21.context
Interface MessageSource

All Known Subinterfaces:
ApplicationContext, NestingMessageSource, WebApplicationContext

public interface MessageSource

Interface to be implemented by objects that can resolve messages. This enables parameterization and internationalization of messages.

Author:
Rod Johnson

Method Summary
 java.lang.String getMessage(MessageSourceResolvable resolvable, java.util.Locale locale)
          Using all the attributes contained within the MessageSourceResolvable arg that was passed in (except for the locale attribute), try to resolve the message from the MessageSource contained within the Context. 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 attribute is null or not.
 java.lang.String getMessage(java.lang.String code, java.lang.Object[] args, java.util.Locale locale)
          Try to resolve the message.
 java.lang.String getMessage(java.lang.String code, java.lang.Object[] args, java.lang.String defaultMessage, java.util.Locale locale)
          Try to resolve the message.Return default message if no message was found.
 

Method Detail

getMessage

public java.lang.String getMessage(java.lang.String code,
                                   java.lang.Object[] args,
                                   java.lang.String defaultMessage,
                                   java.util.Locale locale)
Try to resolve the message.Return default message if no message was found.
Parameters:
code - 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.
locale - Locale in which to do lookup
defaultMessage - String to return if the lookup fails
Returns:
a resolved message if the lookup is successful; otherwise return the default message passed as a parameter
See Also:
java.text.MessageFormat

getMessage

public java.lang.String getMessage(java.lang.String code,
                                   java.lang.Object[] args,
                                   java.util.Locale locale)
                            throws NoSuchMessageException
Try to resolve the message. Treat as an error if the message can't be found.
Parameters:
code - 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 - Locale in which to do lookup
Returns:
message
Throws:
NoSuchMessageException - not found in any locale
See Also:
java.text.MessageFormat

getMessage

public java.lang.String getMessage(MessageSourceResolvable resolvable,
                                   java.util.Locale locale)
                            throws NoSuchMessageException
Using all the attributes contained within the MessageSourceResolvable arg that was passed in (except for the locale attribute), try to resolve the message from the MessageSource contained within the Context.

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 attribute is null or not.

Parameters:
resolvable - Value object storing 4 attributes required to properly resolve a message.
locale - Locale to be used as the "driver" to figuring out what message to return.
Returns:
message Resolved message.
Throws:
NoSuchMessageException - not found in any locale
See Also:
java.text.MessageFormat


Rod Johnson and Spring contributors 2001-2003.