Package org.apache.logging.log4j.message

Class ObjectMessage

  • All Implemented Interfaces:
    java.io.Serializable, Message, org.apache.logging.log4j.util.StringBuilderFormattable
    public class ObjectMessage
extends java.lang.Object
implements Message, org.apache.logging.log4j.util.StringBuilderFormattable
    Handles messages that contain an Object.
    See Also:
    Serialized Form

    • Constructor Summary

      Constructors 
      Constructor Description
      ObjectMessage​(java.lang.Object obj)
      Creates the ObjectMessage.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object o)  
      void formatTo​(java.lang.StringBuilder buffer)  
      java.lang.String getFormat()
      Returns the object formatted using its toString method.
      java.lang.String getFormattedMessage()
      Returns the formatted object message.
      java.lang.Object getParameter()
      Returns the object parameter.
      java.lang.Object[] getParameters()
      Returns the object as if it were a parameter.
      java.lang.Throwable getThrowable()
      Gets the message if it is a throwable.
      int hashCode()  
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • ObjectMessage

        public ObjectMessage​(java.lang.Object obj)
        Creates the ObjectMessage.
        Parameters:
        obj - The Object to format.

    • Method Detail

      • getFormattedMessage

        public java.lang.String getFormattedMessage()
        Returns the formatted object message.
        Specified by:
        getFormattedMessage in interface Message
        Returns:
        the formatted object 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 object formatted using its toString method.
        Specified by:
        getFormat in interface Message
        Returns:
        the String representation of the object.

      • getParameter

        public java.lang.Object getParameter()
        Returns the object parameter.
        Returns:
        The object.
        Since:
        2.7

      • getParameters

        public java.lang.Object[] getParameters()
        Returns the object as if it were a parameter.
        Specified by:
        getParameters in interface Message
        Returns:
        The object.

      • 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()
        Overrides:
        toString in class java.lang.Object

      • getThrowable

        public java.lang.Throwable getThrowable()
        Gets the message if it is a throwable.
        Specified by:
        getThrowable in interface Message
        Returns:
        the message if it is a throwable.