FormattedMessage (log4j-api 2.20.0)

java.lang.Object
- org.apache.logging.log4j.message.FormattedMessage

All Implemented Interfaces:

Serializable, Message
```
public class FormattedMessage
extends Object
implements Message
```
Handles messages that contain a format String. Dynamically determines if the format conforms to MessageFormat or String.format and if not then uses ParameterizedMessage to format.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`FormattedMessage(Locale locale, String messagePattern, Object... arguments)` Constructs with a locale, a pattern and a parameter array.
`FormattedMessage(Locale locale, String messagePattern, Object arg)` Constructs with a locale, a pattern and a single parameter.
`FormattedMessage(Locale locale, String messagePattern, Object[] arguments, Throwable throwable)` Constructs with a locale, a pattern, a parameter array, and a throwable.
`FormattedMessage(Locale locale, String messagePattern, Object arg1, Object arg2)` Constructs with a locale, a pattern and two parameters.
`FormattedMessage(String messagePattern, Object... arguments)` Constructs with a pattern and a parameter array.
`FormattedMessage(String messagePattern, Object arg)` Constructs with a pattern and a single parameter.
`FormattedMessage(String messagePattern, Object[] arguments, Throwable throwable)` Constructs with a pattern, a parameter array, and a throwable.
`FormattedMessage(String messagePattern, Object arg1, Object arg2)` Constructs with a pattern and two parameters.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`String`	`getFormat()` Gets the message pattern.
`String`	`getFormattedMessage()` Gets the formatted message.
`protected Message`	`getMessage(String msgPattern, Object[] args, Throwable aThrowable)`
`Object[]`	`getParameters()` Gets the message parameters.
`Throwable`	`getThrowable()` Gets the throwable, if any.
`int`	`hashCode()`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - FormattedMessage
```
public FormattedMessage(Locale locale,
                        String messagePattern,
                        Object arg)
```
    Constructs with a locale, a pattern and a single parameter.
    
    Parameters:
    
    locale - The locale
    
    messagePattern - The message pattern.
    
    arg - The parameter.
    
    Since:
    
    2.6
  - FormattedMessage
```
public FormattedMessage(Locale locale,
                        String messagePattern,
                        Object arg1,
                        Object arg2)
```
    Constructs with a locale, a pattern and two parameters.
    
    Parameters:
    
    locale - The locale
    
    messagePattern - The message pattern.
    
    arg1 - The first parameter.
    
    arg2 - The second parameter.
    
    Since:
    
    2.6
  - FormattedMessage
```
public FormattedMessage(Locale locale,
                        String messagePattern,
                        Object... arguments)
```
    Constructs with a locale, a pattern and a parameter array.
    
    Parameters:
    
    locale - The locale
    
    messagePattern - The message pattern.
    
    arguments - The parameter.
    
    Since:
    
    2.6
  - FormattedMessage
```
public FormattedMessage(Locale locale,
                        String messagePattern,
                        Object[] arguments,
                        Throwable throwable)
```
    Constructs with a locale, a pattern, a parameter array, and a throwable.
    
    Parameters:
    
    locale - The Locale
    
    messagePattern - The message pattern.
    
    arguments - The parameter.
    
    throwable - The throwable
    
    Since:
    
    2.6
  - FormattedMessage
```
public FormattedMessage(String messagePattern,
                        Object arg)
```
    Constructs with a pattern and a single parameter.
    
    Parameters:
    
    messagePattern - The message pattern.
    
    arg - The parameter.
  - FormattedMessage
```
public FormattedMessage(String messagePattern,
                        Object arg1,
                        Object arg2)
```
    Constructs with a pattern and two parameters.
    
    Parameters:
    
    messagePattern - The message pattern.
    
    arg1 - The first parameter.
    
    arg2 - The second parameter.
  - FormattedMessage
```
public FormattedMessage(String messagePattern,
                        Object... arguments)
```
    Constructs with a pattern and a parameter array.
    
    Parameters:
    
    messagePattern - The message pattern.
    
    arguments - The parameter.
  - FormattedMessage
```
public FormattedMessage(String messagePattern,
                        Object[] arguments,
                        Throwable throwable)
```
    Constructs with a pattern, a parameter array, and a throwable.
    
    Parameters:
    
    messagePattern - The message pattern.
    
    arguments - The parameter.
    
    throwable - The throwable
- Method Detail
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - getFormat
```
public String getFormat()
```
    Gets the message pattern.
    
    Specified by:
    
    getFormat in interface Message
    
    Returns:
    
    the message pattern.
  - getFormattedMessage
```
public String getFormattedMessage()
```
    Gets the formatted message.
    
    Specified by:
    
    getFormattedMessage in interface Message
    
    Returns:
    
    the formatted message.
  - getMessage
```
protected Message getMessage(String msgPattern,
                             Object[] args,
                             Throwable aThrowable)
```
  - getParameters
```
public Object[] getParameters()
```
    Gets the message parameters.
    
    Specified by:
    
    getParameters in interface Message
    
    Returns:
    
    the message parameters.
  - getThrowable
```
public Throwable getThrowable()
```
    Description copied from interface: Message
    
    Gets the throwable, if any.
    
    Specified by:
    
    getThrowable in interface Message
    
    Returns:
    
    the throwable or null.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Copyright © 1999-2023 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 FormattedMessage

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FormattedMessage

FormattedMessage

FormattedMessage

FormattedMessage

FormattedMessage

FormattedMessage

FormattedMessage

FormattedMessage

Method Detail

equals

getFormat

getFormattedMessage

getMessage

getParameters

getThrowable

hashCode

toString