org.springframework.context

Interface MessageSource

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method and Description
      java.lang.String getMessage(MessageSourceResolvable resolvable, java.util.Locale locale)
      Try to resolve the message using all the attributes contained within the MessageSourceResolvable argument that was passed in.
      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.
    • Method Detail

      • getMessage

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

        java.lang.String getMessage(java.lang.String code,
                                    @Nullable
                                    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 - the code to lookup up, such as 'calculator.noRateSet'
        args - 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 - the locale in which to do the lookup
        Returns:
        the resolved message
        Throws:
        NoSuchMessageException - if the message wasn't found
        See Also:
        MessageFormat
      • getMessage

        java.lang.String getMessage(MessageSourceResolvable resolvable,
                                    java.util.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 - the value object storing attributes required to resolve a message
        locale - the locale in which to do the lookup
        Returns:
        the resolved message
        Throws:
        NoSuchMessageException - if the message wasn't found
        See Also:
        MessageFormat