Class LogEventPatternConverter

All Implemented Interfaces:
Direct Known Subclasses:
AbstractStyleNameConverter, DatePatternConverter, EncodingPatternConverter, EndOfBatchPatternConverter, EqualsBaseReplacementConverter, FileLocationPatternConverter, FullLocationPatternConverter, HighlightConverter, LevelPatternConverter, LineLocationPatternConverter, LineSeparatorPatternConverter, LiteralPatternConverter, LoggerFqcnPatternConverter, MapPatternConverter, MarkerPatternConverter, MarkerSimpleNamePatternConverter, MaxLengthConverter, MdcPatternConverter, MessagePatternConverter, MethodLocationPatternConverter, NamePatternConverter, NanoTimePatternConverter, NdcPatternConverter, ProcessIdPatternConverter, RegexReplacementConverter, RelativeTimePatternConverter, RepeatPatternConverter, SequenceNumberPatternConverter, StyleConverter, ThreadIdPatternConverter, ThreadNamePatternConverter, ThreadPriorityPatternConverter, ThrowablePatternConverter, UuidPatternConverter, VariablesNotEmptyReplacementConverter

public abstract class LogEventPatternConverter extends AbstractPatternConverter
LoggingEventPatternConverter is a base class for pattern converters that can format information from instances of LoggingEvent.
  • Constructor Details

    • LogEventPatternConverter

      protected LogEventPatternConverter(String name, String style)
      Constructs an instance of LoggingEventPatternConverter.
      name - name of converter.
      style - CSS style for output.
  • Method Details

    • format

      public abstract void format(LogEvent event, StringBuilder toAppendTo)
      Formats an event into a string buffer.
      event - event to format, may not be null.
      toAppendTo - string buffer to which the formatted event will be appended. May not be null.
    • format

      public void format(Object obj, StringBuilder output)
      Formats an object into a string buffer.
      obj - event to format, may not be null.
      output - string buffer to which the formatted event will be appended. May not be null.
    • handlesThrowable

      public boolean handlesThrowable()
      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.

      true if this PatternConverter handles throwables
    • isVariable

      public boolean isVariable()
    • emptyVariableOutput

      public String emptyVariableOutput()
      the formatted output when the input variable (MDC, NDC, etc.) is empty