Package org.apache.logging.log4j.message

Class ReusableSimpleMessage

java.lang.Object
org.apache.logging.log4j.message.ReusableSimpleMessage
All Implemented Interfaces:
Serializable, CharSequence, Message, ParameterVisitable, ReusableMessage, StringBuilderFormattable
public class ReusableSimpleMessage extends Object implements ReusableMessage, CharSequence, ParameterVisitable
Mutable Message wrapper around a String message.
Since:
2.6
See Also:

  • Constructor Details

    • ReusableSimpleMessage

      public ReusableSimpleMessage()

  • Method Details

    • set

      public void set(String message)

    • set

      public void set(CharSequence charSequence)

    • getFormattedMessage

      public String getFormattedMessage()
      Description copied from interface: Message
      Gets the Message formatted as a String. Each Message implementation determines the appropriate way to format the data encapsulated in the Message. Messages that provide more than one way of formatting the Message will implement MultiformatMessage.

      When configured to log asynchronously, this method is called before the Message is queued, unless this message implements ReusableMessage or is annotated with AsynchronouslyFormattable. This gives the Message implementation class a chance to create a formatted message String with the current value of any mutable objects. The intention is that the Message implementation caches this formatted message and returns it on subsequent calls. (See LOG4J2-763.)

      When logging synchronously, this method will not be called for Messages that implement the StringBuilderFormattable interface: instead, the formatTo(StringBuilder) method will be called so the Message can format its contents without creating intermediate String objects.

      Specified by:
      getFormattedMessage in interface Message
      Returns:
      The message String.

    • getFormat

      public String getFormat()
      Description copied from interface: Message
      This method has unclear semantics and inconsistent implementations – its usage is strongly discouraged.
      Specified by:
      getFormat in interface Message

    • getParameters

      public 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 Throwable getThrowable()
      Description copied from interface: Message
      Gets the throwable, if any.
      Specified by:
      getThrowable in interface Message
      Returns:
      the throwable or null.

    • formatTo

      public void formatTo(StringBuilder buffer)
      Description copied from interface: StringBuilderFormattable
      Writes a text representation of this object into the specified StringBuilder, ideally without allocating temporary objects.
      Specified by:
      formatTo in interface StringBuilderFormattable
      Parameters:
      buffer - the StringBuilder to write into

    • swapParameters

      public Object[] swapParameters(Object[] emptyReplacement)
      This message does not have any parameters, so this method returns the specified array.
      Specified by:
      swapParameters in interface ReusableMessage
      Parameters:
      emptyReplacement - the parameter array to return
      Returns:
      the specified array
      See Also:

    • getParameterCount

      public short getParameterCount()
      This message does not have any parameters so this method always returns zero.
      Specified by:
      getParameterCount in interface ReusableMessage
      Returns:
      0 (zero)

    • forEachParameter

      public <S> void forEachParameter(ParameterConsumer<S> action, S state)
      Description copied from interface: ParameterVisitable
      Performs the given action for each parameter until all values have been processed or the action throws an exception.

      The second parameter lets callers pass in a stateful object to be modified with the key-value pairs, so the TriConsumer implementation itself can be stateless and potentially reusable.

      Specified by:
      forEachParameter in interface ParameterVisitable
      Type Parameters:
      S - type of the third parameter
      Parameters:
      action - The action to be performed for each key-value pair in this collection
      state - the object to be passed as the third parameter to each invocation on the specified ParameterConsumer.

    • memento

      public Message memento()
      Description copied from interface: ReusableMessage
      Returns an immutable snapshot of the current internal state of this reusable message. The returned snapshot will not be affected by subsequent modifications of this reusable message.
      Specified by:
      memento in interface ReusableMessage
      Returns:
      an immutable snapshot of this message

    • length

      public int length()
      Specified by:
      length in interface CharSequence

    • charAt

      public char charAt(int index)
      Specified by:
      charAt in interface CharSequence

    • subSequence

      public CharSequence subSequence(int start, int end)
      Specified by:
      subSequence in interface CharSequence

    • clear

      public void clear()
      Since:
      2.11.1