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

Class MaxLengthConverter

java.lang.Object
org.apache.logging.log4j.core.pattern.AbstractPatternConverter
org.apache.logging.log4j.core.pattern.LogEventPatternConverter
org.apache.logging.log4j.core.pattern.MaxLengthConverter
All Implemented Interfaces:
PatternConverter
@Plugin(name="maxLength", category="Converter") public final class MaxLengthConverter extends LogEventPatternConverter
Max length pattern converter. Limit contained text to a maximum length. On invalid length the default value 100 is used (and an error message is logged). If max length is greater than 20, an abbreviated text will get ellipsis ("...") appended. Example usage (for email subject): 

 %maxLen{[AppName, ${hostName}, ${web:contextPath}] %p: %c{1} - %m%notEmpty{ =>%ex{short}}}{160}
Author:
Thies Wellpott

  • Method Details

    • newInstance

      public static MaxLengthConverter newInstance(Configuration config, String[] options)
      Gets an instance of the class.
      Parameters:
      config - The current Configuration.
      options - pattern options, an array of two elements: pattern, max length (defaults to 100 on invalid value).
      Returns:
      instance of class.

    • format

      public void format(LogEvent event, StringBuilder toAppendTo)
      Description copied from class: LogEventPatternConverter
      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