Modifier and Type	Class and Description
private static class	DefaultFlowMessageFactory.AbstractFlowMessage
private static class	DefaultFlowMessageFactory.SimpleEntryMessage
private static class	DefaultFlowMessageFactory.SimpleExitMessage

Modifier and Type	Field and Description
private static final String	ENTRY_DEFAULT_PREFIX
private final String	entryText
private static final String	EXIT_DEFAULT_PREFIX
private final String	exitText
private final MessageFactory	messageFactory
private static final long	serialVersionUID

Access	Constructor and Description
public	DefaultFlowMessageFactory() Constructs a message factory with `"Enter"` and `"Exit"` as the default flow strings.
public	DefaultFlowMessageFactory(final String the text to use for trace entry, like `"Enter"`. entryText, final String the text to use for trace exit, like `"Exit"`. exitText) Constructs a message factory with the given entry and exit strings.

Method Summary

Modifier and Type	Method and Description
private static MessageFactory	createDefaultMessageFactory()
public String	Returns: the entry text. getEntryText() Gets the entry text.
public String	Returns: the exit text. getExitText() Gets the exit text.
private Message	makeImmutable(final Message message)
public EntryMessage	newEntryMessage(final String format string format, final Object... parameters params) Implements org.apache.logging.log4j.message.FlowMessageFactory.newEntryMessage. Creates a new entry message based on a format string with parameters.
public EntryMessage	newEntryMessage(final Message the original message message) Implements org.apache.logging.log4j.message.FlowMessageFactory.newEntryMessage. Creates a new entry message based on an existing message.
public ExitMessage	newExitMessage(final String a format string format, final Object the return value result) Implements org.apache.logging.log4j.message.FlowMessageFactory.newExitMessage. Creates a new exit message based on a return value and a forma string.
public ExitMessage	newExitMessage(Message the original entry message message) Implements org.apache.logging.log4j.message.FlowMessageFactory.newExitMessage. Creates a new exit message based on no return value and an existing message.
public ExitMessage	newExitMessage(final EntryMessage the original entry message message) Implements org.apache.logging.log4j.message.FlowMessageFactory.newExitMessage. Creates a new exit message based on no return value and an existing entry message.
public ExitMessage	newExitMessage(final Object the return value. result, final EntryMessage the original entry message message) Implements org.apache.logging.log4j.message.FlowMessageFactory.newExitMessage. Creates a new exit message based on a return value and an existing entry message.
public ExitMessage	newExitMessage(final Object the return value. result, final Message the original message message) Implements org.apache.logging.log4j.message.FlowMessageFactory.newExitMessage. Creates a new exit message based on a return value and an existing message.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

ENTRY_DEFAULT_PREFIX	back to summary
private static final String ENTRY_DEFAULT_PREFIX

entryText	back to summary
private final String entryText

EXIT_DEFAULT_PREFIX	back to summary
private static final String EXIT_DEFAULT_PREFIX

exitText	back to summary
private final String exitText

messageFactory	back to summary
private final MessageFactory messageFactory

serialVersionUID	back to summary
private static final long serialVersionUID

DefaultFlowMessageFactory	back to summary
public DefaultFlowMessageFactory() Constructs a message factory with `"Enter"` and `"Exit"` as the default flow strings.

DefaultFlowMessageFactory	back to summary
public DefaultFlowMessageFactory(final String entryText, final String exitText) Constructs a message factory with the given entry and exit strings. Parameters entryText:String the text to use for trace entry, like `"Enter"`. exitText:String the text to use for trace exit, like `"Exit"`.

Method Detail

createDefaultMessageFactory	back to summary
private static MessageFactory createDefaultMessageFactory()

getEntryText	back to summary
public String getEntryText() Gets the entry text. Returns:String the entry text.

getEntryText

back to summary

public String getEntryText()

Gets the entry text.

Returns:String: the entry text.

getExitText	back to summary
public String getExitText() Gets the exit text. Returns:String the exit text.

getExitText

back to summary

public String getExitText()

Gets the exit text.

Returns:String: the exit text.

makeImmutable	back to summary
private Message makeImmutable(final Message message)

newEntryMessage	back to summary
public EntryMessage newEntryMessage(final String format, final Object... params) Implements org.apache.logging.log4j.message.FlowMessageFactory.newEntryMessage. Doc from org.apache.logging.log4j.message.FlowMessageFactory.newEntryMessage. Creates a new entry message based on a format string with parameters. Parameters format:String format string params:Object[] parameters Returns:EntryMessage the new entry message Annotations @Override

newEntryMessage

back to summary

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

Implements org.apache.logging.log4j.message.FlowMessageFactory.newEntryMessage.

Doc from org.apache.logging.log4j.message.FlowMessageFactory.newEntryMessage.

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

Parameters

format:String: format string
params:Object[]: parameters

Returns:EntryMessage

the new entry message

Annotations

@Override

newEntryMessage	back to summary
public EntryMessage newEntryMessage(final Message message) Implements org.apache.logging.log4j.message.FlowMessageFactory.newEntryMessage. Doc from org.apache.logging.log4j.message.FlowMessageFactory.newEntryMessage. Creates a new entry message based on an existing message. Parameters message:Message the original message Returns:EntryMessage the new entry message Annotations @Override

newEntryMessage

back to summary

public EntryMessage newEntryMessage(final Message message)

Implements org.apache.logging.log4j.message.FlowMessageFactory.newEntryMessage.

Doc from org.apache.logging.log4j.message.FlowMessageFactory.newEntryMessage.

Creates a new entry message based on an existing message.

Parameters

message:Message: the original message

Returns:EntryMessage

the new entry message

Annotations

@Override

newExitMessage	back to summary
public ExitMessage newExitMessage(final String format, final Object result) Implements org.apache.logging.log4j.message.FlowMessageFactory.newExitMessage. Doc from org.apache.logging.log4j.message.FlowMessageFactory.newExitMessage. 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 Annotations @Override

newExitMessage

back to summary

public ExitMessage newExitMessage(final String format, final Object result)

Implements org.apache.logging.log4j.message.FlowMessageFactory.newExitMessage.

Doc from org.apache.logging.log4j.message.FlowMessageFactory.newExitMessage.

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

Annotations

@Override

newExitMessage	back to summary
public ExitMessage newExitMessage(Message message) Implements org.apache.logging.log4j.message.FlowMessageFactory.newExitMessage. Doc from org.apache.logging.log4j.message.FlowMessageFactory.newExitMessage. 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 Annotations @Override

newExitMessage

back to summary

public ExitMessage newExitMessage(Message message)

Implements org.apache.logging.log4j.message.FlowMessageFactory.newExitMessage.

Doc from org.apache.logging.log4j.message.FlowMessageFactory.newExitMessage.

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

Annotations

@Override

newExitMessage	back to summary
public ExitMessage newExitMessage(final EntryMessage message) Implements org.apache.logging.log4j.message.FlowMessageFactory.newExitMessage. Doc from org.apache.logging.log4j.message.FlowMessageFactory.newExitMessage. 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 Annotations @Override

newExitMessage

back to summary

public ExitMessage newExitMessage(final EntryMessage message)

Implements org.apache.logging.log4j.message.FlowMessageFactory.newExitMessage.

Doc from org.apache.logging.log4j.message.FlowMessageFactory.newExitMessage.

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

Annotations

@Override

newExitMessage	back to summary
public ExitMessage newExitMessage(final Object result, final EntryMessage message) Implements org.apache.logging.log4j.message.FlowMessageFactory.newExitMessage. Doc from org.apache.logging.log4j.message.FlowMessageFactory.newExitMessage. 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 Annotations @Override

newExitMessage

back to summary

public ExitMessage newExitMessage(final Object result, final EntryMessage message)

Implements org.apache.logging.log4j.message.FlowMessageFactory.newExitMessage.

Doc from org.apache.logging.log4j.message.FlowMessageFactory.newExitMessage.

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

Annotations

@Override

newExitMessage	back to summary
public ExitMessage newExitMessage(final Object result, final Message message) Implements org.apache.logging.log4j.message.FlowMessageFactory.newExitMessage. Doc from org.apache.logging.log4j.message.FlowMessageFactory.newExitMessage. 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 Annotations @Override

newExitMessage

back to summary

public ExitMessage newExitMessage(final Object result, final Message message)

Implements org.apache.logging.log4j.message.FlowMessageFactory.newExitMessage.

Doc from org.apache.logging.log4j.message.FlowMessageFactory.newExitMessage.

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

Annotations

@Override

org.apache.logging.log4j.message back to summary

private Class DefaultFlowMessageFactory.AbstractFlowMessage

Class Inheritance

extends Object
implements FlowMessage, StringBuilderFormattable

java.lang.Object
org.apache.logging.log4j.message.DefaultFlowMessageFactory.AbstractFlowMessage

All Implemented Interfaces

org.apache.logging.log4j.util.StringBuilderFormattable, org.apache.logging.log4j.message.FlowMessage, org.apache.logging.log4j.message.Message, java.io.Serializable

Known Direct Subclasses

org.apache.logging.log4j.message.DefaultFlowMessageFactory.SimpleEntryMessage, org.apache.logging.log4j.message.DefaultFlowMessageFactory.SimpleExitMessage

Field Summary

Modifier and Type	Field and Description
private final Message	message
private static final long	serialVersionUID
private final String	text

Constructor Summary

Access	Constructor and Description
pack-priv	AbstractFlowMessage(final String text, final Message message)

Method Summary

Modifier and Type	Method and Description
public void	formatTo(final StringBuilder the StringBuilder to write into buffer) Implements org.apache.logging.log4j.util.StringBuilderFormattable.formatTo. Writes a text representation of this object into the specified `StringBuilder`, ideally without allocating temporary objects.
public String	getFormat() Implements org.apache.logging.log4j.message.Message.getFormat. Gets the format portion of the Message.
public String	getFormattedMessage() Implements org.apache.logging.log4j.message.Message.getFormattedMessage. Gets the Message formatted as a String.
public Message	getMessage() Implements org.apache.logging.log4j.message.FlowMessage.getMessage. The wrapped message
public Object[]	getParameters() Implements org.apache.logging.log4j.message.Message.getParameters. Gets parameter values, if any.
public String	getText() Implements org.apache.logging.log4j.message.FlowMessage.getText. The message text like "Enter" or "Exit" used to prefix the actual Message.
public Throwable	getThrowable() Implements org.apache.logging.log4j.message.Message.getThrowable. Gets the throwable, if any.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

message	back to summary
private final Message message

serialVersionUID	back to summary
private static final long serialVersionUID

text	back to summary
private final String text

Constructor Detail

AbstractFlowMessage	back to summary
pack-priv AbstractFlowMessage(final String text, final Message message)

Method Detail

formatTo back to summary

formatTo	back to summary
public void formatTo(final StringBuilder buffer) Implements org.apache.logging.log4j.util.StringBuilderFormattable.formatTo. Doc from org.apache.logging.log4j.util.StringBuilderFormattable.formatTo. Writes a text representation of this object into the specified `StringBuilder`, ideally without allocating temporary objects. Parameters buffer:StringBuilder the StringBuilder to write into Annotations @Override

public void formatTo(final StringBuilder buffer)

Implements org.apache.logging.log4j.util.StringBuilderFormattable.formatTo.

Doc from org.apache.logging.log4j.util.StringBuilderFormattable.formatTo.

Writes a text representation of this object into the specified StringBuilder, ideally without allocating temporary objects.

Parameters

buffer:StringBuilder: the StringBuilder to write into

Annotations

@Override

getFormat	back to summary
public String getFormat() Implements org.apache.logging.log4j.message.Message.getFormat. Doc from org.apache.logging.log4j.message.Message.getFormat. Gets the format portion of the Message. Returns:String The message format. Some implementations, such as ParameterizedMessage, will use this as the message "pattern". Other Messages may simply return an empty String. TODO Do all messages have a format? What syntax? Using a Formatter object could be cleaner. (RG) In SimpleMessage the format is identical to the formatted message. In ParameterizedMessage and StructuredDataMessage it is not. It is up to the Message implementer to determine what this method will return. A Formatter is inappropriate as this is very specific to the Message implementation so it isn't clear to me how having a Formatter separate from the Message would be cleaner. Annotations @Override

getFormat

back to summary

public String getFormat()

Implements org.apache.logging.log4j.message.Message.getFormat.

Doc from org.apache.logging.log4j.message.Message.getFormat.

Gets the format portion of the Message.

Returns:String

The message format. Some implementations, such as ParameterizedMessage, will use this as the message "pattern". Other Messages may simply return an empty String. TODO Do all messages have a format? What syntax? Using a Formatter object could be cleaner. (RG) In SimpleMessage the format is identical to the formatted message. In ParameterizedMessage and StructuredDataMessage it is not. It is up to the Message implementer to determine what this method will return. A Formatter is inappropriate as this is very specific to the Message implementation so it isn't clear to me how having a Formatter separate from the Message would be cleaner.

Annotations

@Override

getFormattedMessage back to summary

getFormattedMessage	back to summary
public String getFormattedMessage() Implements org.apache.logging.log4j.message.Message.getFormattedMessage. Doc from org.apache.logging.log4j.message.Message.getFormattedMessage. 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. Returns:String The message String. Annotations @Override

public String getFormattedMessage()

Implements org.apache.logging.log4j.message.Message.getFormattedMessage.

Doc from org.apache.logging.log4j.message.Message.getFormattedMessage.

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.

Returns:String

The message String.

Annotations

@Override

getMessage	back to summary
public Message getMessage() Implements org.apache.logging.log4j.message.FlowMessage.getMessage. Doc from org.apache.logging.log4j.message.FlowMessage.getMessage. The wrapped message Returns:Message the wrapped message Annotations @Override

getMessage

back to summary

public Message getMessage()

Implements org.apache.logging.log4j.message.FlowMessage.getMessage.

Doc from org.apache.logging.log4j.message.FlowMessage.getMessage.

The wrapped message

Returns:Message

the wrapped message

Annotations

@Override

getParameters	back to summary
public Object[] getParameters() Implements org.apache.logging.log4j.message.Message.getParameters. Doc from org.apache.logging.log4j.message.Message.getParameters. Gets parameter values, if any. Returns:Object[] An array of parameter values or null. Annotations @Override

getParameters

back to summary

public Object[] getParameters()

Implements org.apache.logging.log4j.message.Message.getParameters.

Doc from org.apache.logging.log4j.message.Message.getParameters.

Gets parameter values, if any.

Returns:Object[]

An array of parameter values or null.

Annotations

@Override

getText	back to summary
public String getText() Implements org.apache.logging.log4j.message.FlowMessage.getText. Doc from org.apache.logging.log4j.message.FlowMessage.getText. The message text like "Enter" or "Exit" used to prefix the actual Message. Returns:String message text used to prefix the actual Message. Annotations @Override

getText

back to summary

public String getText()

Implements org.apache.logging.log4j.message.FlowMessage.getText.

Doc from org.apache.logging.log4j.message.FlowMessage.getText.

The message text like "Enter" or "Exit" used to prefix the actual Message.

Returns:String

message text used to prefix the actual Message.

Annotations

@Override

getThrowable	back to summary
public Throwable getThrowable() Implements org.apache.logging.log4j.message.Message.getThrowable. Doc from org.apache.logging.log4j.message.Message.getThrowable. Gets the throwable, if any. Returns:Throwable the throwable or null. Annotations @Override

getThrowable

back to summary

public Throwable getThrowable()

Implements org.apache.logging.log4j.message.Message.getThrowable.

Doc from org.apache.logging.log4j.message.Message.getThrowable.

Gets the throwable, if any.

Returns:Throwable

the throwable or null.

Annotations

@Override

org.apache.logging.log4j.message back to summary

private final Class DefaultFlowMessageFactory.SimpleEntryMessage

Class Inheritance

extends AbstractFlowMessage
implements EntryMessage

java.lang.Object
org.apache.logging.log4j.message.DefaultFlowMessageFactory.AbstractFlowMessage
org.apache.logging.log4j.message.DefaultFlowMessageFactory.SimpleEntryMessage

All Implemented Interfaces

org.apache.logging.log4j.message.EntryMessage, org.apache.logging.log4j.message.FlowMessage, org.apache.logging.log4j.message.Message, java.io.Serializable

Field Summary

Modifier and Type	Field and Description
private static final long	serialVersionUID Hides org.apache.logging.log4j.message.DefaultFlowMessageFactory.AbstractFlowMessage.serialVersionUID.

Constructor Summary

Access	Constructor and Description
pack-priv	SimpleEntryMessage(final String entryText, final Message message)

Method Summary

Inherited from org.apache.logging.log4j.message.DefaultFlowMessageFactory.AbstractFlowMessage:: formatTo getFormat getFormattedMessage getMessage getParameters getText getThrowable

Field Detail

serialVersionUID	back to summary
private static final long serialVersionUID Hides org.apache.logging.log4j.message.DefaultFlowMessageFactory.AbstractFlowMessage.serialVersionUID.

Constructor Detail

SimpleEntryMessage	back to summary
pack-priv SimpleEntryMessage(final String entryText, final Message message)

org.apache.logging.log4j.message back to summary

private final Class DefaultFlowMessageFactory.SimpleExitMessage

Class Inheritance

extends AbstractFlowMessage
implements ExitMessage

java.lang.Object
org.apache.logging.log4j.message.DefaultFlowMessageFactory.AbstractFlowMessage
org.apache.logging.log4j.message.DefaultFlowMessageFactory.SimpleExitMessage

All Implemented Interfaces

org.apache.logging.log4j.message.ExitMessage, org.apache.logging.log4j.message.FlowMessage, org.apache.logging.log4j.message.Message, java.io.Serializable

Field Summary

Modifier and Type	Field and Description
private final boolean	isVoid
private final Object	result
private static final long	serialVersionUID Hides org.apache.logging.log4j.message.DefaultFlowMessageFactory.AbstractFlowMessage.serialVersionUID.

Constructor Summary

Access	Constructor and Description
pack-priv	SimpleExitMessage(final String exitText, final EntryMessage message)
pack-priv	SimpleExitMessage(final String exitText, final Message message)
pack-priv	SimpleExitMessage(final String exitText, final Object result, final EntryMessage message)
pack-priv	SimpleExitMessage(final String exitText, final Object result, final Message message)

Method Summary

Modifier and Type	Method and Description
public String	getFormattedMessage() Overrides org.apache.logging.log4j.message.DefaultFlowMessageFactory.AbstractFlowMessage.getFormattedMessage. Implements org.apache.logging.log4j.message.Message.getFormattedMessage. Gets the Message formatted as a String.

Inherited from org.apache.logging.log4j.message.DefaultFlowMessageFactory.AbstractFlowMessage:: formatTo getFormat getMessage getParameters getText getThrowable

Field Detail

isVoid	back to summary
private final boolean isVoid

result	back to summary
private final Object result

serialVersionUID	back to summary
private static final long serialVersionUID Hides org.apache.logging.log4j.message.DefaultFlowMessageFactory.AbstractFlowMessage.serialVersionUID.

Constructor Detail

SimpleExitMessage	back to summary
pack-priv SimpleExitMessage(final String exitText, final EntryMessage message)

SimpleExitMessage	back to summary
pack-priv SimpleExitMessage(final String exitText, final Message message)

SimpleExitMessage	back to summary
pack-priv SimpleExitMessage(final String exitText, final Object result, final EntryMessage message)

SimpleExitMessage	back to summary
pack-priv SimpleExitMessage(final String exitText, final Object result, final Message message)

Method Detail

getFormattedMessage back to summary

public String getFormattedMessage()

Overrides org.apache.logging.log4j.message.DefaultFlowMessageFactory.AbstractFlowMessage.getFormattedMessage.

Implements org.apache.logging.log4j.message.Message.getFormattedMessage.

Doc from org.apache.logging.log4j.message.Message.getFormattedMessage.

Returns:String

The message String.

Annotations

@Override

public Class DefaultFlowMessageFactory

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class DefaultFlowMessageFactory.AbstractFlowMessage

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class DefaultFlowMessageFactory.SimpleEntryMessage

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

private final Class DefaultFlowMessageFactory.SimpleExitMessage

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail