Package org.apache.logging.log4j.message

Class SimpleMessage

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.CharSequence, Message, org.apache.logging.log4j.util.StringBuilderFormattable
    public class SimpleMessage
extends java.lang.Object
implements Message, org.apache.logging.log4j.util.StringBuilderFormattable, java.lang.CharSequence
    The simplest possible implementation of Message. It just returns the String given as the constructor argument.
    See Also:
    Serialized Form

    • Constructor Summary

      Constructors 
      Constructor Description
      SimpleMessage()
      Basic constructor.
      SimpleMessage​(java.lang.CharSequence charSequence)
      Constructor that includes the message.
      SimpleMessage​(java.lang.String message)
      Constructor that includes the message.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      char charAt​(int index)  
      boolean equals​(java.lang.Object o)  
      void formatTo​(java.lang.StringBuilder buffer)  
      java.lang.String getFormat()
      Returns the message.
      java.lang.String getFormattedMessage()
      Returns the message.
      java.lang.Object[] getParameters()
      Returns null since there are no parameters.
      java.lang.Throwable getThrowable()
      Always returns null.
      int hashCode()  
      int length()  
      java.lang.CharSequence subSequence​(int start, int end)  
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

      • Methods inherited from interface java.lang.CharSequence

        chars, codePoints

    • Constructor Detail

      • SimpleMessage

        public SimpleMessage()
        Basic constructor.

      • SimpleMessage

        public SimpleMessage​(java.lang.String message)
        Constructor that includes the message.
        Parameters:
        message - The String message.

      • SimpleMessage

        public SimpleMessage​(java.lang.CharSequence charSequence)
        Constructor that includes the message.
        Parameters:
        charSequence - The CharSequence message.

    • Method Detail

      • getFormattedMessage

        public java.lang.String getFormattedMessage()
        Returns the message.
        Specified by:
        getFormattedMessage in interface Message
        Returns:
        the message.

      • formatTo

        public void formatTo​(java.lang.StringBuilder buffer)
        Specified by:
        formatTo in interface org.apache.logging.log4j.util.StringBuilderFormattable

      • getFormat

        public java.lang.String getFormat()
        Returns the message.
        Specified by:
        getFormat in interface Message
        Returns:
        the message.

      • getParameters

        public java.lang.Object[] getParameters()
        Returns null since there are no parameters.
        Specified by:
        getParameters in interface Message
        Returns:
        null.

      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • toString

        public java.lang.String toString()
        Specified by:
        toString in interface java.lang.CharSequence
        Overrides:
        toString in class java.lang.Object

      • getThrowable

        public java.lang.Throwable getThrowable()
        Always returns null.
        Specified by:
        getThrowable in interface Message
        Returns:
        null

      • length

        public int length()
        Specified by:
        length in interface java.lang.CharSequence

      • charAt

        public char charAt​(int index)
        Specified by:
        charAt in interface java.lang.CharSequence

      • subSequence

        public java.lang.CharSequence subSequence​(int start,
                                          int end)
        Specified by:
        subSequence in interface java.lang.CharSequence