org.apache.log4j.pattern

Class NDCPatternConverter

java.lang.Object

org.apache.log4j.pattern.PatternConverter

org.apache.log4j.pattern.LoggingEventPatternConverter

org.apache.log4j.pattern.NDCPatternConverter

public final class NDCPatternConverter
extends LoggingEventPatternConverter

Return the event's NDC in a StringBuffer.

Author:

Ceki Gülcü

Method Summary

Modifier and Type	Method and Description
void	format(LoggingEvent event, StringBuffer toAppendTo) Formats an event into a string buffer.
static NDCPatternConverter	newInstance(String[] options) Obtains an instance of NDCPatternConverter.

Methods inherited from class org.apache.log4j.pattern.LoggingEventPatternConverter

format, handlesThrowable

Methods inherited from class org.apache.log4j.pattern.PatternConverter

getName, getStyleClass

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

newInstance

public static NDCPatternConverter newInstance(String[] options)

Obtains an instance of NDCPatternConverter.

Parameters:

options - options, may be null.

Returns:

instance of NDCPatternConverter.

format

public void format(LoggingEvent event,
                   StringBuffer toAppendTo)

Formats an event into a string buffer.

Specified by:

format in class LoggingEventPatternConverter

Parameters:

event - event to format, may not be null.

toAppendTo - string buffer to which the formatted event will be appended. May not be null.