Java Doc for PatternFormatter.java in  » Development » LogKit » org » apache » log » format » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Development » LogKit » org.apache.log.format 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


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  intMAX_TYPE
     The maximum value used for TYPEs.

Constructor Summary
public  PatternFormatter()
    
public  PatternFormatter(String pattern)
     Creation of a new patter formatter baseed on a supplied pattern.

Method Summary
public  Stringformat(LogEvent event)
     Format the event according to the pattern.
protected  StringformatPatternRun(LogEvent event, PatternRun run)
     Formats a single pattern run (can be extended in subclasses).
Parameters:
  run - the pattern run to format.
protected  StringgetCategory(String category, String format)
     Utility method to format category.
protected  StringgetContext(ContextStack stack, String format)
     Utility method to format context.
protected  StringgetContextMap(ContextMap map, String format)
     Utility method to format context map.
protected  StringgetContextStack(ContextStack stack, String format)
     Utility method to format context.
protected  StringgetMessage(String message, String format)
     Utility method to format message.
protected  StringgetPriority(Priority priority, String format)
     Get formatted priority string.
protected  StringgetRTime(long time, String format)
     Utility method to format relative time.
protected  StringgetStackTrace(Throwable throwable, String format)
     Utility method to format stack trace.
protected  StringgetThread(String format)
     Get formatted thread string.
protected  StringgetTime(long time, String format)
     Utility method to format time.
protected  intgetTypeIdFor(String type)
     Retrieve the type-id for a particular string.
final protected  voidparse(String patternString)
     Parse the input pattern and build internal data structures.
public  voidsetFormat(String format)
     Set the string description that the format is extracted from.

Field Detail
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.




Constructor Detail
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




Method Detail
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



getPriority
protected String getPriority(Priority priority, String format)(Code)
Get formatted priority 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



getThread
protected String getThread(String format)(Code)
Get formatted thread 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



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.