org.apache.log.format
public class PatternFormatter extends Object implements Formatter, Formatter
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 {@link java.text.SimpleDateFormat 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.
Version: CVS $Revision: 1.38 $ $Date: 2003/02/09 23:33:22 $
Nested Class Summary | |
---|---|
protected static class | PatternFormatter.PatternRun |
Field Summary | |
---|---|
protected static int | MAX_TYPE
The maximum value used for TYPEs. |
Constructor Summary | |
---|---|
PatternFormatter() | |
PatternFormatter(String pattern)
Creation of a new patter formatter baseed on a supplied pattern. |
Method Summary | |
---|---|
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)
Utility method to format context.
|
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)
Set the string description that the format is extracted from.
|
MAX_TYPE + 1
.Deprecated: Use constructor PatternFormatter(String pattern) as this does not correctly initialize object
Parameters: pattern the patter
Parameters: event the event
Returns: the formatted output
Parameters: run the pattern run to format.
Returns: the formatted result.
Parameters: category the category string format ancilliary format parameter - allowed to be null
Returns: the formatted string
Deprecated: Use getContextStack rather than this method
Utility method to format context.Parameters: stack the context stack format ancilliary format parameter - allowed to be null
Returns: the formatted string
Parameters: map the context map format ancilliary format parameter - allowed to be null
Returns: the formatted string
Parameters: stack the context stack format ancilliary format parameter - allowed to be null
Returns: the formatted string
Parameters: message the message string format ancilliary format parameter - allowed to be null
Returns: the formatted string
Parameters: time the time format ancilliary format parameter - allowed to be null
Returns: the formatted string
Parameters: throwable the throwable instance format ancilliary format parameter - allowed to be null
Returns: the formatted string
Parameters: time the time format ancilliary format parameter - allowed to be null
Returns: the formatted string
Parameters: type the string
Returns: the type-id
Parameters: patternString the pattern
Deprecated: Parse format in via constructor rather than use this method
Set the string description that the format is extracted from.Parameters: format the string format