Top Description Methods
org.apache.logging.log4j.message

public Interface FlowMessageFactory

Known Direct Implementers
org.apache.logging.log4j.message.DefaultFlowMessageFactory

Creates flow messages. Implementations can provide different message format syntaxes.
Since
2.6

Method Summary

Modifier and TypeMethod and Description
public EntryMessage

Returns:

the new entry message
newEntryMessage
(String
format string
message
,
Object...
parameters
params
)

Creates a new entry message based on a format string with parameters.

public EntryMessage

Returns:

the new entry message
newEntryMessage
(Message
the original message
message
)

Creates a new entry message based on an existing message.

public ExitMessage

Returns:

the new exit message
newExitMessage
(String
a format string
format
,
Object
the return value
result
)

Creates a new exit message based on a return value and a forma string.

public ExitMessage

Returns:

the new exit message
newExitMessage
(Message
the original entry message
message
)

Creates a new exit message based on no return value and an existing message.

public ExitMessage

Returns:

the new exit message
newExitMessage
(Object
the return value.
result
,
Message
the original message
message
)

Creates a new exit message based on a return value and an existing message.

public ExitMessage

Returns:

the new exit message
newExitMessage
(EntryMessage
the original entry message
message
)

Creates a new exit message based on no return value and an existing entry message.

public ExitMessage

Returns:

the new exit message
newExitMessage
(Object
the return value.
result
,
EntryMessage
the original entry message
message
)

Creates a new exit message based on a return value and an existing entry message.

Method Detail

newEntryMessageback to summary
public EntryMessage newEntryMessage(String message, Object... params)

Creates a new entry message based on a format string with parameters.

Parameters
message:String

format string

params:Object[]

parameters

Returns:EntryMessage

the new entry message

Since
2.20
newEntryMessageback to summary
public EntryMessage newEntryMessage(Message message)

Creates a new entry message based on an existing message.

Parameters
message:Message

the original message

Returns:EntryMessage

the new entry message

newExitMessageback to summary
public ExitMessage newExitMessage(String format, Object result)

Creates a new exit message based on a return value and a forma string.

Parameters
format:String

a format string

result:Object

the return value

Returns:ExitMessage

the new exit message

Since
2.20
newExitMessageback to summary
public ExitMessage newExitMessage(Message message)

Creates a new exit message based on no return value and an existing message.

Parameters
message:Message

the original entry message

Returns:ExitMessage

the new exit message

Since
2.20
newExitMessageback to summary
public ExitMessage newExitMessage(Object result, Message message)

Creates a new exit message based on a return value and an existing message.

Parameters
result:Object

the return value.

message:Message

the original message

Returns:ExitMessage

the new exit message

newExitMessageback to summary
public ExitMessage newExitMessage(EntryMessage message)

Creates a new exit message based on no return value and an existing entry message.

Parameters
message:EntryMessage

the original entry message

Returns:ExitMessage

the new exit message

newExitMessageback to summary
public ExitMessage newExitMessage(Object result, EntryMessage message)

Creates a new exit message based on a return value and an existing entry message.

Parameters
result:Object

the return value.

message:EntryMessage

the original entry message

Returns:ExitMessage

the new exit message