Package org.apache.logging.log4j.message

Class DefaultFlowMessageFactory

java.lang.Object

org.apache.logging.log4j.message.DefaultFlowMessageFactory

All Implemented Interfaces:

Serializable, FlowMessageFactory

public class DefaultFlowMessageFactory
extends Object
implements FlowMessageFactory, Serializable

Default factory for flow messages.

Since:

2.6

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final FlowMessageFactory	INSTANCE

Constructor Summary

Constructors

Constructor	Description
DefaultFlowMessageFactory()	Constructs a message factory with "Enter" and "Exit" as the default flow strings.
DefaultFlowMessageFactory(String entryText, String exitText)	Constructs a message factory with the given entry and exit strings.

Method Summary

Modifier and Type	Method	Description
String	getEntryText()	Gets the entry text.
String	getExitText()	Gets the exit text.
EntryMessage	newEntryMessage(String format, 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(Object result, EntryMessage message)	Creates a new exit message based on a return value and an existing entry message.
ExitMessage	newExitMessage(Object result, Message message)	Creates a new exit message based on a return value and an existing message.
ExitMessage	newExitMessage(String format, 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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

INSTANCE

public static final FlowMessageFactory INSTANCE

Since:

2.24.0

Constructor Details

DefaultFlowMessageFactory

public DefaultFlowMessageFactory()

Constructs a message factory with "Enter" and "Exit" as the default flow strings.

DefaultFlowMessageFactory

public DefaultFlowMessageFactory(String entryText,
 String exitText)

Constructs a message factory with the given entry and exit strings.

Parameters:

entryText - the text to use for trace entry, like "Enter".

exitText - the text to use for trace exit, like "Exit".

Method Details

getEntryText

public String getEntryText()

Gets the entry text.

Returns:

the entry text.

getExitText

public String getExitText()

Gets the exit text.

Returns:

the exit text.

newEntryMessage

public EntryMessage newEntryMessage(String format,
 Object... params)

Description copied from interface: FlowMessageFactory

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

Specified by:

newEntryMessage in interface FlowMessageFactory

Parameters:

format - format string

params - parameters

Returns:

the new entry message

newEntryMessage

public EntryMessage newEntryMessage(Message message)

Description copied from interface: FlowMessageFactory

Creates a new entry message based on an existing message.

Specified by:

newEntryMessage in interface FlowMessageFactory

Parameters:

message - the original message

Returns:

the new entry message

newExitMessage

public ExitMessage newExitMessage(String format,
 Object result)

Description copied from interface: FlowMessageFactory

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

Specified by:

newExitMessage in interface FlowMessageFactory

Parameters:

format - a format string

result - the return value

Returns:

the new exit message

newExitMessage

public ExitMessage newExitMessage(Message message)

Description copied from interface: FlowMessageFactory

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

Specified by:

newExitMessage in interface FlowMessageFactory

Parameters:

message - the original entry message

Returns:

the new exit message

newExitMessage

public ExitMessage newExitMessage(EntryMessage message)

Description copied from interface: FlowMessageFactory

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

Specified by:

newExitMessage in interface FlowMessageFactory

Parameters:

message - the original entry message

Returns:

the new exit message

newExitMessage

public ExitMessage newExitMessage(Object result,
 EntryMessage message)

Description copied from interface: FlowMessageFactory

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

Specified by:

newExitMessage in interface FlowMessageFactory

Parameters:

result - the return value.

message - the original entry message

Returns:

the new exit message

newExitMessage

public ExitMessage newExitMessage(Object result,
 Message message)

Description copied from interface: FlowMessageFactory

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

Specified by:

newExitMessage in interface FlowMessageFactory

Parameters:

result - the return value.

message - the original message

Returns:

the new exit message