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
FieldsModifier and TypeFieldDescriptionprivate static TriConsumer
<String, Object, StringBuilder> private final String
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
ConstructorsModifierConstructorDescriptionprivate
Log4j1MdcPatternConverter
(String[] options) Private constructor. -
Method Summary
Modifier and TypeMethodDescriptionvoid
format
(LogEvent event, StringBuilder toAppendTo) Formats an event into a string buffer.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
-
Field Details
-
key
Name of property to output. -
APPEND_EACH
-
-
Constructor Details
-
Log4j1MdcPatternConverter
Private constructor.- Parameters:
options
- options, may be null.
-
-
Method Details
-
newInstance
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
Formats an event into a string buffer.- Specified by:
format
in classLogEventPatternConverter
- Parameters:
event
- event to format, may not be null.toAppendTo
- string buffer to which the formatted event will be appended. May not be null.
-