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.
- Version:
- CVS $Revision: 1.24 $ $Date: 2001/12/13 08:04:51 $
- Author:
- Peter Donald, Sylvain Wallez
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(LogEvent event)
Format the event according to the pattern. |
protected java.lang.String |
formatPatternRun(LogEvent event,
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 |
getContext(ContextStack stack,
java.lang.String format)
Deprecated. Use getContextStack rather than this method |
protected java.lang.String |
getContextMap(ContextMap map,
java.lang.String format)
Utility method to format context map. |
protected java.lang.String |
getContextStack(ContextStack stack,
java.lang.String format)
Utility method to format context. |
protected java.lang.String |
getMessage(java.lang.String message,
java.lang.String format)
Utility method to format message. |
protected java.lang.String |
getPriority(Priority priority,
java.lang.String format)
Get formatted priority string. |
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.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
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
.
PatternFormatter
public PatternFormatter()
- Deprecated. Use constructor PatternFormatter(String pattern) as this does not
correctly initialize object
PatternFormatter
public PatternFormatter(java.lang.String pattern)
format
public java.lang.String format(LogEvent event)
- Format the event according to the pattern.
- Specified by:
format
in interface Formatter
- Parameters:
event
- the event- Returns:
- the formatted output
formatPatternRun
protected java.lang.String formatPatternRun(LogEvent event,
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
getPriority
protected java.lang.String getPriority(Priority priority,
java.lang.String format)
- Get formatted priority string.
getContext
protected java.lang.String getContext(ContextStack stack,
java.lang.String format)
- Deprecated. Use getContextStack rather than this method
- Utility method to format context.
- Parameters:
context
- the context stringformat
- ancilliary format parameter - allowed to be null- Returns:
- the formatted string
getContextStack
protected java.lang.String getContextStack(ContextStack stack,
java.lang.String format)
- Utility method to format context.
- Parameters:
context
- the context stringformat
- ancilliary format parameter - allowed to be null- Returns:
- the formatted string
getContextMap
protected java.lang.String getContextMap(ContextMap map,
java.lang.String format)
- Utility method to format context map.
- Parameters:
map
- the context mapformat
- ancilliary format parameter - allowed to be null- Returns:
- the formatted 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
"Copyright © 2001 Apache Jakarta Project. All Rights Reserved."