org.apache.log.format
Class PatternFormatter
java.lang.Object
org.apache.log.format.PatternFormatter
- Formatter, Formatter
public class PatternFormatter
extends java.lang.Object
This formater formats the LogEvents according to a input pattern
string.
The format of each pattern element can be
%[+|-][#[.#]]{field:subformat}
.
- The
+|-
indicates left or right justify.
- The
#.#
indicates the minimum and maximum
size of output. You may omit the values and the field will be
formatted without size restriction.
You may specify #
, or #.
to only
define the minimum size.
You may specify .#
to only define the maximum
size.
field
indicates which field is to be output and must be
one of properties of LogEvent. The following fields are
currently supported:
category | Category value of the logging event. |
context | Context value of the logging event. |
message | Message value of the logging event. |
time | Time value of the logging event. |
rtime | Relative time value of the logging event. |
throwable | Throwable value of the logging event. |
priority | Priority value of the logging event. |
thread | Name of the thread which logged the event. |
subformat
indicates a particular subformat to
use on the specified field, and is currently only supported by:
context | Specifies the context map parameter name. |
time | Specifies the pattern to be pass to
SimpleDateFormat to format the time. |
A simple example of a typical PatternFormatter format would be:
%{time} %5.5{priority}[%-10.10{category}]: %{message}
This would produce a line like:
1000928827905 DEBUG [ junit]: Sample message
The format string specifies that the logger should first print the
time value of the log event without size restriction, then the
priority of the log event with a minimum and maximum size of 5,
then the category of the log event right justified with a minimum
and maximum size of 10, followed by the message of the log event
without any size restriction.
CVS $Revision: 1.38 $ $Date: 2003/02/09 23:33:22 $
protected static int | MAX_TYPE - The maximum value used for TYPEs.
|
PatternFormatter() - Use constructor PatternFormatter(String pattern) as this does not
correctly initialize object
|
PatternFormatter(String pattern) - Creation of a new patter formatter baseed on a supplied pattern.
|
String | format(LogEvent event) - Format the event according to the pattern.
|
protected String | formatPatternRun(LogEvent event, PatternFormatter.PatternRun run) - Formats a single pattern run (can be extended in subclasses).
|
protected String | getCategory(String category, String format) - Utility method to format category.
|
protected String | getContext(ContextStack stack, String format) - Use getContextStack rather than this method
|
protected String | getContextMap(ContextMap map, String format) - Utility method to format context map.
|
protected String | getContextStack(ContextStack stack, String format) - Utility method to format context.
|
protected String | getMessage(String message, String format) - Utility method to format message.
|
protected String | getPriority(Priority priority, String format) - Get formatted priority string.
|
protected String | getRTime(long time, String format) - Utility method to format relative time.
|
protected String | getStackTrace(Throwable throwable, String format) - Utility method to format stack trace.
|
protected String | getThread(String format) - Get formatted thread string.
|
protected String | getTime(long time, String format) - Utility method to format time.
|
protected int | getTypeIdFor(String type) - Retrieve the type-id for a particular string.
|
protected void | parse(String patternString) - Parse the input pattern and build internal data structures.
|
void | setFormat(String format) - Parse format in via constructor rather than use this method
|
MAX_TYPE
protected static final int MAX_TYPE
The maximum value used for TYPEs. Subclasses can define their own TYPEs
starting at MAX_TYPE + 1
.
PatternFormatter
public PatternFormatter()
Use constructor PatternFormatter(String pattern) as this does not
correctly initialize object
PatternFormatter
public PatternFormatter(String pattern)
Creation of a new patter formatter baseed on a supplied pattern.
formatPatternRun
protected String formatPatternRun(LogEvent event,
PatternFormatter.PatternRun run)
Formats a single pattern run (can be extended in subclasses).
run
- the pattern run to format.
getCategory
protected String getCategory(String category,
String format)
Utility method to format category.
category
- the category stringformat
- ancilliary format parameter - allowed to be null
getContext
protected String getContext(ContextStack stack,
String format)
Use getContextStack rather than this method
Utility method to format context.
stack
- the context stackformat
- ancilliary format parameter - allowed to be null
getContextMap
protected String getContextMap(ContextMap map,
String format)
Utility method to format context map.
map
- the context mapformat
- ancilliary format parameter - allowed to be null
getContextStack
protected String getContextStack(ContextStack stack,
String format)
Utility method to format context.
stack
- the context stackformat
- ancilliary format parameter - allowed to be null
getMessage
protected String getMessage(String message,
String format)
Utility method to format message.
message
- the message stringformat
- ancilliary format parameter - allowed to be null
getPriority
protected String getPriority(Priority priority,
String format)
Get formatted priority string.
getRTime
protected String getRTime(long time,
String format)
Utility method to format relative time.
time
- the timeformat
- ancilliary format parameter - allowed to be null
getStackTrace
protected String getStackTrace(Throwable throwable,
String format)
Utility method to format stack trace.
throwable
- the throwable instanceformat
- ancilliary format parameter - allowed to be null
getThread
protected String getThread(String format)
Get formatted thread string.
getTime
protected String getTime(long time,
String format)
Utility method to format time.
time
- the timeformat
- ancilliary format parameter - allowed to be null
getTypeIdFor
protected int getTypeIdFor(String type)
Retrieve the type-id for a particular string.
parse
protected final void parse(String patternString)
Parse the input pattern and build internal data structures.
patternString
- the pattern
setFormat
public void setFormat(String format)
Parse format in via constructor rather than use this method
Set the string description that the format is extracted from.
format
- the string format