Package org.apache.log4j.pattern
Class LoggingEventPatternConverter
- java.lang.Object
-
- org.apache.log4j.pattern.PatternConverter
-
- org.apache.log4j.pattern.LoggingEventPatternConverter
-
- Direct Known Subclasses:
DatePatternConverter
,FileLocationPatternConverter
,FullLocationPatternConverter
,LevelPatternConverter
,LineLocationPatternConverter
,LineSeparatorPatternConverter
,LiteralPatternConverter
,MessagePatternConverter
,MethodLocationPatternConverter
,NamePatternConverter
,NDCPatternConverter
,PropertiesPatternConverter
,RelativeTimePatternConverter
,SequenceNumberPatternConverter
,ThreadPatternConverter
,ThrowableInformationPatternConverter
public abstract class LoggingEventPatternConverter extends PatternConverter
LoggingEventPatternConverter is a base class for pattern converters that can format information from instances of LoggingEvent.- Author:
- Curt Arnold
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
LoggingEventPatternConverter(java.lang.String name, java.lang.String style)
Constructs an instance of LoggingEventPatternConverter.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description void
format(java.lang.Object obj, java.lang.StringBuffer output)
Formats an object into a string buffer.abstract void
format(LoggingEvent event, java.lang.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.-
Methods inherited from class org.apache.log4j.pattern.PatternConverter
getName, getStyleClass
-
-
-
-
Method Detail
-
format
public abstract void format(LoggingEvent event, java.lang.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.
-
format
public void format(java.lang.Object obj, java.lang.StringBuffer output)
Formats an object into a string buffer.- Specified by:
format
in classPatternConverter
- 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
-
-