org.apache.log.format

Class ExtendedPatternFormatter

Implemented Interfaces:
Formatter, Formatter
Known Direct Subclasses:
AvalonFormatter

public class ExtendedPatternFormatter
extends PatternFormatter

Formatter especially designed for debugging applications. This formatter extends the standard PatternFormatter to add two new possible expansions. These expansions are %{method} and %{thread}. In both cases the context map is first checked for values with specified key. This is to facilitate passing information about caller/thread when threads change (as in AsyncLogTarget). They then attempt to determine appropriate information dynamically.

Version:
CVS $Revision: 1.13 $ $Date: 2003/04/17 09:13:46 $

Authors:
Avalon Development Team
Peter Donald

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.log.format.PatternFormatter

PatternFormatter.PatternRun

Field Summary

Fields inherited from class org.apache.log.format.PatternFormatter

MAX_TYPE

Constructor Summary

ExtendedPatternFormatter(String format)
Creation of a new extended pattern formatter.
ExtendedPatternFormatter(String format, int callStackOffset)
Creation of a new extended pattern formatter.

Method Summary

protected String
formatPatternRun(LogEvent event, PatternFormatter.PatternRun run)
Formats a single pattern run (can be extended in subclasses).
protected int
getTypeIdFor(String type)
Retrieve the type-id for a particular string.

Methods inherited from class org.apache.log.format.PatternFormatter

format, formatPatternRun, getCategory, getContext, getContextMap, getContextStack, getMessage, getPriority, getRTime, getStackTrace, getThread, getTime, getTypeIdFor, parse, setFormat

Constructor Details

ExtendedPatternFormatter

public ExtendedPatternFormatter(String format)
Creation of a new extended pattern formatter.

Parameters:
format - the format string


ExtendedPatternFormatter

public ExtendedPatternFormatter(String format,
                                int callStackOffset)
Creation of a new extended pattern formatter.

Parameters:
format - the format string
callStackOffset - the offset

Method Details

formatPatternRun

protected String formatPatternRun(LogEvent event,
                                  PatternFormatter.PatternRun run)
Formats a single pattern run (can be extended in subclasses).
Overrides:
formatPatternRun in interface PatternFormatter

Parameters:
event - the log event
run - the pattern run to format.

Returns:
the formatted result.


getTypeIdFor

protected int getTypeIdFor(String type)
Retrieve the type-id for a particular string.
Overrides:
getTypeIdFor in interface PatternFormatter

Parameters:
type - the string

Returns:
the type-id