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

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.MapPatternConverter
All Implemented Interfaces:
PatternConverter

public final class MapPatternConverter
extends LogEventPatternConverter

Able to handle the contents of the LogEvent's MapMessage 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 Map.


Field Summary
 
Fields inherited from class org.apache.logging.log4j.core.pattern.LogEventPatternConverter
LOGGER
 
Method Summary
 void format(LogEvent event, StringBuilder toAppendTo)
          Formats an event into a string buffer.
static MapPatternConverter 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 MapPatternConverter 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-2012 Apache Software Foundation. All Rights Reserved. Apache Logging, Apache Log4j, Log4j, Apache, the Apache feather logo, and the Apache Logging project logo are trademarks of The Apache Software Foundation.