Top Description Fields Constructors Methods
org.apache.log.format

public Class ExtendedPatternFormatter

extends PatternFormatter
Class Inheritance
Imports
org.apache.log.ContextMap, .LogEvent, .Logger, org.apache.log.util.StackIntrospector
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.
Authors
Avalon Development Team, Peter Donald
Version
$Id: ExtendedPatternFormatter.java 506267 2007-02-12 04:06:06Z crossley $

Field Summary

Modifier and TypeField and Description
private int
m_callStackOffset

private static final int
TYPE_METHOD

private static final String
TYPE_METHOD_STR

private static final int
TYPE_THREAD

Hides org.apache.log.format.PatternFormatter.TYPE_THREAD.

private static final String
TYPE_THREAD_STR

Hides org.apache.log.format.PatternFormatter.TYPE_THREAD_STR.

Inherited from org.apache.log.format.PatternFormatter:
MAX_TYPE

Constructor Summary

AccessConstructor and Description
public
ExtendedPatternFormatter(final String
the format string
format)

Creation of a new extended pattern formatter.

public
ExtendedPatternFormatter(final String
the format string
format, final int
the offset
callStackOffset)

Creation of a new extended pattern formatter.

Method Summary

Modifier and TypeMethod and Description
protected String

Returns:

the formatted result.
formatPatternRun(final LogEvent
the log event
event, final PatternFormatter.PatternRun
the pattern run to format.
run)

Overrides org.apache.log.format.PatternFormatter.formatPatternRun.

Formats a single pattern run (can be extended in subclasses).
private String

Returns:

the formatted string
getMethod(final LogEvent
the event
event)

Utility method to format category.

private String

Returns:

the formatted string
getThread(final LogEvent
the even
event)

Utility thread to format category.

protected int

Returns:

the type-id
getTypeIdFor(final String
the string
type)

Overrides org.apache.log.format.PatternFormatter.getTypeIdFor.

Retrieve the type-id for a particular string.
Inherited from org.apache.log.format.PatternFormatter:
formatgetCategorygetContextMapgetMessagegetPrioritygetRTimegetStackTracegetThreadgetTimeparse

Field Detail

m_callStackOffsetback to summary
private int m_callStackOffset
TYPE_METHODback to summary
private static final int TYPE_METHOD
TYPE_METHOD_STRback to summary
private static final String TYPE_METHOD_STR
TYPE_THREADback to summary
private static final int TYPE_THREAD

Hides org.apache.log.format.PatternFormatter.TYPE_THREAD.

TYPE_THREAD_STRback to summary
private static final String TYPE_THREAD_STR

Hides org.apache.log.format.PatternFormatter.TYPE_THREAD_STR.

Constructor Detail

ExtendedPatternFormatterback to summary
public ExtendedPatternFormatter(final String format)

Creation of a new extended pattern formatter.

Parameters
format:String

the format string

ExtendedPatternFormatterback to summary
public ExtendedPatternFormatter(final String format, final int callStackOffset)

Creation of a new extended pattern formatter.

Parameters
format:String

the format string

callStackOffset:int

the offset

Method Detail

formatPatternRunback to summary
protected String formatPatternRun(final LogEvent event, final PatternFormatter.PatternRun run)

Overrides org.apache.log.format.PatternFormatter.formatPatternRun.

Formats a single pattern run (can be extended in subclasses).

Parameters
event:LogEvent

the log event

run:PatternFormatter.PatternRun

the pattern run to format.

Returns:String

the formatted result.

getMethodback to summary
private String getMethod(final LogEvent event)

Utility method to format category.

Parameters
event:LogEvent

the event

Returns:String

the formatted string

getThreadback to summary
private String getThread(final LogEvent event)

Utility thread to format category.

Parameters
event:LogEvent

the even

Returns:String

the formatted string

getTypeIdForback to summary
protected int getTypeIdFor(final String type)

Overrides org.apache.log.format.PatternFormatter.getTypeIdFor.

Retrieve the type-id for a particular string.

Parameters
type:String

the string

Returns:int

the type-id