|
Jive Forums API (5.5.20.2-oracle) Developer Javadocs | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.util.logging.Formatter
com.jivesoftware.base.log.PatternFormatter
public class PatternFormatter
This formater formats the LogEvents according to a input pattern string.
The format of each pattern element can be %[+|-][#[.#]]{field:subformat}.
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
- Version:
- CVS $Revision: 25327 $ $Date: 2006-01-04 10:05:36 -0800 (Wed, 04 Jan 2006) $
Nested Class Summary
protected static class
PatternFormatter.PatternRun
Field Summary
protected static int
MAX_TYPE
The maximum value used for TYPEs.
Constructor Summary
PatternFormatter()
Deprecated. Use constructor PatternFormatter(String pattern) as this does not
correctly initialize object
PatternFormatter(java.lang.String pattern)
Method Summary
java.lang.String
format(java.util.logging.LogRecord record)
Format the record according to the pattern.
protected java.lang.String
formatPatternRun(java.util.logging.LogRecord record,
PatternFormatter.PatternRun run)
Formats a single pattern run (can be extended in subclasses).
protected java.lang.String
getCategory(java.lang.String category,
java.lang.String format)
Utility method to format category.
protected java.lang.String
getLevel(java.util.logging.Level level,
java.lang.String format)
Get formatted priority string.
protected java.lang.String
getMessage(java.lang.String message,
java.lang.String format)
Utility method to format message.
protected java.lang.String
getRTime(long time,
java.lang.String format)
Utility method to format relative time.
protected java.lang.String
getStackTrace(java.lang.Throwable throwable,
java.lang.String format)
Utility method to format stack trace.
protected java.lang.String
getTime(long time,
java.lang.String format)
Utility method to format time.
protected int
getTypeIdFor(java.lang.String type)
Retrieve the type-id for a particular string.
protected void
parse(java.lang.String patternString)
Parse the input pattern and build internal data structures.
void
setFormat(java.lang.String format)
Deprecated. Parse format in via constructor rather than use this method
Methods inherited from class java.util.logging.Formatter
formatMessage, getHead, getTail
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Field Detail
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
.
- See Also:
- Constant Field Values
Constructor Detail
PatternFormatter
public PatternFormatter()
- Deprecated. Use constructor PatternFormatter(String pattern) as this does not
correctly initialize object
PatternFormatter
public PatternFormatter(java.lang.String pattern)
Method Detail
format
public java.lang.String format(java.util.logging.LogRecord record)
- Format the record according to the pattern.
- Specified by:
format
in class java.util.logging.Formatter
- Parameters:
record
- the record
- Returns:
- the formatted output
formatPatternRun
protected java.lang.String formatPatternRun(java.util.logging.LogRecord record,
PatternFormatter.PatternRun run)
- Formats a single pattern run (can be extended in subclasses).
- Parameters:
run
- the pattern run to format.
- Returns:
- the formatted result.
getCategory
protected java.lang.String getCategory(java.lang.String category,
java.lang.String format)
- Utility method to format category.
- Parameters:
category
- the category stringformat
- ancilliary format parameter - allowed to be null
- Returns:
- the formatted string
getLevel
protected java.lang.String getLevel(java.util.logging.Level level,
java.lang.String format)
- Get formatted priority string.
getMessage
protected java.lang.String getMessage(java.lang.String message,
java.lang.String format)
- Utility method to format message.
- Parameters:
message
- the message stringformat
- ancilliary format parameter - allowed to be null
- Returns:
- the formatted string
getStackTrace
protected java.lang.String getStackTrace(java.lang.Throwable throwable,
java.lang.String format)
- Utility method to format stack trace.
- Parameters:
throwable
- the throwable instanceformat
- ancilliary format parameter - allowed to be null
- Returns:
- the formatted string
getRTime
protected java.lang.String getRTime(long time,
java.lang.String format)
- Utility method to format relative time.
- Parameters:
time
- the timeformat
- ancilliary format parameter - allowed to be null
- Returns:
- the formatted string
getTime
protected java.lang.String getTime(long time,
java.lang.String format)
- Utility method to format time.
- Parameters:
time
- the timeformat
- ancilliary format parameter - allowed to be null
- Returns:
- the formatted string
getTypeIdFor
protected int getTypeIdFor(java.lang.String type)
- Retrieve the type-id for a particular string.
- Parameters:
type
- the string
- Returns:
- the type-id
parse
protected final void parse(java.lang.String patternString)
- Parse the input pattern and build internal data structures.
- Parameters:
patternString
- the pattern
setFormat
public void setFormat(java.lang.String format)
- 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
Overview
Package
Class
Use
Tree
Deprecated
Index
Help
Jive Forums Project Page
PREV CLASS
NEXT CLASS
FRAMES
NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD
DETAIL: FIELD | CONSTR | METHOD
Copyright © 1999-2006 Jive Software.