Class AbstractStyleNameConverter

  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.AbstractStyleNameConverter
All Implemented Interfaces:
Direct Known Subclasses:
AbstractStyleNameConverter.Black, AbstractStyleNameConverter.Blue, AbstractStyleNameConverter.Cyan, AbstractStyleNameConverter.Green, AbstractStyleNameConverter.Magenta, AbstractStyleNameConverter.Red, AbstractStyleNameConverter.White, AbstractStyleNameConverter.Yellow

public abstract class AbstractStyleNameConverter
extends LogEventPatternConverter

Style pattern converter. Adds ANSI color styling to the result of the enclosed pattern.

Nested Class Summary
static class AbstractStyleNameConverter.Black
          Black style pattern converter.
static class AbstractStyleNameConverter.Blue
          Blue style pattern converter.
static class AbstractStyleNameConverter.Cyan
          Cyan style pattern converter.
static class AbstractStyleNameConverter.Green
          Green style pattern converter.
static class AbstractStyleNameConverter.Magenta
          Magenta style pattern converter.
static class AbstractStyleNameConverter.Red
          Red style pattern converter.
static class AbstractStyleNameConverter.White
          White style pattern converter.
static class AbstractStyleNameConverter.Yellow
          Yellow style pattern converter.
Field Summary
Fields inherited from class org.apache.logging.log4j.core.pattern.AbstractPatternConverter
Fields inherited from interface org.apache.logging.log4j.core.pattern.PatternConverter
Constructor Summary
protected AbstractStyleNameConverter(String name, List<PatternFormatter> formatters, String styling)
          Constructs the converter.
Method Summary
 void format(LogEvent event, StringBuilder toAppendTo)
          Formats an event into a string buffer.
protected static
<T extends AbstractStyleNameConverter>
newInstance(Class<T> asnConverterClass, String name, Configuration config, String[] options)
          Gets an instance of the class (called via reflection).
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

Constructor Detail


protected AbstractStyleNameConverter(String name,
                                     List<PatternFormatter> formatters,
                                     String styling)
Constructs the converter.

formatters - The PatternFormatters to generate the text to manipulate.
styling - The styling that should encapsulate the pattern.
Method Detail


protected static <T extends AbstractStyleNameConverter> T newInstance(Class<T> asnConverterClass,
                                                                      String name,
                                                                      Configuration config,
                                                                      String[] options)
Gets an instance of the class (called via reflection).

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


public void format(LogEvent event,
                   StringBuilder toAppendTo)
Formats an event into a string buffer.

Specified by:
format in class LogEventPatternConverter
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-2015 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.