Package org.apache.commons.jcs3.log

Class MessageFormatter

java.lang.Object

org.apache.commons.jcs3.log.MessageFormatter

public class MessageFormatter
extends Object

Handles messages that consist of a format string conforming to java.text.MessageFormat. (Borrowed from log4j2)

Constructor Summary

Constructors

Constructor	Description
MessageFormatter(String messagePattern, Object... parameters)	Constructs a message formatter.
MessageFormatter(String messagePattern, Supplier<?>... paramSuppliers)	Constructs a message formatter.

Method Summary

Modifier and Type	Method	Description
protected String	formatMessage(String msgPattern, Object... args)
String	getFormattedMessage()	Returns the formatted message.
Throwable	getThrowable()	Return the throwable passed to the Message.
boolean	hasThrowable()	Return true, if the parameters list contains a Throwable.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

MessageFormatter

public MessageFormatter(String messagePattern,
 Object... parameters)

Constructs a message formatter.

Parameters:

messagePattern - the pattern for this message format

parameters - The objects to format

MessageFormatter

public MessageFormatter(String messagePattern,
 Supplier<?>... paramSuppliers)

Constructs a message formatter.

Parameters:

messagePattern - the pattern for this message format

paramSuppliers - An array of functions, which when called, produce the desired log message parameters.

Method Details

getFormattedMessage

public String getFormattedMessage()

Returns the formatted message.

Returns:

the formatted message.

formatMessage

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

toString

public String toString()

Overrides:

toString in class Object

getThrowable

public Throwable getThrowable()

Return the throwable passed to the Message.

Returns:

the Throwable.

hasThrowable

public boolean hasThrowable()

Return true, if the parameters list contains a Throwable.

Returns:

true, if the parameters list contains a Throwable.