| java.lang.Object
 org.apache.log.format.PatternFormatter
All known Subclasses: org.apache.log.format.ExtendedPatternFormatter,
| PatternFormatter | | public class PatternFormatter implements Formatter,org.apache.log.Formatter(Code) | | 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
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.
author:
Avalon Development Team
author:
Peter Donald
author:
Sylvain Wallez
author:
Leif Mortenson
version:
CVS $Revision: 1.38 $ $Date: 2003/02/09 23:33:22 $ |
| Inner Class :protected static class PatternRun | |
| Field Summary | |
| final protected static int | MAX_TYPE
The maximum value used for TYPEs. |
| Method Summary | |
| public String | format(LogEvent event)
Format the event according to the pattern. | | protected String | formatPatternRun(LogEvent event, PatternRun run)
Formats a single pattern run (can be extended in subclasses).
Parameters:
run - the pattern run to format. | | 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. | | final protected void | parse(String patternString)
Parse the input pattern and build internal data structures. | | public void | setFormat(String format)
Set the string description that the format is extracted from. |
| MAX_TYPE | | final protected static int MAX_TYPE(Code) | | The maximum value used for TYPEs. Subclasses can define their own TYPEs
starting at MAX_TYPE + 1.
|
| PatternFormatter | | public PatternFormatter()(Code) | | |
| PatternFormatter | | public PatternFormatter(String pattern)(Code) | | Creation of a new patter formatter baseed on a supplied pattern.
Parameters:
pattern - the patter |
| format | | public String format(LogEvent event)(Code) | | Format the event according to the pattern.
Parameters:
event - the event the formatted output |
| formatPatternRun | | protected String formatPatternRun(LogEvent event, PatternRun run)(Code) | | Formats a single pattern run (can be extended in subclasses).
Parameters:
run - the pattern run to format. the formatted result. |
| getCategory | | protected String getCategory(String category, String format)(Code) | | Utility method to format category.
Parameters:
category - the category string
Parameters:
format - ancilliary format parameter - allowed to be null the formatted string |
| getContext | | protected String getContext(ContextStack stack, String format)(Code) | | Utility method to format context.
Parameters:
stack - the context stack
Parameters:
format - ancilliary format parameter - allowed to be null the formatted string |
| getContextMap | | protected String getContextMap(ContextMap map, String format)(Code) | | Utility method to format context map.
Parameters:
map - the context map
Parameters:
format - ancilliary format parameter - allowed to be null the formatted string |
| getContextStack | | protected String getContextStack(ContextStack stack, String format)(Code) | | Utility method to format context.
Parameters:
stack - the context stack
Parameters:
format - ancilliary format parameter - allowed to be null the formatted string |
| getMessage | | protected String getMessage(String message, String format)(Code) | | Utility method to format message.
Parameters:
message - the message string
Parameters:
format - ancilliary format parameter - allowed to be null the formatted string |
| getRTime | | protected String getRTime(long time, String format)(Code) | | Utility method to format relative time.
Parameters:
time - the time
Parameters:
format - ancilliary format parameter - allowed to be null the formatted string |
| getStackTrace | | protected String getStackTrace(Throwable throwable, String format)(Code) | | Utility method to format stack trace.
Parameters:
throwable - the throwable instance
Parameters:
format - ancilliary format parameter - allowed to be null the formatted string |
| getTime | | protected String getTime(long time, String format)(Code) | | Utility method to format time.
Parameters:
time - the time
Parameters:
format - ancilliary format parameter - allowed to be null the formatted string |
| getTypeIdFor | | protected int getTypeIdFor(String type)(Code) | | Retrieve the type-id for a particular string.
Parameters:
type - the string the type-id |
| parse | | final protected void parse(String patternString)(Code) | | Parse the input pattern and build internal data structures.
Parameters:
patternString - the pattern |
| setFormat | | public void setFormat(String format)(Code) | | Set the string description that the format is extracted from.
Parameters:
format - the string format |
|
|