Package org.apache.logging.log4j.message

Class StringFormatterMessageFactory

java.lang.Object

org.apache.logging.log4j.message.AbstractMessageFactory

org.apache.logging.log4j.message.StringFormatterMessageFactory

All Implemented Interfaces:

Serializable, MessageFactory, MessageFactory2

public final class StringFormatterMessageFactory
extends AbstractMessageFactory

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

Enables the use of Formatter strings in message strings.

Creates StringFormattedMessage instances for newMessage(String, Object...).

This class is immutable.

Note to implementors

This class implements all MessageFactory2 methods.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final StringFormatterMessageFactory	INSTANCE	Instance of StringFormatterMessageFactory.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
Message	newMessage(String message, Object p0)	Creates a new parameterized message.
Message	newMessage(String message, Object... params)	Creates StringFormattedMessage instances.
Message	newMessage(String message, Object p0, Object p1)	Creates a new parameterized message.
Message	newMessage(String message, Object p0, Object p1, Object p2)	Creates a new parameterized message.
Message	newMessage(String message, Object p0, Object p1, Object p2, Object p3)	Creates a new parameterized message.
Message	newMessage(String message, Object p0, Object p1, Object p2, Object p3, Object p4)	Creates a new parameterized message.
Message	newMessage(String message, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5)	Creates a new parameterized message.
Message	newMessage(String message, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5, Object p6)	Creates a new parameterized message.
Message	newMessage(String message, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5, Object p6, Object p7)	Creates a new parameterized message.
Message	newMessage(String message, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5, Object p6, Object p7, Object p8)	Creates a new parameterized message.
Message	newMessage(String message, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5, Object p6, Object p7, Object p8, Object p9)	Creates a new parameterized message.

Methods inherited from class org.apache.logging.log4j.message.AbstractMessageFactory

newMessage, newMessage, newMessage

Methods inherited from class java.lang.Object

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

Field Details

INSTANCE

public static final StringFormatterMessageFactory INSTANCE

Instance of StringFormatterMessageFactory.

Constructor Details

StringFormatterMessageFactory

public StringFormatterMessageFactory()

Constructs a message factory with default flow strings.

Method Details

newMessage

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

Creates StringFormattedMessage instances.

Parameters:

message - The message pattern.

params - The parameters to the message.

Returns:

The Message.

See Also:

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

newMessage

public Message newMessage(String message,
 Object p0)

Description copied from interface: MessageFactory2

Creates a new parameterized message.

Specified by:

newMessage in interface MessageFactory2

Overrides:

newMessage in class AbstractMessageFactory

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(String message,
 Object p0,
 Object p1)

Description copied from interface: MessageFactory2

Creates a new parameterized message.

Specified by:

newMessage in interface MessageFactory2

Overrides:

newMessage in class AbstractMessageFactory

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(String message,
 Object p0,
 Object p1,
 Object p2)

Description copied from interface: MessageFactory2

Creates a new parameterized message.

Specified by:

newMessage in interface MessageFactory2

Overrides:

newMessage in class AbstractMessageFactory

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(String message,
 Object p0,
 Object p1,
 Object p2,
 Object p3)

Description copied from interface: MessageFactory2

Creates a new parameterized message.

Specified by:

newMessage in interface MessageFactory2

Overrides:

newMessage in class AbstractMessageFactory

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(String message,
 Object p0,
 Object p1,
 Object p2,
 Object p3,
 Object p4)

Description copied from interface: MessageFactory2

Creates a new parameterized message.

Specified by:

newMessage in interface MessageFactory2

Overrides:

newMessage in class AbstractMessageFactory

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(String message,
 Object p0,
 Object p1,
 Object p2,
 Object p3,
 Object p4,
 Object p5)

Description copied from interface: MessageFactory2

Creates a new parameterized message.

Specified by:

newMessage in interface MessageFactory2

Overrides:

newMessage in class AbstractMessageFactory

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(String message,
 Object p0,
 Object p1,
 Object p2,
 Object p3,
 Object p4,
 Object p5,
 Object p6)

Description copied from interface: MessageFactory2

Creates a new parameterized message.

Specified by:

newMessage in interface MessageFactory2

Overrides:

newMessage in class AbstractMessageFactory

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(String message,
 Object p0,
 Object p1,
 Object p2,
 Object p3,
 Object p4,
 Object p5,
 Object p6,
 Object p7)

Description copied from interface: MessageFactory2

Creates a new parameterized message.

Specified by:

newMessage in interface MessageFactory2

Overrides:

newMessage in class AbstractMessageFactory

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(String message,
 Object p0,
 Object p1,
 Object p2,
 Object p3,
 Object p4,
 Object p5,
 Object p6,
 Object p7,
 Object p8)

Description copied from interface: MessageFactory2

Creates a new parameterized message.

Specified by:

newMessage in interface MessageFactory2

Overrides:

newMessage in class AbstractMessageFactory

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(String message,
 Object p0,
 Object p1,
 Object p2,
 Object p3,
 Object p4,
 Object p5,
 Object p6,
 Object p7,
 Object p8,
 Object p9)

Description copied from interface: MessageFactory2

Creates a new parameterized message.

Specified by:

newMessage in interface MessageFactory2

Overrides:

newMessage in class AbstractMessageFactory

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