Class ColorConverter

  • All Implemented Interfaces:
    org.apache.logging.log4j.core.pattern.PatternConverter

    @Plugin(name="color",
            category="Converter")
    public final class ColorConverter
    extends org.apache.logging.log4j.core.pattern.LogEventPatternConverter
    Log4j2 LogEventPatternConverter colors output using the AnsiOutput class. A single option 'styling' can be provided to the converter, or if not specified color styling will be picked based on the logging level.
    Since:
    1.3.0
    • Method Detail

      • newInstance

        public static ColorConverter newInstance​(org.apache.logging.log4j.core.config.Configuration config,
                                                 String[] options)
        Creates a new instance of the class. Required by Log4J2.
        Parameters:
        config - the configuration
        options - the options
        Returns:
        a new instance, or null if the options are invalid
      • handlesThrowable

        public boolean handlesThrowable()
        Overrides:
        handlesThrowable in class org.apache.logging.log4j.core.pattern.LogEventPatternConverter
      • format

        public void format​(org.apache.logging.log4j.core.LogEvent event,
                           StringBuilder toAppendTo)
        Specified by:
        format in class org.apache.logging.log4j.core.pattern.LogEventPatternConverter