Package de.galan.commons.logging

Class PayloadMessage

java.lang.Object

de.galan.commons.logging.PayloadMessage

All Implemented Interfaces:

Serializable, org.apache.logging.log4j.message.Message

public class PayloadMessage
extends Object
implements org.apache.logging.log4j.message.Message

(Log4j2) Message for Logger that support parameterized messages, using {} as placeholder, eg.:
info("Hello {}", "world"); // => "Hello {world}"
info("Hello {} {}", "beautiful", "world"); // => "Hello {beautiful} {world}"
error("Something failed: {}", ex, "do'h"); // => "Hello {beautiful} {world}"


It is also encouraged to give the parameter names with identifier set to true. This can be useful for later integrations/parsing. If no parameters are given, key will be generated as sequence numbers. Example:
info("Hello {}", "world"); // => "Hello {0:world}"
info("Hello {} {}", "beautiful", "world"); // => "Hello {0:beautiful} {1:world}"
info("The Answer is {answer}", 42L); // => "The Answer is {answer:42}"

You can omit the curly braces in the message by setting the environment-variable SAY_ENCLOSED to "false".

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
PayloadMessage(String messagePattern, Object[] argumentsObject)
PayloadMessage(String messagePattern, Object[] argumentsObject, boolean includeIdentifier, Throwable throwable)

Method Summary

Modifier and Type	Method	Description
protected String[]	argumentsToStrings(Object[] argumentsObject)
protected String	convertToString(Object object)
String	getFormat()
String	getFormattedMessage()
Object[]	getParameters()
protected int	getPatternAmountArguments()
Throwable	getThrowable()
protected void	parseMessage(String messagePattern)

Methods inherited from class java.lang.Object

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

Constructor Details

PayloadMessage

public PayloadMessage(String messagePattern,
 Object[] argumentsObject)

PayloadMessage

public PayloadMessage(String messagePattern,
 Object[] argumentsObject,
 boolean includeIdentifier,
 Throwable throwable)

Method Details

argumentsToStrings

protected String[] argumentsToStrings(Object[] argumentsObject)

getPatternAmountArguments

protected int getPatternAmountArguments()

parseMessage

protected void parseMessage(String messagePattern)

convertToString

protected String convertToString(Object object)

getFormattedMessage

public String getFormattedMessage()

Specified by:

getFormattedMessage in interface org.apache.logging.log4j.message.Message

getFormat

public String getFormat()

Specified by:

getFormat in interface org.apache.logging.log4j.message.Message

getParameters

public Object[] getParameters()

Specified by:

getParameters in interface org.apache.logging.log4j.message.Message

getThrowable

public Throwable getThrowable()

Specified by:

getThrowable in interface org.apache.logging.log4j.message.Message