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 Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description EntryMessage
newEntryMessage(java.lang.String message, java.lang.Object... params)
Creates a new entry message based on a format string with parameters.EntryMessage
newEntryMessage(Message message)
Creates a new entry message based on an existing message.ExitMessage
newExitMessage(java.lang.Object result, EntryMessage message)
Creates a new exit message based on a return value and an existing entry message.ExitMessage
newExitMessage(java.lang.Object result, Message message)
Creates a new exit message based on a return value and an existing message.ExitMessage
newExitMessage(java.lang.String format, java.lang.Object result)
Creates a new exit message based on a return value and a forma string.ExitMessage
newExitMessage(EntryMessage message)
Creates a new exit message based on no return value and an existing entry message.ExitMessage
newExitMessage(Message message)
Creates a new exit message based on no return value and an existing message.
-
-
-
Method Detail
-
newEntryMessage
EntryMessage newEntryMessage(java.lang.String message, java.lang.Object... params)
Creates a new entry message based on a format string with parameters.- Parameters:
message
- format stringparams
- parameters- Returns:
- the new entry message
- Since:
- 2.20
-
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(java.lang.String format, java.lang.Object result)
Creates a new exit message based on a return value and a forma string.- Parameters:
format
- a format stringresult
- the return value- Returns:
- the new exit message
- Since:
- 2.20
-
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
-
newExitMessage
ExitMessage newExitMessage(java.lang.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(java.lang.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
-
-