public abstract class

LoggingEventPatternConverter

extends PatternConverter
java.lang.Object
   ↳ org.apache.log4j.pattern.PatternConverter
     ↳ org.apache.log4j.pattern.LoggingEventPatternConverter
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

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

Summary

Protected Constructors
LoggingEventPatternConverter(String name, String style)
Constructs an instance of LoggingEventPatternConverter.
Public Methods
void format(Object obj, StringBuffer output)
Formats an object into a string buffer.
abstract void format(LoggingEvent event, StringBuffer toAppendTo)
Formats an event into a string buffer.
boolean handlesThrowable()
Normally pattern converters are not meant to handle Exceptions although few pattern converters might.
[Expand]
Inherited Methods
From class org.apache.log4j.pattern.PatternConverter
From class java.lang.Object

Protected Constructors

protected LoggingEventPatternConverter (String name, String style)

Constructs an instance of LoggingEventPatternConverter.

Parameters
name name of converter.
style CSS style for output.

Public Methods

public void format (Object obj, StringBuffer 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.

public abstract void format (LoggingEvent event, StringBuffer 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.

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