| <!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.6.0_31) --> |
| <META http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <TITLE> |
| PatternLayout (Apache Log4j 1.2.17 API) |
| </TITLE> |
| |
| <META NAME="date" CONTENT="2012-06-09"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="PatternLayout (Apache Log4j 1.2.17 API)"; |
| } |
| } |
| </SCRIPT> |
| <NOSCRIPT> |
| </NOSCRIPT> |
| |
| </HEAD> |
| |
| <BODY BGCOLOR="white" onload="windowTitle();"> |
| <HR> |
| |
| |
| <!-- ========= 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="class-use/PatternLayout.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </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> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../org/apache/log4j/NDC.html" title="class in org.apache.log4j"><B>PREV CLASS</B></A> |
| <A HREF="../../../org/apache/log4j/Priority.html" title="class in org.apache.log4j"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../index.html?org/apache/log4j/PatternLayout.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="PatternLayout.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: NESTED | <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.apache.log4j</FONT> |
| <BR> |
| Class PatternLayout</H2> |
| <PRE> |
| <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A> |
| <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../org/apache/log4j/Layout.html" title="class in org.apache.log4j">org.apache.log4j.Layout</A> |
| <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>org.apache.log4j.PatternLayout</B> |
| </PRE> |
| <DL> |
| <DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../org/apache/log4j/spi/OptionHandler.html" title="interface in org.apache.log4j.spi">OptionHandler</A></DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT><PRE>public class <B>PatternLayout</B><DT>extends <A HREF="../../../org/apache/log4j/Layout.html" title="class in org.apache.log4j">Layout</A></DL> |
| </PRE> |
| |
| <P> |
| A flexible layout configurable with pattern string. |
| |
| This code is known to have synchronization and other issues |
| which are not present in org.apache.log4j.EnhancedPatternLayout. |
| EnhancedPatternLayout should be used in preference to PatternLayout. |
| EnhancedPatternLayout is distributed in the log4j extras companion. |
| |
| <p>The goal of this class is to <A HREF="../../../org/apache/log4j/PatternLayout.html#format(org.apache.log4j.spi.LoggingEvent)"><CODE>format</CODE></A> a <A HREF="../../../org/apache/log4j/spi/LoggingEvent.html" title="class in org.apache.log4j.spi"><CODE>LoggingEvent</CODE></A> and return the results as a String. The results |
| depend on the <em>conversion pattern</em>. |
| |
| <p>The conversion pattern is closely related to the conversion |
| pattern of the printf function in C. A conversion pattern is |
| composed of literal text and format control expressions called |
| <em>conversion specifiers</em>. |
| |
| <p><i>You are free to insert any literal text within the conversion |
| pattern.</i> |
| |
| <p>Each conversion specifier starts with a percent sign (%) and is |
| followed by optional <em>format modifiers</em> and a <em>conversion |
| character</em>. The conversion character specifies the type of |
| data, e.g. category, priority, date, thread name. The format |
| modifiers control such things as field width, padding, left and |
| right justification. The following is a simple example. |
| |
| <p>Let the conversion pattern be <b>"%-5p [%t]: %m%n"</b> and assume |
| that the log4j environment was set to use a PatternLayout. Then the |
| statements |
| <pre> |
| Category root = Category.getRoot(); |
| root.debug("Message 1"); |
| root.warn("Message 2"); |
| </pre> |
| would yield the output |
| <pre> |
| DEBUG [main]: Message 1 |
| WARN [main]: Message 2 |
| </pre> |
| |
| <p>Note that there is no explicit separator between text and |
| conversion specifiers. The pattern parser knows when it has reached |
| the end of a conversion specifier when it reads a conversion |
| character. In the example above the conversion specifier |
| <b>%-5p</b> means the priority of the logging event should be left |
| justified to a width of five characters. |
| |
| The recognized conversion characters are |
| |
| <p> |
| <table border="1" CELLPADDING="8"> |
| <th>Conversion Character</th> |
| <th>Effect</th> |
| |
| <tr> |
| <td align=center><b>c</b></td> |
| |
| <td>Used to output the category of the logging event. The |
| category conversion specifier can be optionally followed by |
| <em>precision specifier</em>, that is a decimal constant in |
| brackets. |
| |
| <p>If a precision specifier is given, then only the corresponding |
| number of right most components of the category name will be |
| printed. By default the category name is printed in full. |
| |
| <p>For example, for the category name "a.b.c" the pattern |
| <b>%c{2}</b> will output "b.c". |
| |
| </td> |
| </tr> |
| |
| <tr> |
| <td align=center><b>C</b></td> |
| |
| <td>Used to output the fully qualified class name of the caller |
| issuing the logging request. This conversion specifier |
| can be optionally followed by <em>precision specifier</em>, that |
| is a decimal constant in brackets. |
| |
| <p>If a precision specifier is given, then only the corresponding |
| number of right most components of the class name will be |
| printed. By default the class name is output in fully qualified form. |
| |
| <p>For example, for the class name "org.apache.xyz.SomeClass", the |
| pattern <b>%C{1}</b> will output "SomeClass". |
| |
| <p><b>WARNING</b> Generating the caller class information is |
| slow. Thus, use should be avoided unless execution speed is |
| not an issue. |
| |
| </td> |
| </tr> |
| |
| <tr> <td align=center><b>d</b></td> <td>Used to output the date of |
| the logging event. The date conversion specifier may be |
| followed by a <em>date format specifier</em> enclosed between |
| braces. For example, <b>%d{HH:mm:ss,SSS}</b> or |
| <b>%d{dd MMM yyyy HH:mm:ss,SSS}</b>. If no |
| date format specifier is given then ISO8601 format is |
| assumed. |
| |
| <p>The date format specifier admits the same syntax as the |
| time pattern string of the <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/text/SimpleDateFormat.html?is-external=true" title="class or interface in java.text"><CODE>SimpleDateFormat</CODE></A>. Although part of the standard |
| JDK, the performance of <code>SimpleDateFormat</code> is |
| quite poor. |
| |
| <p>For better results it is recommended to use the log4j date |
| formatters. These can be specified using one of the strings |
| "ABSOLUTE", "DATE" and "ISO8601" for specifying <A HREF="../../../org/apache/log4j/helpers/AbsoluteTimeDateFormat.html" title="class in org.apache.log4j.helpers"><CODE>AbsoluteTimeDateFormat</CODE></A>, <A HREF="../../../org/apache/log4j/helpers/DateTimeDateFormat.html" title="class in org.apache.log4j.helpers"><CODE>DateTimeDateFormat</CODE></A> |
| and respectively <A HREF="../../../org/apache/log4j/helpers/ISO8601DateFormat.html" title="class in org.apache.log4j.helpers"><CODE>ISO8601DateFormat</CODE></A>. For example, <b>%d{ISO8601}</b> or |
| <b>%d{ABSOLUTE}</b>. |
| |
| <p>These dedicated date formatters perform significantly |
| better than <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/text/SimpleDateFormat.html?is-external=true" title="class or interface in java.text"><CODE>SimpleDateFormat</CODE></A>. |
| </td> |
| </tr> |
| |
| <tr> |
| <td align=center><b>F</b></td> |
| |
| <td>Used to output the file name where the logging request was |
| issued. |
| |
| <p><b>WARNING</b> Generating caller location information is |
| extremely slow and should be avoided unless execution speed |
| is not an issue. |
| |
| </tr> |
| |
| <tr> |
| <td align=center><b>l</b></td> |
| |
| <td>Used to output location information of the caller which generated |
| the logging event. |
| |
| <p>The location information depends on the JVM implementation but |
| usually consists of the fully qualified name of the calling |
| method followed by the callers source the file name and line |
| number between parentheses. |
| |
| <p>The location information can be very useful. However, its |
| generation is <em>extremely</em> slow and should be avoided |
| unless execution speed is not an issue. |
| |
| </td> |
| </tr> |
| |
| <tr> |
| <td align=center><b>L</b></td> |
| |
| <td>Used to output the line number from where the logging request |
| was issued. |
| |
| <p><b>WARNING</b> Generating caller location information is |
| extremely slow and should be avoided unless execution speed |
| is not an issue. |
| |
| </tr> |
| |
| |
| <tr> |
| <td align=center><b>m</b></td> |
| <td>Used to output the application supplied message associated with |
| the logging event.</td> |
| </tr> |
| |
| <tr> |
| <td align=center><b>M</b></td> |
| |
| <td>Used to output the method name where the logging request was |
| issued. |
| |
| <p><b>WARNING</b> Generating caller location information is |
| extremely slow and should be avoided unless execution speed |
| is not an issue. |
| |
| </tr> |
| |
| <tr> |
| <td align=center><b>n</b></td> |
| |
| <td>Outputs the platform dependent line separator character or |
| characters. |
| |
| <p>This conversion character offers practically the same |
| performance as using non-portable line separator strings such as |
| "\n", or "\r\n". Thus, it is the preferred way of specifying a |
| line separator. |
| |
| |
| </tr> |
| |
| <tr> |
| <td align=center><b>p</b></td> |
| <td>Used to output the priority of the logging event.</td> |
| </tr> |
| |
| <tr> |
| |
| <td align=center><b>r</b></td> |
| |
| <td>Used to output the number of milliseconds elapsed from the construction |
| of the layout until the creation of the logging event.</td> |
| </tr> |
| |
| |
| <tr> |
| <td align=center><b>t</b></td> |
| |
| <td>Used to output the name of the thread that generated the |
| logging event.</td> |
| |
| </tr> |
| |
| <tr> |
| |
| <td align=center><b>x</b></td> |
| |
| <td>Used to output the NDC (nested diagnostic context) associated |
| with the thread that generated the logging event. |
| </td> |
| </tr> |
| |
| |
| <tr> |
| <td align=center><b>X</b></td> |
| |
| <td> |
| |
| <p>Used to output the MDC (mapped diagnostic context) associated |
| with the thread that generated the logging event. The <b>X</b> |
| conversion character <em>must</em> be followed by the key for the |
| map placed between braces, as in <b>%X{clientNumber}</b> where |
| <code>clientNumber</code> is the key. The value in the MDC |
| corresponding to the key will be output.</p> |
| |
| <p>See <A HREF="../../../org/apache/log4j/MDC.html" title="class in org.apache.log4j"><CODE>MDC</CODE></A> class for more details. |
| </p> |
| |
| </td> |
| </tr> |
| |
| <tr> |
| |
| <td align=center><b>%</b></td> |
| |
| <td>The sequence %% outputs a single percent sign. |
| </td> |
| </tr> |
| |
| </table> |
| |
| <p>By default the relevant information is output as is. However, |
| with the aid of format modifiers it is possible to change the |
| minimum field width, the maximum field width and justification. |
| |
| <p>The optional format modifier is placed between the percent sign |
| and the conversion character. |
| |
| <p>The first optional format modifier is the <em>left justification |
| flag</em> which is just the minus (-) character. Then comes the |
| optional <em>minimum field width</em> modifier. This is a decimal |
| constant that represents the minimum number of characters to |
| output. If the data item requires fewer characters, it is padded on |
| either the left or the right until the minimum width is |
| reached. The default is to pad on the left (right justify) but you |
| can specify right padding with the left justification flag. The |
| padding character is space. If the data item is larger than the |
| minimum field width, the field is expanded to accommodate the |
| data. The value is never truncated. |
| |
| <p>This behavior can be changed using the <em>maximum field |
| width</em> modifier which is designated by a period followed by a |
| decimal constant. If the data item is longer than the maximum |
| field, then the extra characters are removed from the |
| <em>beginning</em> of the data item and not from the end. For |
| example, it the maximum field width is eight and the data item is |
| ten characters long, then the first two characters of the data item |
| are dropped. This behavior deviates from the printf function in C |
| where truncation is done from the end. |
| |
| <p>Below are various format modifier examples for the category |
| conversion specifier. |
| |
| <p> |
| <TABLE BORDER=1 CELLPADDING=8> |
| <th>Format modifier |
| <th>left justify |
| <th>minimum width |
| <th>maximum width |
| <th>comment |
| |
| <tr> |
| <td align=center>%20c</td> |
| <td align=center>false</td> |
| <td align=center>20</td> |
| <td align=center>none</td> |
| |
| <td>Left pad with spaces if the category name is less than 20 |
| characters long. |
| |
| <tr> <td align=center>%-20c</td> <td align=center>true</td> <td |
| align=center>20</td> <td align=center>none</td> <td>Right pad with |
| spaces if the category name is less than 20 characters long. |
| |
| <tr> |
| <td align=center>%.30c</td> |
| <td align=center>NA</td> |
| <td align=center>none</td> |
| <td align=center>30</td> |
| |
| <td>Truncate from the beginning if the category name is longer than 30 |
| characters. |
| |
| <tr> |
| <td align=center>%20.30c</td> |
| <td align=center>false</td> |
| <td align=center>20</td> |
| <td align=center>30</td> |
| |
| <td>Left pad with spaces if the category name is shorter than 20 |
| characters. However, if category name is longer than 30 characters, |
| then truncate from the beginning. |
| |
| <tr> |
| <td align=center>%-20.30c</td> |
| <td align=center>true</td> |
| <td align=center>20</td> |
| <td align=center>30</td> |
| |
| <td>Right pad with spaces if the category name is shorter than 20 |
| characters. However, if category name is longer than 30 characters, |
| then truncate from the beginning. |
| |
| </table> |
| |
| <p>Below are some examples of conversion patterns. |
| |
| <dl> |
| |
| <p><dt><b>%r [%t] %-5p %c %x - %m%n</b> |
| <p><dd>This is essentially the TTCC layout. |
| |
| <p><dt><b>%-6r [%15.15t] %-5p %30.30c %x - %m%n</b> |
| |
| <p><dd>Similar to the TTCC layout except that the relative time is |
| right padded if less than 6 digits, thread name is right padded if |
| less than 15 characters and truncated if longer and the category |
| name is left padded if shorter than 30 characters and truncated if |
| longer. |
| |
| </dl> |
| |
| <p>The above text is largely inspired from Peter A. Darnell and |
| Philip E. Margolis' highly recommended book "C -- a Software |
| Engineering Approach", ISBN 0-387-97389-3. |
| <P> |
| |
| <P> |
| <DL> |
| <DT><B>Since:</B></DT> |
| <DD>0.8.2</DD> |
| <DT><B>Author:</B></DT> |
| <DD><a href="mailto:cakalijp@Maritz.com">James P. Cakalic</a>, Ceki Gülcü</DD> |
| </DL> |
| <HR> |
| |
| <P> |
| <!-- =========== 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 int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/apache/log4j/PatternLayout.html#BUF_SIZE">BUF_SIZE</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/apache/log4j/PatternLayout.html#DEFAULT_CONVERSION_PATTERN">DEFAULT_CONVERSION_PATTERN</A></B></CODE> |
| |
| <BR> |
| Default pattern string for log output.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/apache/log4j/PatternLayout.html#MAX_CAPACITY">MAX_CAPACITY</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/apache/log4j/PatternLayout.html#TTCC_CONVERSION_PATTERN">TTCC_CONVERSION_PATTERN</A></B></CODE> |
| |
| <BR> |
| A conversion pattern equivalent to the TTCCCLayout.</TD> |
| </TR> |
| </TABLE> |
| <A NAME="fields_inherited_from_class_org.apache.log4j.Layout"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Fields inherited from class org.apache.log4j.<A HREF="../../../org/apache/log4j/Layout.html" title="class in org.apache.log4j">Layout</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../org/apache/log4j/Layout.html#LINE_SEP">LINE_SEP</A>, <A HREF="../../../org/apache/log4j/Layout.html#LINE_SEP_LEN">LINE_SEP_LEN</A></CODE></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/apache/log4j/PatternLayout.html#PatternLayout()">PatternLayout</A></B>()</CODE> |
| |
| <BR> |
| Constructs a PatternLayout using the DEFAULT_LAYOUT_PATTERN.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../org/apache/log4j/PatternLayout.html#PatternLayout(java.lang.String)">PatternLayout</A></B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> pattern)</CODE> |
| |
| <BR> |
| Constructs a PatternLayout using the supplied conversion pattern.</TD> |
| </TR> |
| </TABLE> |
| |
| <!-- ========== METHOD SUMMARY =========== --> |
| |
| <A NAME="method_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>Method Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/apache/log4j/PatternLayout.html#activateOptions()">activateOptions</A></B>()</CODE> |
| |
| <BR> |
| Does not do anything as options become effective</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected <A HREF="../../../org/apache/log4j/helpers/PatternParser.html" title="class in org.apache.log4j.helpers">PatternParser</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/apache/log4j/PatternLayout.html#createPatternParser(java.lang.String)">createPatternParser</A></B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> pattern)</CODE> |
| |
| <BR> |
| Returns PatternParser used to parse the conversion string.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/apache/log4j/PatternLayout.html#format(org.apache.log4j.spi.LoggingEvent)">format</A></B>(<A HREF="../../../org/apache/log4j/spi/LoggingEvent.html" title="class in org.apache.log4j.spi">LoggingEvent</A> event)</CODE> |
| |
| <BR> |
| Produces a formatted string as specified by the conversion pattern.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/apache/log4j/PatternLayout.html#getConversionPattern()">getConversionPattern</A></B>()</CODE> |
| |
| <BR> |
| Returns the value of the <b>ConversionPattern</b> option.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/apache/log4j/PatternLayout.html#ignoresThrowable()">ignoresThrowable</A></B>()</CODE> |
| |
| <BR> |
| The PatternLayout does not handle the throwable contained within |
| <A HREF="../../../org/apache/log4j/spi/LoggingEvent.html" title="class in org.apache.log4j.spi"><CODE>LoggingEvents</CODE></A>.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/apache/log4j/PatternLayout.html#setConversionPattern(java.lang.String)">setConversionPattern</A></B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> conversionPattern)</CODE> |
| |
| <BR> |
| Set the <b>ConversionPattern</b> option.</TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_org.apache.log4j.Layout"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Methods inherited from class org.apache.log4j.<A HREF="../../../org/apache/log4j/Layout.html" title="class in org.apache.log4j">Layout</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../org/apache/log4j/Layout.html#getContentType()">getContentType</A>, <A HREF="../../../org/apache/log4j/Layout.html#getFooter()">getFooter</A>, <A HREF="../../../org/apache/log4j/Layout.html#getHeader()">getHeader</A></CODE></TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| |
| <!-- ============ FIELD DETAIL =========== --> |
| |
| <A NAME="field_detail"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
| <B>Field Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="DEFAULT_CONVERSION_PATTERN"><!-- --></A><H3> |
| DEFAULT_CONVERSION_PATTERN</H3> |
| <PRE> |
| public static final <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>DEFAULT_CONVERSION_PATTERN</B></PRE> |
| <DL> |
| <DD>Default pattern string for log output. Currently set to the |
| string <b>"%m%n"</b> which just prints the application supplied |
| message. |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.apache.log4j.PatternLayout.DEFAULT_CONVERSION_PATTERN">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="TTCC_CONVERSION_PATTERN"><!-- --></A><H3> |
| TTCC_CONVERSION_PATTERN</H3> |
| <PRE> |
| public static final <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>TTCC_CONVERSION_PATTERN</B></PRE> |
| <DL> |
| <DD>A conversion pattern equivalent to the TTCCCLayout. |
| Current value is <b>%r [%t] %p %c %x - %m%n</b>. |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.apache.log4j.PatternLayout.TTCC_CONVERSION_PATTERN">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="BUF_SIZE"><!-- --></A><H3> |
| BUF_SIZE</H3> |
| <PRE> |
| protected final int <B>BUF_SIZE</B></PRE> |
| <DL> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.apache.log4j.PatternLayout.BUF_SIZE">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="MAX_CAPACITY"><!-- --></A><H3> |
| MAX_CAPACITY</H3> |
| <PRE> |
| protected final int <B>MAX_CAPACITY</B></PRE> |
| <DL> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.apache.log4j.PatternLayout.MAX_CAPACITY">Constant Field Values</A></DL> |
| </DL> |
| |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| |
| <A NAME="constructor_detail"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
| <B>Constructor Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="PatternLayout()"><!-- --></A><H3> |
| PatternLayout</H3> |
| <PRE> |
| public <B>PatternLayout</B>()</PRE> |
| <DL> |
| <DD>Constructs a PatternLayout using the DEFAULT_LAYOUT_PATTERN. |
| |
| The default pattern just produces the application supplied message. |
| <P> |
| </DL> |
| <HR> |
| |
| <A NAME="PatternLayout(java.lang.String)"><!-- --></A><H3> |
| PatternLayout</H3> |
| <PRE> |
| public <B>PatternLayout</B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> pattern)</PRE> |
| <DL> |
| <DD>Constructs a PatternLayout using the supplied conversion pattern. |
| <P> |
| </DL> |
| |
| <!-- ============ METHOD DETAIL ========== --> |
| |
| <A NAME="method_detail"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
| <B>Method Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="setConversionPattern(java.lang.String)"><!-- --></A><H3> |
| setConversionPattern</H3> |
| <PRE> |
| public void <B>setConversionPattern</B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> conversionPattern)</PRE> |
| <DL> |
| <DD>Set the <b>ConversionPattern</b> option. This is the string which |
| controls formatting and consists of a mix of literal content and |
| conversion specifiers. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getConversionPattern()"><!-- --></A><H3> |
| getConversionPattern</H3> |
| <PRE> |
| public <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getConversionPattern</B>()</PRE> |
| <DL> |
| <DD>Returns the value of the <b>ConversionPattern</b> option. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="activateOptions()"><!-- --></A><H3> |
| activateOptions</H3> |
| <PRE> |
| public void <B>activateOptions</B>()</PRE> |
| <DL> |
| <DD>Does not do anything as options become effective |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="ignoresThrowable()"><!-- --></A><H3> |
| ignoresThrowable</H3> |
| <PRE> |
| public boolean <B>ignoresThrowable</B>()</PRE> |
| <DL> |
| <DD>The PatternLayout does not handle the throwable contained within |
| <A HREF="../../../org/apache/log4j/spi/LoggingEvent.html" title="class in org.apache.log4j.spi"><CODE>LoggingEvents</CODE></A>. Thus, it returns |
| <code>true</code>. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../org/apache/log4j/Layout.html#ignoresThrowable()">ignoresThrowable</A></CODE> in class <CODE><A HREF="../../../org/apache/log4j/Layout.html" title="class in org.apache.log4j">Layout</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>0.8.4</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="createPatternParser(java.lang.String)"><!-- --></A><H3> |
| createPatternParser</H3> |
| <PRE> |
| protected <A HREF="../../../org/apache/log4j/helpers/PatternParser.html" title="class in org.apache.log4j.helpers">PatternParser</A> <B>createPatternParser</B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> pattern)</PRE> |
| <DL> |
| <DD>Returns PatternParser used to parse the conversion string. Subclasses |
| may override this to return a subclass of PatternParser which recognize |
| custom conversion characters. |
| <P> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>0.9.0</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="format(org.apache.log4j.spi.LoggingEvent)"><!-- --></A><H3> |
| format</H3> |
| <PRE> |
| public <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>format</B>(<A HREF="../../../org/apache/log4j/spi/LoggingEvent.html" title="class in org.apache.log4j.spi">LoggingEvent</A> event)</PRE> |
| <DL> |
| <DD>Produces a formatted string as specified by the conversion pattern. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../org/apache/log4j/Layout.html#format(org.apache.log4j.spi.LoggingEvent)">format</A></CODE> in class <CODE><A HREF="../../../org/apache/log4j/Layout.html" title="class in org.apache.log4j">Layout</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <HR> |
| |
| |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <A NAME="navbar_bottom"><!-- --></A> |
| <A HREF="#skip-navbar_bottom" 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_bottom_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="class-use/PatternLayout.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </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> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../org/apache/log4j/NDC.html" title="class in org.apache.log4j"><B>PREV CLASS</B></A> |
| <A HREF="../../../org/apache/log4j/Priority.html" title="class in org.apache.log4j"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../index.html?org/apache/log4j/PatternLayout.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="PatternLayout.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: NESTED | <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_bottom"></A> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| |
| <HR> |
| Copyright © 1999-2012 <a href="http://www.apache.org">Apache Software Foundation</a>. All Rights Reserved. |
| </BODY> |
| </HTML> |
