| java.lang.Object
 org.apache.cocoon.util.log.ExtensiblePatternFormatter
All known Subclasses: org.apache.cocoon.util.log.CocoonLogFormatter,
| ExtensiblePatternFormatter | | public class ExtensiblePatternFormatter implements Formatter(Code) | | A refactoring of org.apache.log.format.PatternFormatter that
can be extended.
This formater formats the LogEntries 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.
'field' indicates which field is to be output and must be one of
properties of LogEvent
'subformat' indicates a particular subformat and is currently unused.
author:
Peter Donald
author:
Sylvain Wallez
version:
CVS $Id: ExtensiblePatternFormatter.java 433543 2006-08-22 06:22:54Z crossley $ |
| Inner Class :protected static class PatternRun | |
| Method Summary | |
| protected int | addPatternRun(Stack stack, char pattern, int index)
Extract and build a pattern from input string. | | protected int | addTextRun(Stack stack, char pattern, int index)
Extract and build a text run from input string. | | protected void | append(StringBuffer sb, int minSize, int maxSize, boolean rightJustify, String output)
Utility to append a string to buffer given certain constraints. | | final protected String | fix(String context)
Correct a context string by replacing '.''s with a '_'. | | 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 | getMessage(String message, String format)
Utility method to format message. | | protected String | getPriority(Priority priority, String format)
Get formatted priority string. | | protected String | getStackTrace(Throwable throwable, String format)
Utility method to format stack trace. | | 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. | | 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.
|
| TYPE_CATEGORY | | final protected static int TYPE_CATEGORY(Code) | | |
| TYPE_CATEGORY_STR | | final protected static String TYPE_CATEGORY_STR(Code) | | |
| TYPE_MESSAGE | | final protected static int TYPE_MESSAGE(Code) | | |
| TYPE_MESSAGE_STR | | final protected static String TYPE_MESSAGE_STR(Code) | | |
| TYPE_PRIORITY | | final protected static int TYPE_PRIORITY(Code) | | |
| TYPE_PRIORITY_STR | | final protected static String TYPE_PRIORITY_STR(Code) | | |
| TYPE_RELATIVE_TIME | | final protected static int TYPE_RELATIVE_TIME(Code) | | |
| TYPE_RELATIVE_TIME_STR | | final protected static String TYPE_RELATIVE_TIME_STR(Code) | | |
| TYPE_TEXT | | final protected static int TYPE_TEXT(Code) | | |
| TYPE_THROWABLE | | final protected static int TYPE_THROWABLE(Code) | | |
| TYPE_THROWABLE_STR | | final protected static String TYPE_THROWABLE_STR(Code) | | |
| TYPE_TIME | | final protected static int TYPE_TIME(Code) | | |
| TYPE_TIME_STR | | final protected static String TYPE_TIME_STR(Code) | | |
| m_formatSpecification | | protected PatternRun m_formatSpecification(Code) | | |
| addPatternRun | | protected int addPatternRun(Stack stack, char pattern, int index)(Code) | | Extract and build a pattern from input string.
Parameters:
stack - the stack on which to place patterns
Parameters:
pattern - the input string
Parameters:
index - the start of pattern run the number of characters in pattern run |
| addTextRun | | protected int addTextRun(Stack stack, char pattern, int index)(Code) | | Extract and build a text run from input string.
It does special handling of '\n' and '\t' replaceing
them with newline and tab.
Parameters:
stack - the stack on which to place runs
Parameters:
pattern - the input string
Parameters:
index - the start of the text run the number of characters in run |
| append | | protected void append(StringBuffer sb, int minSize, int maxSize, boolean rightJustify, String output)(Code) | | Utility to append a string to buffer given certain constraints.
Parameters:
sb - the StringBuffer
Parameters:
minSize - the minimum size of output (0 to ignore)
Parameters:
maxSize - the maximum size of output (0 to ignore)
Parameters:
rightJustify - true if the string is to be right justified in it's box.
Parameters:
output - the input string |
| fix | | final protected String fix(String context)(Code) | | Correct a context string by replacing '.''s with a '_'.
Parameters:
context - the un-fixed context the fixed context |
| 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 |
| 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 |
| getPriority | | protected String getPriority(Priority priority, String format)(Code) | | Get formatted priority 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 | | 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 |
|
|