Package org.apache.logging.log4j.message

Interface FlowMessageFactory

All Known Implementing Classes:
DefaultFlowMessageFactory
public interface FlowMessageFactory
Creates flow messages. Implementations can provide different message format syntaxes.
Since:
2.6

  • Method Details

    • newEntryMessage

      EntryMessage newEntryMessage(String message, Object... params)
      Creates a new entry message based on a format string with parameters.
      Parameters:
      message - format string
      params - parameters
      Returns:
      the new entry message
      Since:
      2.20.0

    • newEntryMessage

      EntryMessage newEntryMessage(Message message)
      Creates a new entry message based on an existing message.
      Parameters:
      message - the original message
      Returns:
      the new entry message

    • newExitMessage

      ExitMessage newExitMessage(String format, Object result)
      Creates a new exit message based on a return value and a forma string.
      Parameters:
      format - a format string
      result - the return value
      Returns:
      the new exit message
      Since:
      2.20.0

    • newExitMessage

      ExitMessage newExitMessage(Message message)
      Creates a new exit message based on no return value and an existing message.
      Parameters:
      message - the original entry message
      Returns:
      the new exit message
      Since:
      2.20.0

    • newExitMessage

      ExitMessage newExitMessage(Object result, Message message)
      Creates a new exit message based on a return value and an existing message.
      Parameters:
      result - the return value.
      message - the original message
      Returns:
      the new exit message

    • newExitMessage

      ExitMessage newExitMessage(EntryMessage message)
      Creates a new exit message based on no return value and an existing entry message.
      Parameters:
      message - the original entry message
      Returns:
      the new exit message

    • newExitMessage

      ExitMessage newExitMessage(Object result, EntryMessage message)
      Creates a new exit message based on a return value and an existing entry message.
      Parameters:
      result - the return value.
      message - the original entry message
      Returns:
      the new exit message