Package org.apache.logging.log4j.core.pattern

Class StyleConverter

java.lang.Object
org.apache.logging.log4j.core.pattern.AbstractPatternConverter
org.apache.logging.log4j.core.pattern.LogEventPatternConverter
org.apache.logging.log4j.core.pattern.StyleConverter
All Implemented Interfaces:
PatternConverter
@Plugin(name="style", category="Converter") public final class StyleConverter extends LogEventPatternConverter
Style pattern converter. Adds ANSI color styling to the result of the enclosed pattern.

To disable ANSI output unconditionally, specify an additional option disableAnsi=true, or to disable ANSI output if no console is detected, specify option noConsoleNoAnsi=true.

  • Method Details

    • newInstance

      public static StyleConverter 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.

    • handlesThrowable

      public boolean handlesThrowable()
      Description copied from class: LogEventPatternConverter
      Tests whether this pattern converter is renders a Throwable.

      The PatternParser checks this flag when processing the alwaysWriteExceptions option: if no converter in the pattern handles throwables, the parser automatically appends a converter to ensure exceptions are still written.

      Overrides:
      handlesThrowable in class LogEventPatternConverter
      Returns:
      true if this converter consumes and renders a Throwable, false otherwise

    • toString

      public String toString()
      Returns a String suitable for debugging.
      Overrides:
      toString in class Object
      Returns:
      a String suitable for debugging.