Class ParameterizedNoReferenceMessageFactory

java.lang.Object

org.apache.logging.log4j.message.AbstractMessageFactory

org.apache.logging.log4j.message.ParameterizedNoReferenceMessageFactory

All Implemented Interfaces:

Serializable, MessageFactory, MessageFactory2

public final class ParameterizedNoReferenceMessageFactory
extends AbstractMessageFactory

Creates FormattedMessage instances for MessageFactory2 methods (and MessageFactory by extension.)

Creates SimpleMessage objects that do not retain a reference to the parameter object.

Intended for use by the StatusLogger: this logger retains a queue of recently logged messages in memory, causing memory leaks in web applications. (LOG4J2-1176)

This class is immutable.

Note to implementors

This class does not implement any MessageFactory2 methods and lets the superclass funnel those calls through newMessage(String, Object...).

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	ParameterizedNoReferenceMessageFactory.StatusMessage	Message implementation that only keeps a reference to the error text and the error (if any), not to the message parameters, in order to avoid memory leaks.

Field Summary

Fields

Modifier and Type	Field	Description
static final ParameterizedNoReferenceMessageFactory	INSTANCE	Instance of ParameterizedStatusMessageFactory.
private static final long	serialVersionUID

Constructor Summary

Constructors

Constructor	Description
ParameterizedNoReferenceMessageFactory()	Constructs a message factory with default flow strings.

Method Summary

Modifier and Type	Method	Description
Message	newMessage(String message, Object... params)	Creates SimpleMessage instances containing the formatted parameterized message string.

Methods inherited from class AbstractMessageFactory

newMessage, newMessage, newMessage, newMessage, newMessage, newMessage, newMessage, newMessage, newMessage, newMessage, newMessage, newMessage, newMessage

Methods inherited from class Object

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

Field Details

serialVersionUID

private static final long serialVersionUID

See Also:

• Constant Field Values

INSTANCE

public static final ParameterizedNoReferenceMessageFactory INSTANCE

Instance of ParameterizedStatusMessageFactory.

Constructor Details

ParameterizedNoReferenceMessageFactory

public ParameterizedNoReferenceMessageFactory()

Constructs a message factory with default flow strings.

Method Details

newMessage

public Message newMessage(String message,
 Object... params)

Creates SimpleMessage instances containing the formatted parameterized message string.

Parameters:

message - The message pattern.

params - The message parameters.

Returns:

The Message.

See Also:

• MessageFactory.newMessage(String, Object...)