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

Modifier and Type	Field and Description
private static TriConsumer<java.lang.String,java.lang.Object,java.lang.StringBuilder>	APPEND_EACH
private java.lang.String	key Name of property to output.

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

LOGGER

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

CATEGORY

Constructor Summary

Constructors

Modifier	Constructor and Description
private	Log4j1MdcPatternConverter(java.lang.String[] options) Private constructor.

Method Summary

Modifier and Type	Method and Description
void	format(LogEvent event, java.lang.StringBuilder toAppendTo) Formats an event into a string buffer.
static Log4j1MdcPatternConverter	newInstance(java.lang.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

Field Detail

key

private final java.lang.String key

Name of property to output.

APPEND_EACH

private static TriConsumer<java.lang.String,java.lang.Object,java.lang.StringBuilder> APPEND_EACH

Constructor Detail

Log4j1MdcPatternConverter

private Log4j1MdcPatternConverter(java.lang.String[] options)

Private constructor.

Parameters:

options - options, may be null.

Method Detail

newInstance

public static Log4j1MdcPatternConverter newInstance(java.lang.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,
                   java.lang.StringBuilder toAppendTo)

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.