Class StyleConverter

All Implemented Interfaces:

@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.
      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.
      instance of class.
    • format

      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.
    • handlesThrowable

      public boolean handlesThrowable()
      Description copied from class: LogEventPatternConverter
      Normally pattern converters are not meant to handle Exceptions although few pattern converters might.

      By examining the return values for this method, the containing layout will determine whether it handles throwables or not.

      handlesThrowable in class LogEventPatternConverter
      true if this PatternConverter handles throwables
    • toString

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