org.apache.logging.log4j.message

Class FormattedMessage

java.lang.Object

org.apache.logging.log4j.message.FormattedMessage

All Implemented Interfaces:

java.io.Serializable, Message

public class FormattedMessage
extends java.lang.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

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.Object[]	argArray
private static java.lang.String	FORMAT_SPECIFIER
private java.lang.String	formattedMessage
private static int	HASHVAL
private java.util.Locale	locale
private Message	message
private java.lang.String	messagePattern
private static java.util.regex.Pattern	MSG_PATTERN
private static long	serialVersionUID
private java.lang.String[]	stringArgs
private java.lang.Throwable	throwable

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
java.lang.String	getFormat() Gets the message pattern.
java.lang.String	getFormattedMessage() Gets the formatted message.
protected Message	getMessage(java.lang.String msgPattern, java.lang.Object[] args, java.lang.Throwable aThrowable)
java.lang.Object[]	getParameters() Gets the message parameters.
java.lang.Throwable	getThrowable() Gets the throwable, if any.
int	hashCode()
private void	readObject(java.io.ObjectInputStream in)
java.lang.String	toString()
private void	writeObject(java.io.ObjectOutputStream out)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

HASHVAL

private static final int HASHVAL

See Also:

Constant Field Values

FORMAT_SPECIFIER

private static final java.lang.String FORMAT_SPECIFIER

See Also:

Constant Field Values

MSG_PATTERN

private static final java.util.regex.Pattern MSG_PATTERN

messagePattern

private java.lang.String messagePattern

argArray

private transient java.lang.Object[] argArray

stringArgs

private java.lang.String[] stringArgs

formattedMessage

private transient java.lang.String formattedMessage

throwable

private final java.lang.Throwable throwable

message

private Message message

locale

private final java.util.Locale locale

Constructor Detail

FormattedMessage

public FormattedMessage(java.util.Locale locale,
                        java.lang.String messagePattern,
                        java.lang.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(java.util.Locale locale,
                        java.lang.String messagePattern,
                        java.lang.Object arg1,
                        java.lang.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(java.util.Locale locale,
                        java.lang.String messagePattern,
                        java.lang.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(java.util.Locale locale,
                        java.lang.String messagePattern,
                        java.lang.Object[] arguments,
                        java.lang.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(java.lang.String messagePattern,
                        java.lang.Object arg)

Constructs with a pattern and a single parameter.

Parameters:

messagePattern - The message pattern.

arg - The parameter.

FormattedMessage

public FormattedMessage(java.lang.String messagePattern,
                        java.lang.Object arg1,
                        java.lang.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(java.lang.String messagePattern,
                        java.lang.Object... arguments)

Constructs with a pattern and a parameter array.

Parameters:

messagePattern - The message pattern.

arguments - The parameter.

FormattedMessage

public FormattedMessage(java.lang.String messagePattern,
                        java.lang.Object[] arguments,
                        java.lang.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(java.lang.Object o)

Overrides:

equals in class java.lang.Object

getFormat

public java.lang.String getFormat()

Gets the message pattern.

Specified by:

getFormat in interface Message

Returns:

the message pattern.

getFormattedMessage

public java.lang.String getFormattedMessage()

Gets the formatted message.

Specified by:

getFormattedMessage in interface Message

Returns:

the formatted message.

getMessage

protected Message getMessage(java.lang.String msgPattern,
                             java.lang.Object[] args,
                             java.lang.Throwable aThrowable)

getParameters

public java.lang.Object[] getParameters()

Gets the message parameters.

Specified by:

getParameters in interface Message

Returns:

the message parameters.

getThrowable

public java.lang.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 java.lang.Object

readObject

private void readObject(java.io.ObjectInputStream in)
                 throws java.io.IOException,
                        java.lang.ClassNotFoundException

Throws:

java.io.IOException

java.lang.ClassNotFoundException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

writeObject

private void writeObject(java.io.ObjectOutputStream out)
                  throws java.io.IOException

Throws:

java.io.IOException