Top Description Fields Constructors Methods
org.apache.logging.log4j.message

public final Class StringFormatterMessageFactory

extends AbstractMessageFactory
Class Inheritance

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

Enables the use of java.util.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.

Field Summary

Modifier and TypeField and Description
public static final StringFormatterMessageFactory
INSTANCE

Instance of StringFormatterMessageFactory.

private static final long

Constructor Summary

AccessConstructor and Description
public
StringFormatterMessageFactory()

Constructs a message factory with default flow strings.

Method Summary

Modifier and TypeMethod and Description
public Message

Returns:

The Message.
newMessage
(final String
The message pattern.
message
,
final Object...
The parameters to the message.
params
)

Implements org.apache.logging.log4j.message.MessageFactory.newMessage.

Creates StringFormattedMessage instances.

public Message
newMessage(final String
a message template, the kind of message template depends on the implementation.
message
,
final Object
a message parameter
p0
)

Overrides org.apache.logging.log4j.message.AbstractMessageFactory.newMessage.

Implements org.apache.logging.log4j.message.MessageFactory2.newMessage.

Creates a new parameterized message.

public Message
newMessage(final String
a message template, the kind of message template depends on the implementation.
message
,
final Object
a message parameter
p0
,
final Object
a message parameter
p1
)

Overrides org.apache.logging.log4j.message.AbstractMessageFactory.newMessage.

Implements org.apache.logging.log4j.message.MessageFactory2.newMessage.

Creates a new parameterized message.

public Message
newMessage(final String
a message template, the kind of message template depends on the implementation.
message
,
final Object
a message parameter
p0
,
final Object
a message parameter
p1
,
final Object
a message parameter
p2
)

Overrides org.apache.logging.log4j.message.AbstractMessageFactory.newMessage.

Implements org.apache.logging.log4j.message.MessageFactory2.newMessage.

Creates a new parameterized message.

public Message
newMessage(final String
a message template, the kind of message template depends on the implementation.
message
,
final Object
a message parameter
p0
,
final Object
a message parameter
p1
,
final Object
a message parameter
p2
,
final Object
a message parameter
p3
)

Overrides org.apache.logging.log4j.message.AbstractMessageFactory.newMessage.

Implements org.apache.logging.log4j.message.MessageFactory2.newMessage.

Creates a new parameterized message.

public Message
newMessage(final String
a message template, the kind of message template depends on the implementation.
message
,
final Object
a message parameter
p0
,
final Object
a message parameter
p1
,
final Object
a message parameter
p2
,
final Object
a message parameter
p3
,
final Object
a message parameter
p4
)

Overrides org.apache.logging.log4j.message.AbstractMessageFactory.newMessage.

Implements org.apache.logging.log4j.message.MessageFactory2.newMessage.

Creates a new parameterized message.

public Message
newMessage(final String
a message template, the kind of message template depends on the implementation.
message
,
final Object
a message parameter
p0
,
final Object
a message parameter
p1
,
final Object
a message parameter
p2
,
final Object
a message parameter
p3
,
final Object
a message parameter
p4
,
final Object
a message parameter
p5
)

Overrides org.apache.logging.log4j.message.AbstractMessageFactory.newMessage.

Implements org.apache.logging.log4j.message.MessageFactory2.newMessage.

Creates a new parameterized message.

public Message
newMessage(final String
a message template, the kind of message template depends on the implementation.
message
,
final Object
a message parameter
p0
,
final Object
a message parameter
p1
,
final Object
a message parameter
p2
,
final Object
a message parameter
p3
,
final Object
a message parameter
p4
,
final Object
a message parameter
p5
,
final Object
a message parameter
p6
)

Overrides org.apache.logging.log4j.message.AbstractMessageFactory.newMessage.

Implements org.apache.logging.log4j.message.MessageFactory2.newMessage.

Creates a new parameterized message.

public Message
newMessage(final String
a message template, the kind of message template depends on the implementation.
message
,
final Object
a message parameter
p0
,
final Object
a message parameter
p1
,
final Object
a message parameter
p2
,
final Object
a message parameter
p3
,
final Object
a message parameter
p4
,
final Object
a message parameter
p5
,
final Object
a message parameter
p6
,
final Object
a message parameter
p7
)

Overrides org.apache.logging.log4j.message.AbstractMessageFactory.newMessage.

Implements org.apache.logging.log4j.message.MessageFactory2.newMessage.

Creates a new parameterized message.

public Message
newMessage(final String
a message template, the kind of message template depends on the implementation.
message
,
final Object
a message parameter
p0
,
final Object
a message parameter
p1
,
final Object
a message parameter
p2
,
final Object
a message parameter
p3
,
final Object
a message parameter
p4
,
final Object
a message parameter
p5
,
final Object
a message parameter
p6
,
final Object
a message parameter
p7
,
final Object
a message parameter
p8
)

Overrides org.apache.logging.log4j.message.AbstractMessageFactory.newMessage.

Implements org.apache.logging.log4j.message.MessageFactory2.newMessage.

Creates a new parameterized message.

public Message
newMessage(final String
a message template, the kind of message template depends on the implementation.
message
,
final Object
a message parameter
p0
,
final Object
a message parameter
p1
,
final Object
a message parameter
p2
,
final Object
a message parameter
p3
,
final Object
a message parameter
p4
,
final Object
a message parameter
p5
,
final Object
a message parameter
p6
,
final Object
a message parameter
p7
,
final Object
a message parameter
p8
,
final Object
a message parameter
p9
)

Overrides org.apache.logging.log4j.message.AbstractMessageFactory.newMessage.

Implements org.apache.logging.log4j.message.MessageFactory2.newMessage.

Creates a new parameterized message.

Inherited from org.apache.logging.log4j.message.AbstractMessageFactory:
newMessagenewMessagenewMessage

Field Detail

INSTANCEback to summary
public static final StringFormatterMessageFactory INSTANCE

Instance of StringFormatterMessageFactory.

serialVersionUIDback to summary
private static final long serialVersionUID

Hides org.apache.logging.log4j.message.AbstractMessageFactory.serialVersionUID.

Constructor Detail

StringFormatterMessageFactoryback to summary
public StringFormatterMessageFactory()

Constructs a message factory with default flow strings.

Method Detail

newMessageback to summary
public Message newMessage(final String message, final Object... params)

Implements org.apache.logging.log4j.message.MessageFactory.newMessage.

Creates StringFormattedMessage instances.

Parameters
message:String

The message pattern.

params:Object[]

The parameters to the message.

Returns:Message

The Message.

Annotations
@Override
See Also
MessageFactory#newMessage(String, Object...)
newMessageback to summary
public Message newMessage(final String message, final Object p0)

Overrides org.apache.logging.log4j.message.AbstractMessageFactory.newMessage.

Implements org.apache.logging.log4j.message.MessageFactory2.newMessage.

Doc from org.apache.logging.log4j.message.MessageFactory2.newMessage.

Creates a new parameterized message.

Parameters
message:String

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

p0:Object

a message parameter

Returns:Message

a new message

Annotations
@Override
Since
2.6.1
newMessageback to summary
public Message newMessage(final String message, final Object p0, final Object p1)

Overrides org.apache.logging.log4j.message.AbstractMessageFactory.newMessage.

Implements org.apache.logging.log4j.message.MessageFactory2.newMessage.

Doc from org.apache.logging.log4j.message.MessageFactory2.newMessage.

Creates a new parameterized message.

Parameters
message:String

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

p0:Object

a message parameter

p1:Object

a message parameter

Returns:Message

a new message

Annotations
@Override
Since
2.6.1
newMessageback to summary
public Message newMessage(final String message, final Object p0, final Object p1, final Object p2)

Overrides org.apache.logging.log4j.message.AbstractMessageFactory.newMessage.

Implements org.apache.logging.log4j.message.MessageFactory2.newMessage.

Doc from org.apache.logging.log4j.message.MessageFactory2.newMessage.

Creates a new parameterized message.

Parameters
message:String

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

p0:Object

a message parameter

p1:Object

a message parameter

p2:Object

a message parameter

Returns:Message

a new message

Annotations
@Override
Since
2.6.1
newMessageback to summary
public Message newMessage(final String message, final Object p0, final Object p1, final Object p2, final Object p3)

Overrides org.apache.logging.log4j.message.AbstractMessageFactory.newMessage.

Implements org.apache.logging.log4j.message.MessageFactory2.newMessage.

Doc from org.apache.logging.log4j.message.MessageFactory2.newMessage.

Creates a new parameterized message.

Parameters
message:String

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

p0:Object

a message parameter

p1:Object

a message parameter

p2:Object

a message parameter

p3:Object

a message parameter

Returns:Message

a new message

Annotations
@Override
Since
2.6.1
newMessageback to summary
public Message newMessage(final String message, final Object p0, final Object p1, final Object p2, final Object p3, final Object p4)

Overrides org.apache.logging.log4j.message.AbstractMessageFactory.newMessage.

Implements org.apache.logging.log4j.message.MessageFactory2.newMessage.

Doc from org.apache.logging.log4j.message.MessageFactory2.newMessage.

Creates a new parameterized message.

Parameters
message:String

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

p0:Object

a message parameter

p1:Object

a message parameter

p2:Object

a message parameter

p3:Object

a message parameter

p4:Object

a message parameter

Returns:Message

a new message

Annotations
@Override
Since
2.6.1
newMessageback to summary
public Message newMessage(final String message, final Object p0, final Object p1, final Object p2, final Object p3, final Object p4, final Object p5)

Overrides org.apache.logging.log4j.message.AbstractMessageFactory.newMessage.

Implements org.apache.logging.log4j.message.MessageFactory2.newMessage.

Doc from org.apache.logging.log4j.message.MessageFactory2.newMessage.

Creates a new parameterized message.

Parameters
message:String

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

p0:Object

a message parameter

p1:Object

a message parameter

p2:Object

a message parameter

p3:Object

a message parameter

p4:Object

a message parameter

p5:Object

a message parameter

Returns:Message

a new message

Annotations
@Override
Since
2.6.1
newMessageback to summary
public Message newMessage(final String message, final Object p0, final Object p1, final Object p2, final Object p3, final Object p4, final Object p5, final Object p6)

Overrides org.apache.logging.log4j.message.AbstractMessageFactory.newMessage.

Implements org.apache.logging.log4j.message.MessageFactory2.newMessage.

Doc from org.apache.logging.log4j.message.MessageFactory2.newMessage.

Creates a new parameterized message.

Parameters
message:String

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

p0:Object

a message parameter

p1:Object

a message parameter

p2:Object

a message parameter

p3:Object

a message parameter

p4:Object

a message parameter

p5:Object

a message parameter

p6:Object

a message parameter

Returns:Message

a new message

Annotations
@Override
Since
2.6.1
newMessageback to summary
public Message newMessage(final String message, final Object p0, final Object p1, final Object p2, final Object p3, final Object p4, final Object p5, final Object p6, final Object p7)

Overrides org.apache.logging.log4j.message.AbstractMessageFactory.newMessage.

Implements org.apache.logging.log4j.message.MessageFactory2.newMessage.

Doc from org.apache.logging.log4j.message.MessageFactory2.newMessage.

Creates a new parameterized message.

Parameters
message:String

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

p0:Object

a message parameter

p1:Object

a message parameter

p2:Object

a message parameter

p3:Object

a message parameter

p4:Object

a message parameter

p5:Object

a message parameter

p6:Object

a message parameter

p7:Object

a message parameter

Returns:Message

a new message

Annotations
@Override
Since
2.6.1
newMessageback to summary
public Message newMessage(final String message, final Object p0, final Object p1, final Object p2, final Object p3, final Object p4, final Object p5, final Object p6, final Object p7, final Object p8)

Overrides org.apache.logging.log4j.message.AbstractMessageFactory.newMessage.

Implements org.apache.logging.log4j.message.MessageFactory2.newMessage.

Doc from org.apache.logging.log4j.message.MessageFactory2.newMessage.

Creates a new parameterized message.

Parameters
message:String

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

p0:Object

a message parameter

p1:Object

a message parameter

p2:Object

a message parameter

p3:Object

a message parameter

p4:Object

a message parameter

p5:Object

a message parameter

p6:Object

a message parameter

p7:Object

a message parameter

p8:Object

a message parameter

Returns:Message

a new message

Annotations
@Override
Since
2.6.1
newMessageback to summary
public Message newMessage(final String message, final Object p0, final Object p1, final Object p2, final Object p3, final Object p4, final Object p5, final Object p6, final Object p7, final Object p8, final Object p9)

Overrides org.apache.logging.log4j.message.AbstractMessageFactory.newMessage.

Implements org.apache.logging.log4j.message.MessageFactory2.newMessage.

Doc from org.apache.logging.log4j.message.MessageFactory2.newMessage.

Creates a new parameterized message.

Parameters
message:String

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

p0:Object

a message parameter

p1:Object

a message parameter

p2:Object

a message parameter

p3:Object

a message parameter

p4:Object

a message parameter

p5:Object

a message parameter

p6:Object

a message parameter

p7:Object

a message parameter

p8:Object

a message parameter

p9:Object

a message parameter

Returns:Message

a new message

Annotations
@Override
Since
2.6.1