org.apache.logging.log4j.core.pattern
Class MdcPatternConverter

java.lang.Object
  extended by org.apache.logging.log4j.core.pattern.AbstractPatternConverter
      extended by org.apache.logging.log4j.core.pattern.LogEventPatternConverter
          extended by org.apache.logging.log4j.core.pattern.MdcPatternConverter
All Implemented Interfaces:
PatternConverter

@Plugin(name="MdcPatternConverter",
        category="Converter")
public final class MdcPatternConverter
extends LogEventPatternConverter

Able to handle the contents of the LogEvent's MDC and either output the entire contents of the properties in a similar format to the java.util.Hashtable.toString(), or to output the value of a specific key within the property bundle when this pattern converter has the option set.


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
 void format(LogEvent event, StringBuilder toAppendTo)
          Formats an event into a string buffer.
static MdcPatternConverter newInstance(String[] options)
          Obtains an instance of PropertiesPatternConverter.
 
Methods inherited from class org.apache.logging.log4j.core.pattern.LogEventPatternConverter
format, handlesThrowable
 
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
 

Method Detail

newInstance

public static MdcPatternConverter newInstance(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,
                   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.


Copyright © 1999-2014 Apache Software Foundation. All Rights Reserved.
Apache Logging, Apache Log4j, Log4j, Apache, the Apache feather logo, the Apache Logging project logo, and the Apache Log4j logo are trademarks of The Apache Software Foundation.