| java.lang.Object
 org.jivesoftware.util.log.format.PatternFormatter
All known Subclasses: org.jivesoftware.util.log.format.ExtendedPatternFormatter,
| PatternFormatter | | public class PatternFormatter implements 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 define an minimum size, only.
You may specify '.#' to define an maximum size only.
-
'field' indicates which field is to be output and must be one of
properties of LogEvent.
Currently following fields are 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.
- 'subformat' indicates a particular subformat and is currently only used
for category context to specify the context map parameter name.
A simple example of a typical PatternFormatter format:
%{time} %5.5{priority}[%-10.10{category}]: %{message}
This format string will format a log event printing first time value of
of log event with out size restriction, next priority with minum and maximum size 5,
next category right justified having minmum and maximum size of 10,
at last the message of the log event without size restriction.
A formatted sample message of the above pattern format:
1000928827905 DEBUG [ junit]: Sample message
author:
Peter Donald
author:
Sylvain Wallez
version:
CVS $Revision: 1747 $ $Date: 2005-08-04 14:36:36 -0700 (Thu, 04 Aug 2005) $ |
| Inner Class :protected static class PatternRun | |
| Field Summary | |
| final protected static int | MAX_TYPE
The maximum value used for TYPEs. |
| 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) | | |
| 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 |
| 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 |
| 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 |
|
|