Package org.apache.logging.log4j.message

Class LocalizedMessage

  • All Implemented Interfaces:
    java.io.Serializable, LoggerNameAwareMessage, Message
    public class LocalizedMessage
extends java.lang.Object
implements Message, LoggerNameAwareMessage
    Provides some level of compatibility with Log4j 1.x and convenience but is not the recommended way to Localize messages.

    The recommended way to localize messages is to log a message id. Log events should then be recorded without formatting into a data store. The application that is used to read the events and display them to the user can then localize and format the messages for the end user.

    See Also:
    Serialized Form

    • Constructor Summary

      Constructors 
      Constructor Description
      LocalizedMessage​(java.lang.String messagePattern, java.lang.Object arg)  
      LocalizedMessage​(java.lang.String messagePattern, java.lang.Object[] arguments)
      Constructor with message pattern and arguments.
      LocalizedMessage​(java.lang.String messagePattern, java.lang.Object arg1, java.lang.Object arg2)  
      LocalizedMessage​(java.lang.String baseName, java.lang.String key, java.lang.Object arg)  
      LocalizedMessage​(java.lang.String baseName, java.lang.String key, java.lang.Object[] arguments)  
      LocalizedMessage​(java.lang.String baseName, java.lang.String key, java.lang.Object arg1, java.lang.Object arg2)  
      LocalizedMessage​(java.lang.String baseName, java.util.Locale locale, java.lang.String key, java.lang.Object arg)  
      LocalizedMessage​(java.lang.String baseName, java.util.Locale locale, java.lang.String key, java.lang.Object[] arguments)  
      LocalizedMessage​(java.lang.String baseName, java.util.Locale locale, java.lang.String key, java.lang.Object arg1, java.lang.Object arg2)  
      LocalizedMessage​(java.util.Locale locale, java.lang.String key, java.lang.Object arg)  
      LocalizedMessage​(java.util.Locale locale, java.lang.String key, java.lang.Object[] arguments)  
      LocalizedMessage​(java.util.Locale locale, java.lang.String key, java.lang.Object arg1, java.lang.Object arg2)  
      LocalizedMessage​(java.util.ResourceBundle bundle, java.lang.String key)  
      LocalizedMessage​(java.util.ResourceBundle bundle, java.lang.String key, java.lang.Object arg)  
      LocalizedMessage​(java.util.ResourceBundle bundle, java.lang.String key, java.lang.Object[] arguments)  
      LocalizedMessage​(java.util.ResourceBundle bundle, java.lang.String key, java.lang.Object arg1, java.lang.Object arg2)  
      LocalizedMessage​(java.util.ResourceBundle bundle, java.util.Locale locale, java.lang.String key, java.lang.Object arg)  
      LocalizedMessage​(java.util.ResourceBundle bundle, java.util.Locale locale, java.lang.String key, java.lang.Object[] arguments)  
      LocalizedMessage​(java.util.ResourceBundle bundle, java.util.Locale locale, java.lang.String key, java.lang.Object arg1, java.lang.Object arg2)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getFormat()
      Gets the format portion of the Message.
      java.lang.String getFormattedMessage()
      Returns the formatted message after looking up the format in the resource bundle.
      java.lang.String getLoggerName()
      Returns the name of the Logger.
      java.lang.Object[] getParameters()
      Gets parameter values, if any.
      java.lang.Throwable getThrowable()
      Gets the throwable, if any.
      void setLoggerName​(java.lang.String name)
      Set the name of the Logger.
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • LocalizedMessage

        public LocalizedMessage​(java.lang.String messagePattern,
                        java.lang.Object[] arguments)
        Constructor with message pattern and arguments.
        Parameters:
        messagePattern - the message pattern that to be checked for placeholders.
        arguments - the argument array to be converted.

      • LocalizedMessage

        public LocalizedMessage​(java.lang.String baseName,
                        java.lang.String key,
                        java.lang.Object[] arguments)

      • LocalizedMessage

        public LocalizedMessage​(java.util.ResourceBundle bundle,
                        java.lang.String key,
                        java.lang.Object[] arguments)

      • LocalizedMessage

        public LocalizedMessage​(java.lang.String baseName,
                        java.util.Locale locale,
                        java.lang.String key,
                        java.lang.Object[] arguments)

      • LocalizedMessage

        public LocalizedMessage​(java.util.ResourceBundle bundle,
                        java.util.Locale locale,
                        java.lang.String key,
                        java.lang.Object[] arguments)

      • LocalizedMessage

        public LocalizedMessage​(java.util.Locale locale,
                        java.lang.String key,
                        java.lang.Object[] arguments)

      • LocalizedMessage

        public LocalizedMessage​(java.lang.String messagePattern,
                        java.lang.Object arg)

      • LocalizedMessage

        public LocalizedMessage​(java.lang.String baseName,
                        java.lang.String key,
                        java.lang.Object arg)

      • LocalizedMessage

        public LocalizedMessage​(java.util.ResourceBundle bundle,
                        java.lang.String key)
        Since:
        2.8

      • LocalizedMessage

        public LocalizedMessage​(java.util.ResourceBundle bundle,
                        java.lang.String key,
                        java.lang.Object arg)

      • LocalizedMessage

        public LocalizedMessage​(java.lang.String baseName,
                        java.util.Locale locale,
                        java.lang.String key,
                        java.lang.Object arg)

      • LocalizedMessage

        public LocalizedMessage​(java.util.ResourceBundle bundle,
                        java.util.Locale locale,
                        java.lang.String key,
                        java.lang.Object arg)

      • LocalizedMessage

        public LocalizedMessage​(java.util.Locale locale,
                        java.lang.String key,
                        java.lang.Object arg)

      • LocalizedMessage

        public LocalizedMessage​(java.lang.String messagePattern,
                        java.lang.Object arg1,
                        java.lang.Object arg2)

      • LocalizedMessage

        public LocalizedMessage​(java.lang.String baseName,
                        java.lang.String key,
                        java.lang.Object arg1,
                        java.lang.Object arg2)

      • LocalizedMessage

        public LocalizedMessage​(java.util.ResourceBundle bundle,
                        java.lang.String key,
                        java.lang.Object arg1,
                        java.lang.Object arg2)

      • LocalizedMessage

        public LocalizedMessage​(java.lang.String baseName,
                        java.util.Locale locale,
                        java.lang.String key,
                        java.lang.Object arg1,
                        java.lang.Object arg2)

      • LocalizedMessage

        public LocalizedMessage​(java.util.ResourceBundle bundle,
                        java.util.Locale locale,
                        java.lang.String key,
                        java.lang.Object arg1,
                        java.lang.Object arg2)

      • LocalizedMessage

        public LocalizedMessage​(java.util.Locale locale,
                        java.lang.String key,
                        java.lang.Object arg1,
                        java.lang.Object arg2)

    • Method Detail

      • setLoggerName

        public void setLoggerName​(java.lang.String name)
        Set the name of the Logger.
        Specified by:
        setLoggerName in interface LoggerNameAwareMessage
        Parameters:
        name - The name of the Logger.

      • getLoggerName

        public java.lang.String getLoggerName()
        Returns the name of the Logger.
        Specified by:
        getLoggerName in interface LoggerNameAwareMessage
        Returns:
        the name of the Logger.

      • getFormattedMessage

        public java.lang.String getFormattedMessage()
        Returns the formatted message after looking up the format in the resource bundle.
        Specified by:
        getFormattedMessage in interface Message
        Returns:
        The formatted message String.

      • getFormat

        public java.lang.String getFormat()
        Description copied from interface: Message
        Gets the format portion of the Message.
        Specified by:
        getFormat in interface Message
        Returns:
        The message format. Some implementations, such as ParameterizedMessage, will use this as the message "pattern". Other Messages may simply return an empty String. TODO Do all messages have a format? What syntax? Using a Formatter object could be cleaner. (RG) In SimpleMessage the format is identical to the formatted message. In ParameterizedMessage and StructuredDataMessage it is not. It is up to the Message implementer to determine what this method will return. A Formatter is inappropriate as this is very specific to the Message implementation so it isn't clear to me how having a Formatter separate from the Message would be cleaner.

      • getParameters

        public java.lang.Object[] getParameters()
        Description copied from interface: Message
        Gets parameter values, if any.
        Specified by:
        getParameters in interface Message
        Returns:
        An array of parameter values or null.

      • getThrowable

        public java.lang.Throwable getThrowable()
        Description copied from interface: Message
        Gets the throwable, if any.
        Specified by:
        getThrowable in interface Message
        Returns:
        the throwable or null.

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object