Package org.apache.log4j.pattern

Class Log4j1MdcPatternConverter

java.lang.Object

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

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

org.apache.log4j.pattern.Log4j1MdcPatternConverter

All Implemented Interfaces:

PatternConverter

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

Able to handle the contents of the LogEvent's MDC and either output the entire contents of the properties, or to output the value of a specific key within the property bundle when this pattern converter has the option set.

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)
static Log4j1MdcPatternConverter	newInstance(String[] options)	Obtains an instance of PropertiesPatternConverter.

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

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 Log4j1MdcPatternConverter newInstance(String[] options)

Obtains an instance of PropertiesPatternConverter.

Parameters:

options - options, may be null or first element contains name of property to format.

Returns:

instance of PropertiesPatternConverter.

format

public void format(LogEvent event,
 StringBuilder toAppendTo)

Specified by:

format in class LogEventPatternConverter