ParameterizedMessageFactory (Apache Log4j API 2.17.1 API)

java.lang.Object
- org.apache.logging.log4j.message.AbstractMessageFactory
- - org.apache.logging.log4j.message.ParameterizedMessageFactory

All Implemented Interfaces:

Serializable, MessageFactory, MessageFactory2
```
public final class ParameterizedMessageFactory
extends AbstractMessageFactory
```
Creates FormattedMessage instances for MessageFactory2 methods (and MessageFactory by extension.)
Enables the use of {} parameter markers in message strings.

Creates ParameterizedMessage 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 and Description

static ParameterizedMessageFactory INSTANCE
Instance of ParameterizedMessageFactory.

Fields
Modifier and Type	Field and Description
`static ParameterizedMessageFactory`	`INSTANCE` Instance of ParameterizedMessageFactory.

Constructor Summary

Constructors
Constructor and Description

ParameterizedMessageFactory()
Constructs a message factory.

Constructors
Constructor and Description
`ParameterizedMessageFactory()` Constructs a message factory.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Message`	`newMessage(String message, Object... params)` Creates `ParameterizedMessage` instances.
`Message`	`newMessage(String message, Object p0)` Creates a new parameterized message.
`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
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - INSTANCE
```
public static final ParameterizedMessageFactory INSTANCE
```
    Instance of ParameterizedMessageFactory.
- Constructor Detail
  - ParameterizedMessageFactory
```
public ParameterizedMessageFactory()
```
    Constructs a message factory.
- Method Detail
  - newMessage
```
public Message newMessage(String message,
                          Object... params)
```
    Creates ParameterizedMessage instances.
    
    Parameters:
    
    message - The message pattern.
    
    params - The message parameters.
    
    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

Copyright © 1999-1969 The Apache Software Foundation. All Rights Reserved.
Apache Logging, Apache Log4j, Log4j, Apache, the Apache feather logo, the Apache Logging project logo, and the Apache Log4j logo are trademarks of The Apache Software Foundation.

Class ParameterizedMessageFactory

Note to implementors

Field Summary

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

INSTANCE

Constructor Detail

ParameterizedMessageFactory

Method Detail

newMessage

newMessage

newMessage

newMessage

newMessage

newMessage

newMessage

newMessage

newMessage

newMessage

newMessage