Package org.apache.logging.log4j.message

Class StringFormattedMessage

java.lang.Object

org.apache.logging.log4j.message.StringFormattedMessage

All Implemented Interfaces:

Serializable, Message

public class StringFormattedMessage
extends Object
implements Message

Handles messages that consist of a format string conforming to Formatter.

Note to implementors:

This class implements the unrolled args API even though StringFormattedMessage does not. This leaves the room for StringFormattedMessage to unroll itself later.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
private Object[]	argArray
private String	formattedMessage
private static final int	HASHVAL
private final Locale	locale
private static final Logger	LOGGER
private String	messagePattern
private static final long	serialVersionUID
private String[]	stringArgs
private Throwable	throwable

Constructor Summary

Constructors

Constructor	Description
StringFormattedMessage(String messagePattern, Object... arguments)	Constructs a message.
StringFormattedMessage(Locale locale, String messagePattern, Object... arguments)	Constructs a message.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
protected String	formatMessage(String msgPattern, Object... args)
String	getFormat()	Returns the message pattern.
String	getFormattedMessage()	Returns the formatted message.
Object[]	getParameters()	Returns the message parameters.
Throwable	getThrowable()	Return the throwable passed to the Message.
int	hashCode()
private void	readObject(ObjectInputStream in)
String	toString()
private void	writeObject(ObjectOutputStream out)

Methods inherited from class java.lang.Object

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

Field Details

LOGGER

private static final Logger LOGGER

serialVersionUID

private static final long serialVersionUID

See Also:

• Constant Field Values

HASHVAL

private static final int HASHVAL

See Also:

• Constant Field Values

messagePattern

private String messagePattern

argArray

private transient Object[] argArray

stringArgs

private String[] stringArgs

formattedMessage

private transient String formattedMessage

throwable

private transient Throwable throwable

locale

private final Locale locale

Constructor Details

StringFormattedMessage

public StringFormattedMessage(Locale locale,
 String messagePattern,
 Object... arguments)

Constructs a message.

Parameters:

locale - the locale for this message format

messagePattern - the pattern for this message format

arguments - The objects to format

Since:

2.6

StringFormattedMessage

public StringFormattedMessage(String messagePattern,
 Object... arguments)

Constructs a message.

Parameters:

messagePattern - the pattern for this message format

arguments - The objects to format

Since:

2.6

Method Details

getFormattedMessage

public String getFormattedMessage()

Returns the formatted message.

Specified by:

getFormattedMessage in interface Message

Returns:

the formatted message.

getFormat

public String getFormat()

Returns the message pattern.

Specified by:

getFormat in interface Message

Returns:

the message pattern.

getParameters

public Object[] getParameters()

Returns the message parameters.

Specified by:

getParameters in interface Message

Returns:

the message parameters.

formatMessage

protected String formatMessage(String msgPattern,
 Object... args)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

writeObject

private void writeObject(ObjectOutputStream out)
                  throws IOException

Throws:

IOException

readObject

private void readObject(ObjectInputStream in)
                 throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException

getThrowable

public Throwable getThrowable()

Return the throwable passed to the Message.

Specified by:

getThrowable in interface Message

Returns:

the Throwable.