Package org.apache.logging.log4j.message

Class ReusableMessageFactory

java.lang.Object

org.apache.logging.log4j.message.ReusableMessageFactory

All Implemented Interfaces:

java.io.Serializable, MessageFactory, MessageFactory2

public final class ReusableMessageFactory
extends java.lang.Object
implements MessageFactory2, java.io.Serializable

Implementation of the MessageFactory interface that avoids allocating temporary objects where possible. Message instances are cached in a ThreadLocal and reused when a new message is requested within the same thread.

Since:

2.6

See Also:

ParameterizedMessageFactory, ReusableSimpleMessage, ReusableObjectMessage, ReusableParameterizedMessage, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	ReusableMessageFactory.SerializationProxy

Field Summary

Fields

Modifier and Type	Field	Description
static ReusableMessageFactory	INSTANCE	Instance of ReusableMessageFactory.
private static long	serialVersionUID
private java.lang.ThreadLocal<ReusableObjectMessage>	threadLocalObjectMessage
private java.lang.ThreadLocal<ReusableParameterizedMessage>	threadLocalParameterized
private java.lang.ThreadLocal<ReusableSimpleMessage>	threadLocalSimpleMessage

Constructor Summary

Constructors

Constructor	Description
ReusableMessageFactory()	Constructs a message factory.

Method Summary

Modifier and Type	Method	Description
private ReusableObjectMessage	getObject()
private ReusableParameterizedMessage	getParameterized()
private ReusableSimpleMessage	getSimple()
Message	newMessage(java.lang.CharSequence charSequence)	Creates a new message for the specified CharSequence.
Message	newMessage(java.lang.Object message)	Creates ReusableObjectMessage instances.
Message	newMessage(java.lang.String message)	Creates ReusableSimpleMessage instances.
Message	newMessage(java.lang.String message, java.lang.Object p0)	Creates a new parameterized message.
Message	newMessage(java.lang.String message, java.lang.Object... params)	Creates ReusableParameterizedMessage instances.
Message	newMessage(java.lang.String message, java.lang.Object p0, java.lang.Object p1)	Creates a new parameterized message.
Message	newMessage(java.lang.String message, java.lang.Object p0, java.lang.Object p1, java.lang.Object p2)	Creates a new parameterized message.
Message	newMessage(java.lang.String message, java.lang.Object p0, java.lang.Object p1, java.lang.Object p2, java.lang.Object p3)	Creates a new parameterized message.
Message	newMessage(java.lang.String message, java.lang.Object p0, java.lang.Object p1, java.lang.Object p2, java.lang.Object p3, java.lang.Object p4)	Creates a new parameterized message.
Message	newMessage(java.lang.String message, java.lang.Object p0, java.lang.Object p1, java.lang.Object p2, java.lang.Object p3, java.lang.Object p4, java.lang.Object p5)	Creates a new parameterized message.
Message	newMessage(java.lang.String message, java.lang.Object p0, java.lang.Object p1, java.lang.Object p2, java.lang.Object p3, java.lang.Object p4, java.lang.Object p5, java.lang.Object p6)	Creates a new parameterized message.
Message	newMessage(java.lang.String message, java.lang.Object p0, java.lang.Object p1, java.lang.Object p2, java.lang.Object p3, java.lang.Object p4, java.lang.Object p5, java.lang.Object p6, java.lang.Object p7)	Creates a new parameterized message.
Message	newMessage(java.lang.String message, java.lang.Object p0, java.lang.Object p1, java.lang.Object p2, java.lang.Object p3, java.lang.Object p4, java.lang.Object p5, java.lang.Object p6, java.lang.Object p7, java.lang.Object p8)	Creates a new parameterized message.
Message	newMessage(java.lang.String message, java.lang.Object p0, java.lang.Object p1, java.lang.Object p2, java.lang.Object p3, java.lang.Object p4, java.lang.Object p5, java.lang.Object p6, java.lang.Object p7, java.lang.Object p8, java.lang.Object p9)	Creates a new parameterized message.
static void	release(Message message)	Invokes Clearable.clear() when possible.
private java.lang.Object	writeReplace()

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static final ReusableMessageFactory INSTANCE

Instance of ReusableMessageFactory.

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

threadLocalParameterized

private final transient java.lang.ThreadLocal<ReusableParameterizedMessage> threadLocalParameterized

threadLocalSimpleMessage

private final transient java.lang.ThreadLocal<ReusableSimpleMessage> threadLocalSimpleMessage

threadLocalObjectMessage

private final transient java.lang.ThreadLocal<ReusableObjectMessage> threadLocalObjectMessage

Constructor Detail

ReusableMessageFactory

public ReusableMessageFactory()

Constructs a message factory.

Method Detail

getParameterized

private ReusableParameterizedMessage getParameterized()

getSimple

private ReusableSimpleMessage getSimple()

getObject

private ReusableObjectMessage getObject()

release

public static void release(Message message)

Invokes Clearable.clear() when possible. This flag is used internally to verify that a reusable message is no longer in use and can be reused.

Parameters:

message - the message to make available again

Since:

2.7

newMessage

public Message newMessage(java.lang.CharSequence charSequence)

Description copied from interface: MessageFactory2

Creates a new message for the specified CharSequence.

Specified by:

newMessage in interface MessageFactory2

Parameters:

charSequence - the (potentially mutable) CharSequence

Returns:

a new message for the specified CharSequence

newMessage

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

Creates ReusableParameterizedMessage instances.

Specified by:

newMessage in interface MessageFactory

Parameters:

message - The message pattern.

params - The message parameters.

Returns:

The Message.

See Also:

MessageFactory.newMessage(String, Object...)

newMessage

public Message newMessage(java.lang.String message,
                          java.lang.Object p0)

Description copied from interface: MessageFactory2

Creates a new parameterized message.

Specified by:

newMessage in interface MessageFactory2

Parameters:

message - a message template, the kind of message template depends on the implementation.

p0 - a message parameter

Returns:

a new message

See Also:

ParameterizedMessageFactory

newMessage

public Message newMessage(java.lang.String message,
                          java.lang.Object p0,
                          java.lang.Object p1)

Description copied from interface: MessageFactory2

Creates a new parameterized message.

Specified by:

newMessage in interface MessageFactory2

Parameters:

message - a message template, the kind of message template depends on the implementation.

p0 - a message parameter

p1 - a message parameter

Returns:

a new message

See Also:

ParameterizedMessageFactory

newMessage

public Message newMessage(java.lang.String message,
                          java.lang.Object p0,
                          java.lang.Object p1,
                          java.lang.Object p2)

Description copied from interface: MessageFactory2

Creates a new parameterized message.

Specified by:

newMessage in interface MessageFactory2

Parameters:

message - a message template, the kind of message template depends on the implementation.

p0 - a message parameter

p1 - a message parameter

p2 - a message parameter

Returns:

a new message

See Also:

ParameterizedMessageFactory

newMessage

public Message newMessage(java.lang.String message,
                          java.lang.Object p0,
                          java.lang.Object p1,
                          java.lang.Object p2,
                          java.lang.Object p3)

Description copied from interface: MessageFactory2

Creates a new parameterized message.

Specified by:

newMessage in interface MessageFactory2

Parameters:

message - a message template, the kind of message template depends on the implementation.

p0 - a message parameter

p1 - a message parameter

p2 - a message parameter

p3 - a message parameter

Returns:

a new message

See Also:

ParameterizedMessageFactory

newMessage

public Message newMessage(java.lang.String message,
                          java.lang.Object p0,
                          java.lang.Object p1,
                          java.lang.Object p2,
                          java.lang.Object p3,
                          java.lang.Object p4)

Description copied from interface: MessageFactory2

Creates a new parameterized message.

Specified by:

newMessage in interface MessageFactory2

Parameters:

message - a message template, the kind of message template depends on the implementation.

p0 - a message parameter

p1 - a message parameter

p2 - a message parameter

p3 - a message parameter

p4 - a message parameter

Returns:

a new message

See Also:

ParameterizedMessageFactory

newMessage

public Message newMessage(java.lang.String message,
                          java.lang.Object p0,
                          java.lang.Object p1,
                          java.lang.Object p2,
                          java.lang.Object p3,
                          java.lang.Object p4,
                          java.lang.Object p5)

Description copied from interface: MessageFactory2

Creates a new parameterized message.

Specified by:

newMessage in interface MessageFactory2

Parameters:

message - a message template, the kind of message template depends on the implementation.

p0 - a message parameter

p1 - a message parameter

p2 - a message parameter

p3 - a message parameter

p4 - a message parameter

p5 - a message parameter

Returns:

a new message

See Also:

ParameterizedMessageFactory

newMessage

public Message newMessage(java.lang.String message,
                          java.lang.Object p0,
                          java.lang.Object p1,
                          java.lang.Object p2,
                          java.lang.Object p3,
                          java.lang.Object p4,
                          java.lang.Object p5,
                          java.lang.Object p6)

Description copied from interface: MessageFactory2

Creates a new parameterized message.

Specified by:

newMessage in interface MessageFactory2

Parameters:

message - a message template, the kind of message template depends on the implementation.

p0 - a message parameter

p1 - a message parameter

p2 - a message parameter

p3 - a message parameter

p4 - a message parameter

p5 - a message parameter

p6 - a message parameter

Returns:

a new message

See Also:

ParameterizedMessageFactory

newMessage

public Message newMessage(java.lang.String message,
                          java.lang.Object p0,
                          java.lang.Object p1,
                          java.lang.Object p2,
                          java.lang.Object p3,
                          java.lang.Object p4,
                          java.lang.Object p5,
                          java.lang.Object p6,
                          java.lang.Object p7)

Description copied from interface: MessageFactory2

Creates a new parameterized message.

Specified by:

newMessage in interface MessageFactory2

Parameters:

message - a message template, the kind of message template depends on the implementation.

p0 - a message parameter

p1 - a message parameter

p2 - a message parameter

p3 - a message parameter

p4 - a message parameter

p5 - a message parameter

p6 - a message parameter

p7 - a message parameter

Returns:

a new message

See Also:

ParameterizedMessageFactory

newMessage

public Message newMessage(java.lang.String message,
                          java.lang.Object p0,
                          java.lang.Object p1,
                          java.lang.Object p2,
                          java.lang.Object p3,
                          java.lang.Object p4,
                          java.lang.Object p5,
                          java.lang.Object p6,
                          java.lang.Object p7,
                          java.lang.Object p8)

Description copied from interface: MessageFactory2

Creates a new parameterized message.

Specified by:

newMessage in interface MessageFactory2

Parameters:

message - a message template, the kind of message template depends on the implementation.

p0 - a message parameter

p1 - a message parameter

p2 - a message parameter

p3 - a message parameter

p4 - a message parameter

p5 - a message parameter

p6 - a message parameter

p7 - a message parameter

p8 - a message parameter

Returns:

a new message

See Also:

ParameterizedMessageFactory

newMessage

public Message newMessage(java.lang.String message,
                          java.lang.Object p0,
                          java.lang.Object p1,
                          java.lang.Object p2,
                          java.lang.Object p3,
                          java.lang.Object p4,
                          java.lang.Object p5,
                          java.lang.Object p6,
                          java.lang.Object p7,
                          java.lang.Object p8,
                          java.lang.Object p9)

Description copied from interface: MessageFactory2

Creates a new parameterized message.

Specified by:

newMessage in interface MessageFactory2

Parameters:

message - a message template, the kind of message template depends on the implementation.

p0 - a message parameter

p1 - a message parameter

p2 - a message parameter

p3 - a message parameter

p4 - a message parameter

p5 - a message parameter

p6 - a message parameter

p7 - a message parameter

p8 - a message parameter

p9 - a message parameter

Returns:

a new message

See Also:

ParameterizedMessageFactory

newMessage

public Message newMessage(java.lang.String message)

Creates ReusableSimpleMessage instances.

Specified by:

newMessage in interface MessageFactory

Parameters:

message - The message String.

Returns:

The Message.

See Also:

MessageFactory.newMessage(String)

newMessage

public Message newMessage(java.lang.Object message)

Creates ReusableObjectMessage instances.

Specified by:

newMessage in interface MessageFactory

Parameters:

message - The message Object.

Returns:

The Message.

See Also:

MessageFactory.newMessage(Object)

writeReplace

private java.lang.Object writeReplace()