Package org.apache.logging.log4j.core.pattern

Class MessagePatternConverter

java.lang.Object

org.apache.logging.log4j.core.pattern.AbstractPatternConverter

org.apache.logging.log4j.core.pattern.LogEventPatternConverter

org.apache.logging.log4j.core.pattern.MessagePatternConverter

All Implemented Interfaces:

PatternConverter

@Plugin(name="MessagePatternConverter",
        category="Converter")
public class MessagePatternConverter
extends LogEventPatternConverter

Returns the event's rendered message in a StringBuilder.

Field Summary

Fields inherited from class org.apache.logging.log4j.core.pattern.AbstractPatternConverter

LOGGER

Fields inherited from interface org.apache.logging.log4j.core.pattern.PatternConverter

CATEGORY

Method Summary

Modifier and Type	Method	Description
void	format(LogEvent event, StringBuilder toAppendTo)	Formats an event into a string buffer.
static MessagePatternConverter	newInstance(Configuration config, String[] options)	Obtains an instance of pattern converter.

Methods inherited from class org.apache.logging.log4j.core.pattern.LogEventPatternConverter

emptyVariableOutput, format, handlesThrowable, isVariable

Methods inherited from class org.apache.logging.log4j.core.pattern.AbstractPatternConverter

getName, getStyleClass

Methods inherited from class java.lang.Object

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

Method Details

newInstance

public static MessagePatternConverter newInstance(Configuration config,
 String[] options)

Obtains an instance of pattern converter.

Parameters:

config - The Configuration.

options - options, may be null.

Returns:

instance of pattern converter.

format

public void format(LogEvent event,
 StringBuilder toAppendTo)

Description copied from class: LogEventPatternConverter

Formats an event into a string buffer.

Specified by:

format in class LogEventPatternConverter

Parameters:

event - event to format, may not be null.

toAppendTo - string buffer to which the formatted event will be appended. May not be null.