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
Modifier and Type Field Description

private static NdcPatternConverter INSTANCE
Singleton.
- 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 Description

private NdcPatternConverter()
Private constructor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.lang.String`	`emptyVariableOutput()`
`void`	`format(LogEvent event, java.lang.StringBuilder toAppendTo)`	Formats an event into a string buffer.
`static NdcPatternConverter`	`newInstance(java.lang.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

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - INSTANCE
```
private static final NdcPatternConverter INSTANCE
```
    Singleton.
- Constructor Detail
  - NdcPatternConverter
```
private NdcPatternConverter()
```
    Private constructor.
- Method Detail
  - newInstance
```
public static NdcPatternConverter newInstance(java.lang.String[] options)
```
    Obtains an instance of NdcPatternConverter.
    
    Parameters:
    
    options - options, may be null.
    
    Returns:
    
    instance of NdcPatternConverter.
  - format
```
public void format(LogEvent event,
                   java.lang.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.
  - emptyVariableOutput
```
public java.lang.String emptyVariableOutput()
```
    Overrides:
    
    emptyVariableOutput in class LogEventPatternConverter
    
    Returns:
    
    the formatted output when the input variable (MDC, NDC, etc.) is empty