| <!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) on Sat Jun 09 14:24:14 MST 2012 --> |
| <META http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <TITLE> |
| PatternConverter (Log4J Core 2.0-alpha1-SNAPSHOT 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="PatternConverter (Log4J Core 2.0-alpha1-SNAPSHOT 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/PatternConverter.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/logging/log4j/core/pattern/NDCPatternConverter.html" title="class in org.apache.logging.log4j.core.pattern"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../../org/apache/logging/log4j/core/pattern/PatternParser.html" title="class in org.apache.logging.log4j.core.pattern"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../../index.html?org/apache/logging/log4j/core/pattern/PatternConverter.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="PatternConverter.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 | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | CONSTR | <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.logging.log4j.core.pattern</FONT> |
| <BR> |
| Interface PatternConverter</H2> |
| <DL> |
| <DT><B>All Known Subinterfaces:</B> <DD><A HREF="../../../../../../org/apache/logging/log4j/core/pattern/ArrayPatternConverter.html" title="interface in org.apache.logging.log4j.core.pattern">ArrayPatternConverter</A></DD> |
| </DL> |
| <DL> |
| <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../../../org/apache/logging/log4j/core/pattern/AbstractPatternConverter.html" title="class in org.apache.logging.log4j.core.pattern">AbstractPatternConverter</A>, <A HREF="../../../../../../org/apache/logging/log4j/core/pattern/ClassNamePatternConverter.html" title="class in org.apache.logging.log4j.core.pattern">ClassNamePatternConverter</A>, <A HREF="../../../../../../org/apache/logging/log4j/core/pattern/DatePatternConverter.html" title="class in org.apache.logging.log4j.core.pattern">DatePatternConverter</A>, <A HREF="../../../../../../org/apache/logging/log4j/core/pattern/ExtendedThrowablePatternConverter.html" title="class in org.apache.logging.log4j.core.pattern">ExtendedThrowablePatternConverter</A>, <A HREF="../../../../../../org/apache/logging/log4j/core/pattern/FileLocationPatternConverter.html" title="class in org.apache.logging.log4j.core.pattern">FileLocationPatternConverter</A>, <A HREF="../../../../../../org/apache/logging/log4j/core/pattern/FullLocationPatternConverter.html" title="class in org.apache.logging.log4j.core.pattern">FullLocationPatternConverter</A>, <A HREF="../../../../../../org/apache/logging/log4j/core/pattern/IntegerPatternConverter.html" title="class in org.apache.logging.log4j.core.pattern">IntegerPatternConverter</A>, <A HREF="../../../../../../org/apache/logging/log4j/core/pattern/LevelPatternConverter.html" title="class in org.apache.logging.log4j.core.pattern">LevelPatternConverter</A>, <A HREF="../../../../../../org/apache/logging/log4j/core/pattern/LineLocationPatternConverter.html" title="class in org.apache.logging.log4j.core.pattern">LineLocationPatternConverter</A>, <A HREF="../../../../../../org/apache/logging/log4j/core/pattern/LineSeparatorPatternConverter.html" title="class in org.apache.logging.log4j.core.pattern">LineSeparatorPatternConverter</A>, <A HREF="../../../../../../org/apache/logging/log4j/core/pattern/LiteralPatternConverter.html" title="class in org.apache.logging.log4j.core.pattern">LiteralPatternConverter</A>, <A HREF="../../../../../../org/apache/logging/log4j/core/pattern/LogEventPatternConverter.html" title="class in org.apache.logging.log4j.core.pattern">LogEventPatternConverter</A>, <A HREF="../../../../../../org/apache/logging/log4j/core/pattern/LoggerPatternConverter.html" title="class in org.apache.logging.log4j.core.pattern">LoggerPatternConverter</A>, <A HREF="../../../../../../org/apache/logging/log4j/core/pattern/MapPatternConverter.html" title="class in org.apache.logging.log4j.core.pattern">MapPatternConverter</A>, <A HREF="../../../../../../org/apache/logging/log4j/core/pattern/MarkerPatternConverter.html" title="class in org.apache.logging.log4j.core.pattern">MarkerPatternConverter</A>, <A HREF="../../../../../../org/apache/logging/log4j/core/pattern/MDCPatternConverter.html" title="class in org.apache.logging.log4j.core.pattern">MDCPatternConverter</A>, <A HREF="../../../../../../org/apache/logging/log4j/core/pattern/MessagePatternConverter.html" title="class in org.apache.logging.log4j.core.pattern">MessagePatternConverter</A>, <A HREF="../../../../../../org/apache/logging/log4j/core/pattern/MethodLocationPatternConverter.html" title="class in org.apache.logging.log4j.core.pattern">MethodLocationPatternConverter</A>, <A HREF="../../../../../../org/apache/logging/log4j/core/pattern/NamePatternConverter.html" title="class in org.apache.logging.log4j.core.pattern">NamePatternConverter</A>, <A HREF="../../../../../../org/apache/logging/log4j/core/pattern/NDCPatternConverter.html" title="class in org.apache.logging.log4j.core.pattern">NDCPatternConverter</A>, <A HREF="../../../../../../org/apache/logging/log4j/core/pattern/RegexReplacementConverter.html" title="class in org.apache.logging.log4j.core.pattern">RegexReplacementConverter</A>, <A HREF="../../../../../../org/apache/logging/log4j/core/pattern/RelativeTimePatternConverter.html" title="class in org.apache.logging.log4j.core.pattern">RelativeTimePatternConverter</A>, <A HREF="../../../../../../org/apache/logging/log4j/core/pattern/RootThrowablePatternConverter.html" title="class in org.apache.logging.log4j.core.pattern">RootThrowablePatternConverter</A>, <A HREF="../../../../../../org/apache/logging/log4j/core/pattern/SequenceNumberPatternConverter.html" title="class in org.apache.logging.log4j.core.pattern">SequenceNumberPatternConverter</A>, <A HREF="../../../../../../org/apache/logging/log4j/core/pattern/ThreadPatternConverter.html" title="class in org.apache.logging.log4j.core.pattern">ThreadPatternConverter</A>, <A HREF="../../../../../../org/apache/logging/log4j/core/pattern/ThrowablePatternConverter.html" title="class in org.apache.logging.log4j.core.pattern">ThrowablePatternConverter</A>, <A HREF="../../../../../../org/apache/logging/log4j/core/pattern/UUIDPatternConverter.html" title="class in org.apache.logging.log4j.core.pattern">UUIDPatternConverter</A></DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT><PRE>public interface <A HREF="../../../../../../src-html/org/apache/logging/log4j/core/pattern/PatternConverter.html#line.22"><B>PatternConverter</B></A></DL> |
| </PRE> |
| |
| <P> |
| Interface that all PatternConverters must implement. |
| <P> |
| |
| <P> |
| <HR> |
| |
| <P> |
| |
| <!-- ========== 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/logging/log4j/core/pattern/PatternConverter.html#format(java.lang.Object, java.lang.StringBuilder)">format</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> obj, |
| <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/StringBuilder.html?is-external=true" title="class or interface in java.lang">StringBuilder</A> toAppendTo)</CODE> |
| |
| <BR> |
| Formats an object into a string buffer.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://download.oracle.com/javase/1.5.0/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/logging/log4j/core/pattern/PatternConverter.html#getName()">getName</A></B>()</CODE> |
| |
| <BR> |
| Returns the name of the converter.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://download.oracle.com/javase/1.5.0/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/logging/log4j/core/pattern/PatternConverter.html#getStyleClass(java.lang.Object)">getStyleClass</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> e)</CODE> |
| |
| <BR> |
| This method returns the CSS style class that should be applied to |
| the LoggingEvent passed as parameter, which can be null.</TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| |
| <!-- ============ 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="format(java.lang.Object, java.lang.StringBuilder)"><!-- --></A><H3> |
| format</H3> |
| <PRE> |
| void <A HREF="../../../../../../src-html/org/apache/logging/log4j/core/pattern/PatternConverter.html#line.29"><B>format</B></A>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> obj, |
| <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/StringBuilder.html?is-external=true" title="class or interface in java.lang">StringBuilder</A> toAppendTo)</PRE> |
| <DL> |
| <DD>Formats an object into a string buffer. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>obj</CODE> - event to format, may not be null.<DD><CODE>toAppendTo</CODE> - string buffer to which the formatted event will be appended. May not be null.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getName()"><!-- --></A><H3> |
| getName</H3> |
| <PRE> |
| <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <A HREF="../../../../../../src-html/org/apache/logging/log4j/core/pattern/PatternConverter.html#line.35"><B>getName</B></A>()</PRE> |
| <DL> |
| <DD>Returns the name of the converter. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>The name of the converter.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getStyleClass(java.lang.Object)"><!-- --></A><H3> |
| getStyleClass</H3> |
| <PRE> |
| <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <A HREF="../../../../../../src-html/org/apache/logging/log4j/core/pattern/PatternConverter.html#line.45"><B>getStyleClass</B></A>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> e)</PRE> |
| <DL> |
| <DD>This method returns the CSS style class that should be applied to |
| the LoggingEvent passed as parameter, which can be null. |
| <p/> |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>e</CODE> - null values are accepted |
| <DT><B>Returns:</B><DD>the name of the conversion pattern</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/PatternConverter.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/logging/log4j/core/pattern/NDCPatternConverter.html" title="class in org.apache.logging.log4j.core.pattern"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../../org/apache/logging/log4j/core/pattern/PatternParser.html" title="class in org.apache.logging.log4j.core.pattern"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../../index.html?org/apache/logging/log4j/core/pattern/PatternConverter.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="PatternConverter.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 | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | CONSTR | <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> |
