Class NdcPatternConverter
java.lang.Object
org.apache.logging.log4j.core.pattern.AbstractPatternConverter
org.apache.logging.log4j.core.pattern.LogEventPatternConverter
org.apache.logging.log4j.core.pattern.NdcPatternConverter
- All Implemented Interfaces:
PatternConverter
@Plugin(name="NdcPatternConverter",
category="Converter")
public final class NdcPatternConverter
extends LogEventPatternConverter
Returns the event's NDC 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 TypeMethodDescriptionvoid
format
(LogEvent event, StringBuilder toAppendTo) Formats an event into a string buffer.static NdcPatternConverter
newInstance
(String[] options) Obtains an instance of NdcPatternConverter.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
-
Method Details
-
newInstance
Obtains an instance of NdcPatternConverter.- Parameters:
options
- options, may be null.- Returns:
- instance of NdcPatternConverter.
-
format
Description copied from class:LogEventPatternConverter
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.
-
emptyVariableOutput
- Overrides:
emptyVariableOutput
in classLogEventPatternConverter
- Returns:
- the formatted output when the input variable (MDC, NDC, etc.) is empty
-