📄 patternformatter.html
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"><!--NewPage--><HTML><HEAD><!-- Generated by javadoc (build 1.5.0_15) on Thu Aug 28 21:12:49 PDT 2008 --><TITLE>PatternFormatter (Openfire 3.6.0a Javadoc)</TITLE><META NAME="keywords" CONTENT="org.jivesoftware.util.log.format.PatternFormatter class"><LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style"><SCRIPT type="text/javascript">function windowTitle(){ parent.document.title="PatternFormatter (Openfire 3.6.0a Javadoc)";}</SCRIPT><NOSCRIPT></NOSCRIPT></HEAD><BODY BGCOLOR="white" onload="windowTitle();"><!-- ========= START OF TOP NAVBAR ======= --><A NAME="navbar_top"><!-- --></A><A HREF="#skip-navbar_top" title="Skip navigation links"></A><TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""><TR><TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"><A NAME="navbar_top_firstrow"><!-- --></A><TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> <TR ALIGN="center" VALIGN="top"> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> </TR></TABLE></TD><TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM><b>Openfire 3.6.0a Javadoc</b></EM></TD></TR><TR><TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../../org/jivesoftware/util/log/format/Formatter.html" title="interface in org.jivesoftware.util.log.format"><B>PREV CLASS</B></A> <A HREF="../../../../../org/jivesoftware/util/log/format/PatternFormatter.PatternRun.html" title="class in org.jivesoftware.util.log.format"><B>NEXT CLASS</B></A></FONT></TD><TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../../index.html?org/jivesoftware/util/log/format/PatternFormatter.html" target="_top"><B>FRAMES</B></A> <A HREF="PatternFormatter.html" target="_top"><B>NO FRAMES</B></A> <SCRIPT type="text/javascript"> <!-- if(window==top) { document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); } //--></SCRIPT><NOSCRIPT> <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A></NOSCRIPT></FONT></TD></TR><TR><TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> SUMMARY: <A HREF="#nested_class_summary">NESTED</A> | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD><TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD></TR></TABLE><A NAME="skip-navbar_top"></A><!-- ========= END OF TOP NAVBAR ========= --><HR><!-- ======== START OF CLASS DATA ======== --><H2><FONT SIZE="-1">org.jivesoftware.util.log.format</FONT><BR>Class PatternFormatter</H2><PRE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">java.lang.Object</A> <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.jivesoftware.util.log.format.PatternFormatter</B></PRE><DL><DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../../org/jivesoftware/util/log/format/Formatter.html" title="interface in org.jivesoftware.util.log.format">Formatter</A></DD></DL><DL><DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../../org/jivesoftware/util/log/format/ExtendedPatternFormatter.html" title="class in org.jivesoftware.util.log.format">ExtendedPatternFormatter</A></DD></DL><HR><DL><DT><PRE>public class <B>PatternFormatter</B><DT>extends <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A><DT>implements <A HREF="../../../../../org/jivesoftware/util/log/format/Formatter.html" title="interface in org.jivesoftware.util.log.format">Formatter</A></DL></PRE><P>This formater formats the LogEvents according to a input pattern string. <p/> The format of each pattern element can be %[+|-][#[.#]]{field:subformat}. </p> <ul> <li>The +|- indicates left or right justify. </li> <li>The #.# indicates the minimum and maximum size of output.<br> You may omit the values and the field will be formatted without size restriction.<br> You may specify '#', or '#.' to define an minimum size, only.</br> You may specify '.#' to define an maximum size only. </li> <li> 'field' indicates which field is to be output and must be one of properties of LogEvent.<br> Currently following fields are supported: <dl> <dt>category</dt> <dd>Category value of the logging event.</dd> <dt>context</dt> <dd>Context value of the logging event.</dd> <dt>message</dt> <dd>Message value of the logging event.</dd> <dt>time</dt> <dd>Time value of the logging event.</dd> <dt>rtime</dt> <dd>Relative time value of the logging event.</dd> <dt>throwable</dt> <dd>Throwable value of the logging event.</dd> <dt>priority</dt> <dd>Priority value of the logging event.</dd> </dl> </li> <li>'subformat' indicates a particular subformat and is currently only used for category context to specify the context map parameter name. </li> </ul> <p>A simple example of a typical PatternFormatter format: </p> <pre><code>%{time} %5.5{priority}[%-10.10{category}]: %{message} </pre></code> <p/> 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. </p> <p>A formatted sample message of the above pattern format: </p> <pre><code>1000928827905 DEBUG [ junit]: Sample message </pre><code><P><P><DL><DT><B>Version:</B></DT> <DD>CVS $Revision: 1747 $ $Date: 2005-08-04 14:36:36 -0700 (Thu, 04 Aug 2005) $</DD><DT><B>Author:</B></DT> <DD><a href="mailto:peter@apache.org">Peter Donald</a>, <a href="mailto:sylvain@apache.org">Sylvain Wallez</a></DD></DL><HR><P><!-- ======== NESTED CLASS SUMMARY ======== --><A NAME="nested_class_summary"><!-- --></A><TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""><TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"><TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"><B>Nested Class Summary</B></FONT></TH></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>protected static class</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../org/jivesoftware/util/log/format/PatternFormatter.PatternRun.html" title="class in org.jivesoftware.util.log.format">PatternFormatter.PatternRun</A></B></CODE><BR> </TD></TR></TABLE> <!-- =========== FIELD SUMMARY =========== --><A NAME="field_summary"><!-- --></A><TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""><TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"><TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"><B>Field Summary</B></FONT></TH></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>protected static int</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../org/jivesoftware/util/log/format/PatternFormatter.html#MAX_TYPE">MAX_TYPE</A></B></CODE><BR> The maximum value used for TYPEs.</TD></TR></TABLE> <!-- ======== CONSTRUCTOR SUMMARY ======== --><A NAME="constructor_summary"><!-- --></A><TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""><TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"><TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"><B>Constructor Summary</B></FONT></TH></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD><CODE><B><A HREF="../../../../../org/jivesoftware/util/log/format/PatternFormatter.html#PatternFormatter()">PatternFormatter</A></B>()</CODE><BR> <B>Deprecated.</B> <I>Use constructor PatternFormatter(String pattern) as this does not correctly initialize object</I></TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD><CODE><B><A HREF="../../../../../org/jivesoftware/util/log/format/PatternFormatter.html#PatternFormatter(java.lang.String)">PatternFormatter</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> pattern)</CODE><BR> </TD></TR></TABLE> <!-- ========== METHOD SUMMARY =========== -->⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -