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

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

public final class HighlightConverter
extends LogEventPatternConverter

Highlight pattern converter. Formats the result of a pattern using a color appropriate for the Level in the LogEvent.


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 HighlightConverter newInstance(Configuration config, String[] options)
          Gets an instance of the class.
 
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 HighlightConverter newInstance(Configuration config,
                                             String[] options)
Gets an instance of the class.

Parameters:
config - The current Configuration.
options - pattern options, may be null. If first element is "short", only the first line of the throwable will be formatted.
Returns:
instance of class.

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.