org.apache.log.format
public class PatternFormatter extends Object implements 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
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: $Id: PatternFormatter.java 30977 2004-07-30 03:57:54 -0500 (Fri, 30 Jul 2004) niclas $
Nested Class Summary | |
---|---|
protected static class | PatternFormatter.PatternRun |
Field Summary | |
---|---|
static String | EOL |
Date | m_date |
PatternFormatter.PatternRun[] | m_formatSpecification |
SimpleDateFormat | m_simpleDateFormat |
protected static int | MAX_TYPE
The maximum value used for TYPEs. |
static String | SPACE_1 |
static String | SPACE_16 |
static String | SPACE_2 |
static String | SPACE_4 |
static String | SPACE_8 |
static int | TYPE_CATEGORY |
static String | TYPE_CATEGORY_STR |
static int | TYPE_CONTEXT |
static String | TYPE_CONTEXT_STR |
static int | TYPE_MESSAGE |
static String | TYPE_MESSAGE_STR |
static int | TYPE_PRIORITY |
static String | TYPE_PRIORITY_STR |
static int | TYPE_RELATIVE_TIME |
static String | TYPE_RELATIVE_TIME_STR |
static int | TYPE_TEXT |
static int | TYPE_THREAD |
static String | TYPE_THREAD_STR |
static int | TYPE_THROWABLE |
static String | TYPE_THROWABLE_STR |
static int | TYPE_TIME |
static String | TYPE_TIME_STR |
Constructor Summary | |
---|---|
PatternFormatter(String pattern)
Creation of a new patter formatter baseed on a supplied pattern. |
Method Summary | |
---|---|
int | addPatternRun(Stack stack, char[] pattern, int index)
Extract and build a pattern from input string.
|
int | addTextRun(Stack stack, char[] pattern, int index)
Extract and build a text run from input string.
|
void | append(StringBuffer sb, int minSize, int maxSize, boolean rightJustify, String output)
Utility to append a string to buffer given certain constraints.
|
void | appendWhiteSpace(StringBuffer sb, int length)
Append a certain number of whitespace characters to a StringBuffer.
|
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 | getContextMap(ContextMap map, String format)
Utility method to format context map.
|
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.
|
MAX_TYPE + 1
.Parameters: pattern the patter
Parameters: stack the stack on which to place patterns pattern the input string index the start of pattern run
Returns: the number of characters in pattern run
Parameters: stack the stack on which to place runs pattern the input string index the start of the text run
Returns: the number of characters in run
Parameters: sb the StringBuffer minSize the minimum size of output (0 to ignore) maxSize the maximum size of output (0 to ignore) rightJustify true if the string is to be right justified in it's box. output the input string
Parameters: sb the StringBuffer length the number of spaces to append
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
Parameters: map the context map 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