Class DefaultFlowMessageFactory.SimpleExitMessage

java.lang.Object
org.apache.logging.log4j.message.DefaultFlowMessageFactory.AbstractFlowMessage
org.apache.logging.log4j.message.DefaultFlowMessageFactory.SimpleExitMessage
All Implemented Interfaces:
Serializable, ExitMessage, FlowMessage, Message
Enclosing class:
DefaultFlowMessageFactory

private static final class DefaultFlowMessageFactory.SimpleExitMessage extends DefaultFlowMessageFactory.AbstractFlowMessage implements ExitMessage
  • Field Details

    • serialVersionUID

      private static final long serialVersionUID
      See Also:
    • result

      private final Object result
    • isVoid

      private final boolean isVoid
  • Constructor Details

  • Method Details

    • 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
      Overrides:
      getFormattedMessage in class DefaultFlowMessageFactory.AbstractFlowMessage
      Returns:
      The message String.