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

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

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

Returns the event's rendered message in a StringBuilder.


Field Summary
 
Fields inherited from class org.apache.logging.log4j.core.pattern.AbstractPatternConverter
LOGGER
 
Method Summary
 void format(LogEvent event, StringBuilder toAppendTo)
          Formats an event into a string buffer.
static MessagePatternConverter newInstance(Configuration config, String[] options)
          Obtains an instance of pattern converter.
 
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 MessagePatternConverter newInstance(Configuration config,
                                                  String[] options)
Obtains an instance of pattern converter.

Parameters:
config - The Configuration.
options - options, may be null.
Returns:
instance of pattern converter.

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.