Package org.apache.logging.log4j.message

Class AbstractMessageFactory

java.lang.Object

org.apache.logging.log4j.message.AbstractMessageFactory

All Implemented Interfaces:

java.io.Serializable, MessageFactory, MessageFactory2

Direct Known Subclasses:

FormattedMessageFactory, LocalizedMessageFactory, MessageFormatMessageFactory, ParameterizedMessageFactory, ParameterizedNoReferenceMessageFactory, SimpleMessageFactory, StringFormatterMessageFactory

public abstract class AbstractMessageFactory
extends java.lang.Object
implements MessageFactory2, java.io.Serializable

Provides an abstract superclass for MessageFactory2 implementations with default implementations (and for MessageFactory by extension).

This class is immutable.

Note to implementors:

Subclasses can implement the MessageFactory2 methods when they can most effectively build Message instances. If a subclass does not implement MessageFactory2 methods, these calls are routed through MessageFactory.newMessage(String, Object...) in this class.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
private static long	serialVersionUID

Constructor Summary

Constructors

Constructor	Description
AbstractMessageFactory()

Method Summary

Modifier and Type	Method	Description
Message	newMessage(java.lang.CharSequence message)	Creates a new message for the specified CharSequence.
Message	newMessage(java.lang.Object message)	Creates a new message based on an Object.
Message	newMessage(java.lang.String message)	Creates a new message based on a String.
Message	newMessage(java.lang.String message, java.lang.Object p0)	Creates a new parameterized message.
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.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.logging.log4j.message.MessageFactory

newMessage

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

AbstractMessageFactory

public AbstractMessageFactory()

Method Detail

newMessage

public Message newMessage(java.lang.CharSequence message)

Description copied from interface: MessageFactory2

Creates a new message for the specified CharSequence.

Specified by:

newMessage in interface MessageFactory2

Parameters:

message - the (potentially mutable) CharSequence

Returns:

a new message for the specified CharSequence

newMessage

public Message newMessage(java.lang.Object message)

Description copied from interface: MessageFactory

Creates a new message based on an Object.

Specified by:

newMessage in interface MessageFactory

Parameters:

message - a message object

Returns:

a new message

newMessage

public Message newMessage(java.lang.String message)

Description copied from interface: MessageFactory

Creates a new message based on a String.

Specified by:

newMessage in interface MessageFactory

Parameters:

message - a message String

Returns:

a new message

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

Since:

2.6.1

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

Since:

2.6.1

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

Since:

2.6.1

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

Since:

2.6.1

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

Since:

2.6.1

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

Since:

2.6.1

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

Since:

2.6.1

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

Since:

2.6.1

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

Since:

2.6.1

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

Since:

2.6.1

See Also:

ParameterizedMessageFactory