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

Class EncodingPatternConverter

java.lang.Object
org.apache.logging.log4j.core.pattern.AbstractPatternConverter
org.apache.logging.log4j.core.pattern.LogEventPatternConverter
org.apache.logging.log4j.core.pattern.EncodingPatternConverter
All Implemented Interfaces:
PatternConverter
@Plugin(name="encode", category="Converter") public final class EncodingPatternConverter extends LogEventPatternConverter
Converter that encodes the output from a pattern using a specified format. Supported formats include HTML (default) and JSON.

  • Method Details

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

      Overrides:
      handlesThrowable in class LogEventPatternConverter
      Returns:
      true if this PatternConverter handles throwables

    • newInstance

      public static EncodingPatternConverter newInstance(Configuration config, String[] options)
      Creates an EncodingPatternConverter using a pattern string and an optional escape format.
      Parameters:
      config - the current Configuration
      options - first option is the nested pattern format; second option is the escape format (optional)
      Returns:
      instance of pattern converter.

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