Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.logging.log4j.core.pattern
Class LogEventPatternConverter

    java.lang.Object
      org.apache.logging.log4j.core.pattern.AbstractPatternConverter
          org.apache.logging.log4j.core.pattern.LogEventPatternConverter

All Implemented Interfaces:
  PatternConverter

Direct Known Subclasses:
  AbstractStyleNameConverter, DatePatternConverter, EncodingPatternConverter, FileLocationPatternConverter, FullLocationPatternConverter, HighlightConverter, LevelPatternConverter, LineLocationPatternConverter, LineSeparatorPatternConverter, LiteralPatternConverter, MapPatternConverter, MarkerPatternConverter, MdcPatternConverter, MessagePatternConverter, MethodLocationPatternConverter, NamePatternConverter, NdcPatternConverter, RegexReplacementConverter, RelativeTimePatternConverter, SequenceNumberPatternConverter, StyleConverter, ThreadPatternConverter, ThrowablePatternConverter, UuidPatternConverter

    public abstract class LogEventPatternConverter

extends AbstractPatternConverter

LoggingEventPatternConverter is a base class for pattern converters that can format information from instances of LoggingEvent.

Field Summary

Fields inherited from class org.apache.logging.log4j.core.pattern.AbstractPatternConverter
`LOGGER`

Fields inherited from interface org.apache.logging.log4j.core.pattern.PatternConverter
`CATEGORY`

Constructor Summary
`protected` | `LogEventPatternConverter(String name, String style)` Constructs an instance of LoggingEventPatternConverter.

Method Summary
`abstract void` | `format(LogEvent event, StringBuilder toAppendTo)` Formats an event into a string buffer.
`void` | `format(Object obj, StringBuilder output)` Formats an object into a string buffer.
`boolean` | `handlesThrowable()` Normally pattern converters are not meant to handle Exceptions although few pattern converters might.

Methods inherited from class org.apache.logging.log4j.core.pattern.AbstractPatternConverter
`getName, getStyleClass`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

### LogEventPatternConverter

    protected LogEventPatternConverter(String name,
                                       String style)

  Constructs an instance of LoggingEventPatternConverter.

  Parameters:
    `name` - name of converter.
    `style` - CSS style for output.

Method Detail

### format

    public abstract void format(LogEvent event,
                                StringBuilder toAppendTo)

  Formats an event into a string buffer.

  Parameters:
    `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.

  Parameters:
    `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.

  Returns:
    true if this PatternConverter handles throwables

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 1999-2015 Apache Software Foundation. All Rights Reserved.
Apache Logging, Apache Log4j, Log4j, Apache, the Apache feather logo, the Apache Logging project logo, and the Apache Log4j logo are trademarks of The Apache Software Foundation.