bloritsch 2003/02/19 05:34:00 Added: . check-targets.properties check-targets.xml docs/logkit/api/org/apache/log/format AvalonFormatter.html Log: update API docs Revision Changes Path 1.1 avalon-site/check-targets.properties Index: check-targets.properties =================================================================== # sets up properties for the dependency download mechanism jar.repository=http://www.ibiblio.org/maven ibm.license=IBM Public License ibm.license.url=http://www.opensource.org/licenses/ibmpl.php cpl.license=Common Public License cpl.license.url=http://www.opensource.org/licenses/cpl.php asl.license=Apache Software License asl.license.url=http://www.opensource.org/licenses/apachepl.php lgpl.license=GNU Lesser General Public License lgpl.license.url=http://www.opensource.org/licenses/lgpl-license.php sbcl.license=Sun Binary Code License mpl.license=Mozilla Project License # BSF bsf.version=2.2 bsf.id=bsf bsf.license=${ibm.license} bsf.license.url=${ibm.license.url} bsf.dist.url=http://www-124.ibm.com/developerworks/projects/bsf # Rhino (JavaScript) rhino.version= rhino.id=rhino rhino.license=${mpl.license} rhino.license.url= rhino.dist.url= # Checkstyle checkstyle.version=2.4 checkstyle.id=checkstyle checkstyle.license=${lgpl.license} checkstyle.license.url=${lgpl.license.url} checkstyle.dist.url=http://checkstyle.sf.net/ # Commons-Logging commons-logging.version=1.0.2 commons-logging.id=commons-logging commons-logging.license=${asl.license} commons-logging.license.url=${asl.license.url} commons-logging.dist.url=http://jakarta.apache.org/commons/logging/ # JavaMail javamail.version=1.2 javamail.id=javamail javamail.license=${sbcl.license} javamail.license.url=http://java.sun.com/products/javamail/ javamail.dist.url=http://java.sun.com/products/javamail/ # JDBC jdbc.version=2.0 jdbc.id=jdbc jdbc.license=${sbcl.license} jdbc.license.url=http://java.sun.com/products/jdbc/ jdbc.dist.url=http://java.sun.com/products/jdbc/ # JMS jms.version=1.0.2 jms.id=jms jms.license=${sbcl.license} jms.license.url=http://java.sun.com/products/jms/ jms.dist.url=http://java.sun.com/products/jms/ # JUnit junit.version=3.7 junit.id=junit junit.license=${cpl.license} junit.license.url=${cpl.license.url} junit.dist.url=http://www.junit.org/ # Log4J log4j.version=1.2.7 log4j.id=log4j log4j.license=${asl.license} log4j.license.url=${asl.license.url} log4j.dist.url=http://jakarta.apache.org/log4j/ # Logkit logkit.version=1.0.1 logkit.id=logkit logkit.license=${asl.license} logkit.license.url=${asl.license.url} logkit.dist.url=http://avalon.apache.org/logkit/ # Servlet API servletapi.version=2.2 servletapi.id=servletapi servletapi.license=${sbcl.license} servletapi.license.url=http://java.sun.com/products/servlet/ servletapi.dist.url=http://java.sun.com/products/servlet/ 1.1 avalon-site/check-targets.xml Index: check-targets.xml =================================================================== <project name="Check Dependencies"> <!-- This build.xml snippet contains targets for ant 1.5 that check whether a specific libary is present, and offers targets for downloading them if they're not. It's kinda of a replacement for some maven functionality until maven becomes stable. --> <!-- Set up properties --> <property file="check-targets.properties"/> <target name="setup-dependencies"> <available property="bsf.present" classname="com.bsf.BSFEngine" classpathref="project.class.path" /> <available property="checkstyle.present" classname="com.puppycrawl.tools.checkstyle.Checker" classpathref="project.class.path" /> <available property="commons-logging.present" classname="org.apache.comons.logging.Log" classpathref="project.class.path" /> <available property="javax.jms.present" classname="javax.jms.TopicConnection" classpathref="project.class.path" /> <available property="javax.mail.present" classname="javax.mail.Message" classpathref="project.class.path" /> <available property="javax.servlet.present" classname="javax.servlet.ServletContext" classpathref="project.class.path" /> <available property="javax.sql.present" classname="javax.sql.DataSource" classpathref="project.class.path" /> <available property="jdk14.present" classname="java.util.logging.Logger" classpathref="project.class.path" /> <available property="junit.present" classname="junit.framework.Test" classpathref="project.class.path" /> <available property="log4j.present" classname="org.apache.log4j.Level" classpathref="project.class.path" /> <available property="logkit.present" classname="org.apache.log.Hierarchy" classpathref="project.class.path" /> <available property="rhino.present" classname="org.mozilla.javascript.tools.shell.Main" classpathref="project.class.path"/> </target> <!-- called if a dependency is missing which has a BSD or ASL or similar license for which autodownload is okay. --> <target name="missing-dependency"> <echo> ************************************************************************* Classes needed for compiling ${Name} against the ${id} API are not available. The build may fail or some functionality may not be available. Recovery: Run the build target import-${id} and it will download the needed jar - you should be online for that. If you have a fast connection you can also just run the build target import-all-auto-dependencies, which will download all external jars this buildfile knows about. Note this may download unused jars as well. ************************************************************************* </echo> <echo/> </target> <!-- called if a dependency is missing which we cannot autodownload due to licensing--> <target name="missing-dependency-noauto"> <echo> ************************************************************************* Classes needed for compiling ${Name} against the ${id} API are not available. The build may fail or some functionality may not be available. Recovery: Get the ${id} jar from the ${id} distribution at ${dist.url} and place it in ${lib.dir}. Please note that ${id} is licensed under the ${license} and that by downloading it you are agreeing to that license. You can read this license at ${license.url} ************************************************************************* </echo> <echo/> </target> <!-- this target fetches a file from a maven repository --> <target name="import-dependency"> <get src="${license.url}" dest="${lib.dir}/${id}.LICENSE.html" usetimestamp="true"/> <loadfile property="license.text" srcFile="${lib.dir}/${id}.LICENSE.html"/> <echo> ************************************************************************* You have requested to download the ${id} jar, which is licensed under the ${license}. A copy of this license has been saved to ${lib.dir}/${id}.LICENSE.html Please view it now. ************************************************************************* </echo> <input message="Do you agree to the terms of this license?" validargs="y,n" addproperty="do.download"/> <condition property="do.abort"> <equals arg1="n" arg2="${do.download}"/> </condition> <fail if="do.abort">Download aborted.</fail> <get src="${jar.repository}/${id}/jars/${id}-${version}.jar" dest="${lib.dir}/${id}-${version}.jar" verbose="true" usetimestamp="true"/> </target> <target name="check-all-dependencies" depends="bsf-check,checkstyle-check,javamail-check,jdbc-check,jms-check,junit-check,log4j-check,logkit-check,servletapi-check,commons-logging-check" description="checks for all dependencies we know about. This is usually more than the minimum needed to build this project; actual use is not recommended."/> <target name="import-all-auto-dependencies" depends="import-bsf,import-checkstyle,import-junit,import-log4j,import-logkit,import-commons-logging" description="checks for all dependencies we know about. This is usually more than the minimum needed to build this project; actual use is not recommended."/> <!-- BSF --> <target name="bsf-check" unless="bsf.present" depends="setup-dependencies"> <antcall target="missing-dependency"> <param name="id" value="${bsf.id}"/> <param name="version" value="${bsf.version}"/> <param name="license" value="${bsf.license}"/> <param name="license.url" value="${bsf.license.url}"/> </antcall> </target> <target name="import-bsf" depends="setup-dependencies"> <antcall target="import-dependency"> <param name="id" value="${bsf.id}"/> <param name="version" value="${bsf.version}"/> <param name="license" value="${bsf.license}"/> <param name="license.url" value="${bsf.license.url}"/> </antcall> </target> <!-- Checkstyle --> <target name="checkstyle-check" unless="checkstyle.present" depends="setup-dependencies"> <antcall target="missing-dependency"> <param name="id" value="${checkstyle.id}"/> <param name="version" value="${checkstyle.version}"/> <param name="license" value="${checkstyle.license}"/> <param name="license.url" value="${checkstyle.license.url}"/> </antcall> </target> <target name="import-checkstyle" depends="setup-dependencies"> <antcall target="import-dependency"> <param name="id" value="${checkstyle.id}"/> <param name="version" value="${checkstyle.version}"/> <param name="license" value="${checkstyle.license}"/> <param name="license.url" value="${checkstyle.license.url}"/> </antcall> </target> <!-- Commons-Logging --> <target name="commons-logging-check" unless="commons-logging.present" depends="setup-dependencies"> <antcall target="missing-dependency"> <param name="id" value="${commons-logging.id}"/> <param name="version" value="${commons-logging.version}"/> <param name="license" value="${commons-logging.license}"/> <param name="license.url" value="${commons-logging.license.url}"/> </antcall> </target> <target name="import-commons-logging" depends="setup-dependencies"> <antcall target="import-dependency"> <param name="id" value="${commons-logging.id}"/> <param name="version" value="${commons-logging.version}"/> <param name="license" value="${commons-logging.license}"/> <param name="license.url" value="${commons-logging.license.url}"/> </antcall> </target> <!-- JavaMail --> <target name="javamail-check" unless="javax.mail.present" depends="setup-dependencies"> <antcall target="missing-dependency-noauto"> <param name="id" value="${javamail.id}"/> <param name="version" value="${javamail.version}"/> <param name="license" value="${javamail.license}"/> <param name="license.url" value="${javamail.license.url}"/> <param name="dist.url" value="${javamail.dist.url}"/> </antcall> </target> <!-- JDBC --> <target name="jdbc-check" unless="javax.sql.present" depends="setup-dependencies"> <antcall target="missing-dependency-noauto"> <param name="id" value="${jdbc.id}"/> <param name="version" value="${jl.version}"/> <param name="license" value="${jdbc.license}"/> <param name="license.url" value="${jdbc.license.url}"/> <param name="dist.url" value="${jdbc.dist.url}"/> </antcall> </target> <!-- JDK 1.4 --> <target name="jdk14-check" unless="jdk14.present" depends="setup-dependencies"> <echo>*************************************************************************</echo> <echo>*</echo> <echo>* You are compiling with a pre-1.4 jdk. Some functionality may not be</echo> <echo>* available.</echo> <echo>*************************************************************************</echo> <echo/> </target> <!-- JMS --> <target name="jms-check" unless="javax.jms.present" depends="setup-dependencies"> <antcall target="missing-dependency-noauto"> <param name="id" value="${jms.id}"/> <param name="version" value="${jms.version}"/> <param name="license" value="${jms.license}"/> <param name="license.url" value="${jms.license.url}"/> <param name="dist.url" value="${jms.dist.url}"/> </antcall> </target> <!-- JUnit --> <target name="junit-check" unless="junit.present" depends="setup-dependencies"> <antcall target="missing-dependency"> <param name="id" value="${junit.id}"/> <param name="version" value="${junit.version}"/> <param name="license" value="${junit.license}"/> <param name="license.url" value="${junit.license.url}"/> </antcall> </target> <target name="import-junit" depends="setup-dependencies"> <antcall target="import-dependency"> <param name="id" value="${junit.id}"/> <param name="version" value="${junit.version}"/> <param name="license" value="${junit.license}"/> <param name="license.url" value="${junit.license.url}"/> </antcall> </target> <!-- Log4J --> <target name="log4j-check" unless="log4j.present" depends="setup-dependencies"> <antcall target="missing-dependency"> <param name="id" value="${log4j.id}"/> <param name="version" value="${log4j.version}"/> <param name="license" value="${log4j.license}"/> <param name="license.url" value="${log4j.license.url}"/> </antcall> </target> <target name="import-log4j" depends="setup-dependencies"> <antcall target="import-dependency"> <param name="id" value="${log4j.id}"/> <param name="version" value="${log4j.version}"/> <param name="license" value="${log4j.license}"/> <param name="license.url" value="${log4j.license.url}"/> </antcall> </target> <!-- Logkit --> <target name="logkit-check" unless="logkit.present" depends="setup-dependencies"> <antcall target="missing-dependency"> <param name="id" value="${logkit.id}"/> <param name="version" value="${logkit.version}"/> <param name="license" value="${logkit.license}"/> <param name="license.url" value="${logkit.license.url}"/> </antcall> </target> <target name="import-logkit" depends="setup-dependencies"> <antcall target="import-dependency"> <param name="id" value="${logkit.id}"/> <param name="version" value="${logkit.version}"/> <param name="license" value="${logkit.license}"/> <param name="license.url" value="${logkit.license.url}"/> </antcall> </target> <!-- Rhino --> <target name="rhino-check" unless="rhino.present" depends="setup-dependencies"> <antcall target="missing-dependency"> <param name="id" value="${rhino.id}"/> <param name="version" value="${rhino.version}"/> <param name="license" value="${rhino.license}"/> <param name="license.url" value="${rhino.license.url}"/> </antcall> <target> <target name="import-rhino" depends="setup-dependencies"> <antcall target="import-dependency"> <param name="id" value="${rhino.id}"/> <param name="version" value="${rhino.version}"/> <param name="license" value="${rhino.license}"/> <param name="license.url" value="${rhino.license.url}"/> </antcall> </target> <!-- Servlet API --> <target name="servletapi-check" unless="javax.servlet.present" depends="setup-dependencies"> <antcall target="missing-dependency-noauto"> <param name="id" value="${servletapi.id}"/> <param name="version" value="${servletapi.version}"/> <param name="license" value="${servletapi.license}"/> <param name="license.url" value="${servletapi.license.url}"/> <param name="dist.url" value="${servletapi.dist.url}"/> </antcall> </target> 1.1 avalon-site/docs/logkit/api/org/apache/log/format/AvalonFormatter.html Index: AvalonFormatter.html =================================================================== <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd"> <!--NewPage--> <HTML> <HEAD> <!-- Generated by javadoc on Mon Feb 10 13:12:34 EST 2003 --> <TITLE> AvalonFormatter (LogKit API) </TITLE> <META NAME="keywords" CONTENT="org.apache.log.format.AvalonFormatter,AvalonFormatter class"> <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> </HEAD> <SCRIPT> function asd() { parent.document.title="AvalonFormatter (LogKit API)"; } </SCRIPT> <BODY BGCOLOR="white" onload="asd();"> <!-- ========== START OF NAVBAR ========== --> <A NAME="navbar_top"><!-- --></A> <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0"> <TR> <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A NAME="navbar_top_firstrow"><!-- --></A> <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3"> <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> </EM> </TD> </TR> <TR> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> PREV CLASS <A HREF="../../../../org/apache/log/format/ExtendedPatternFormatter.html"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../index.html" TARGET="_top"><B>FRAMES</B></A> <A HREF="AvalonFormatter.html" TARGET="_top"><B>NO FRAMES</B></A> <SCRIPT> <!-- if(window==top) { document.writeln('<A HREF="../../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>'); } //--> </SCRIPT> <NOSCRIPT> <A HREF="../../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A> </NOSCRIPT> </FONT></TD> </TR> <TR> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> SUMMARY: <A HREF="#nested_classes_inherited_from_class_org.apache.log.format.PatternFormatter">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> <!-- =========== END OF NAVBAR =========== --> <HR> <!-- ======== START OF CLASS DATA ======== --> <H2> <FONT SIZE="-1"> org.apache.log.format</FONT> <BR> Class AvalonFormatter</H2> <PRE> <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html">java.lang.Object</A> | +--<A HREF="../../../../org/apache/log/format/PatternFormatter.html">org.apache.log.format.PatternFormatter</A> | +--<A HREF="../../../../org/apache/log/format/ExtendedPatternFormatter.html">org.apache.log.format.ExtendedPatternFormatter</A> | +--<B>org.apache.log.format.AvalonFormatter</B> </PRE> <DL> <DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../org/apache/log/format/Formatter.html">Formatter</A>, <A HREF="../../../../org/apache/log/Formatter.html">Formatter</A></DD> </DL> <HR> <B>Deprecated.</B> <I>Use <code>org.apache.avalon.framework.logger.AvalonFormatter</code> instead of this one.</I> <P> <DL> <DT>public class <B>AvalonFormatter</B><DT>extends <A HREF="../../../../org/apache/log/format/ExtendedPatternFormatter.html">ExtendedPatternFormatter</A></DL> <P> This formatter extends ExtendedPatternFormatter so that CascadingExceptions are formatted with all nested exceptions. <ul> <li><code>class</code> : outputs the name of the class that has logged the message. The optional <code>short</code> subformat removes the package name. Warning : this pattern works only if formatting occurs in the same thread as the call to Logger, i.e. it won't work with <code>AsyncLogTarget</code>.</li> </ul> <P> <P> <DL> <DT><B>Author:</B></DT> <DD><a href="mailto:dev@avalon.apache.org">Avalon Development Team</a></DD> </DL> <HR> <P> <!-- ======== NESTED CLASS SUMMARY ======== --> <A NAME="nested_class_summary"><!-- --></A> <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TD COLSPAN=2><FONT SIZE="+2"> <B>Nested Class Summary</B></FONT></TD> </TR> </TABLE> <A NAME="nested_classes_inherited_from_class_org.apache.log.format.PatternFormatter"><!-- --></A> <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> <TD><B>Nested classes inherited from class org.apache.log.format.<A HREF="../../../../org/apache/log/format/PatternFormatter.html">PatternFormatter</A></B></TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><A HREF="../../../../org/apache/log/format/PatternFormatter.PatternRun.html">PatternFormatter.PatternRun</A></CODE></TD> </TR> </TABLE> <!-- =========== FIELD SUMMARY =========== --> <A NAME="field_summary"><!-- --></A> <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TD COLSPAN=2><FONT SIZE="+2"> <B>Field Summary</B></FONT></TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static boolean</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/log/format/AvalonFormatter.html#DEFAULT_PRINT_CASCADING">DEFAULT_PRINT_CASCADING</A></B></CODE> <BR> <B>Deprecated.</B> The constant defining the default behaviour for printing nested exceptions.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static int</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/log/format/AvalonFormatter.html#DEFAULT_STACK_DEPTH">DEFAULT_STACK_DEPTH</A></B></CODE> <BR> <B>Deprecated.</B> The constant defining the default stack depth when none other is specified.</TD> </TR> </TABLE> <A NAME="fields_inherited_from_class_org.apache.log.format.PatternFormatter"><!-- --></A> <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> <TD><B>Fields inherited from class org.apache.log.format.<A HREF="../../../../org/apache/log/format/PatternFormatter.html">PatternFormatter</A></B></TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><A HREF="../../../../org/apache/log/format/PatternFormatter.html#MAX_TYPE">MAX_TYPE</A></CODE></TD> </TR> </TABLE> <!-- ======== CONSTRUCTOR SUMMARY ======== --> <A NAME="constructor_summary"><!-- --></A> <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TD COLSPAN=2><FONT SIZE="+2"> <B>Constructor Summary</B></FONT></TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><B><A HREF="../../../../org/apache/log/format/AvalonFormatter.html#AvalonFormatter(java.lang.String)">AvalonFormatter</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> pattern)</CODE> <BR> <B>Deprecated.</B> Construct the formatter with the specified pattern and which which prints out exceptions to stackDepth of 8.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><B><A HREF="../../../../org/apache/log/format/AvalonFormatter.html#AvalonFormatter(java.lang.String, int, boolean)">AvalonFormatter</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> pattern, int stackDepth, boolean printCascading)</CODE> <BR> <B>Deprecated.</B> Construct the formatter with the specified pattern and which which prints out exceptions to stackDepth specified.</TD> </TR> </TABLE> <!-- ========== METHOD SUMMARY =========== --> <A NAME="method_summary"><!-- --></A> <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TD COLSPAN=2><FONT SIZE="+2"> <B>Method Summary</B></FONT></TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>protected <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/log/format/AvalonFormatter.html#formatPatternRun(org.apache.log.LogEvent, org.apache.log.format.PatternFormatter.PatternRun)">formatPatternRun</A></B>(<A HREF="../../../../org/apache/log/LogEvent.html">LogEvent</A> event, <A HREF="../../../../org/apache/log/format/PatternFormatter.PatternRun.html">PatternFormatter.PatternRun</A> run)</CODE> <BR> <B>Deprecated.</B> Formats a single pattern run (can be extended in subclasses).</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>protected <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/log/format/AvalonFormatter.html#getStackTrace(java.lang.Throwable, java.lang.String)">getStackTrace</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Throwable.html">Throwable</A> throwable, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> format)</CODE> <BR> <B>Deprecated.</B> Utility method to format stack trace.</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/log/format/AvalonFormatter.html#getTypeIdFor(java.lang.String)">getTypeIdFor</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> type)</CODE> <BR> <B>Deprecated.</B> Retrieve the type-id for a particular string.</TD> </TR> </TABLE> <A NAME="methods_inherited_from_class_org.apache.log.format.PatternFormatter"><!-- --></A> <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> <TD><B>Methods inherited from class org.apache.log.format.<A HREF="../../../../org/apache/log/format/PatternFormatter.html">PatternFormatter</A></B></TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><A HREF="../../../../org/apache/log/format/PatternFormatter.html#format(org.apache.log.LogEvent)">format</A>, <A HREF="../../../../org/apache/log/format/PatternFormatter.html#getCategory(java.lang.String, java.lang.String)">getCategory</A>, <A HREF="../../../../org/apache/log/format/PatternFormatter.html#getContext(org.apache.log.ContextStack, java.lang.String)">getContext</A>, <A HREF="../../../../org/apache/log/format/PatternFormatter.html#getContextMap(org.apache.log.ContextMap, java.lang.String)">getContextMap</A>, <A HREF="../../../../org/apache/log/format/PatternFormatter.html#getContextStack(org.apache.log.ContextStack, java.lang.String)">getContextStack</A>, <A HREF="../../../../org/apache/log/format/PatternFormatter.html#getMessage(java.lang.String, java.lang.String)">getMessage</A>, <A HREF="../../../../org/apache/log/format/PatternFormatter.html#getPriority(org.apache.log.Priority, java.lang.String)">getPriority</A>, <A HREF="../../../../org/apache/log/format/PatternFormatter.html#getRTime(long, java.lang.String)">getRTime</A>, <A HREF="../../../../org/apache/log/format/PatternFormatter.html#getThread(java.lang.String)">getThread</A>, <A HREF="../../../../org/apache/log/format/PatternFormatter.html#getTime(long, java.lang.String)">getTime</A>, <A HREF="../../../../org/apache/log/format/PatternFormatter.html#parse(java.lang.String)">parse</A>, <A HREF="../../../../org/apache/log/format/PatternFormatter.html#setFormat(java.lang.String)">setFormat</A></CODE></TD> </TR> </TABLE> <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> <TD><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html">Object</A></B></TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#clone()">clone</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#equals(java.lang.Object)">equals</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#finalize()">finalize</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#getClass()">getClass</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#hashCode()">hashCode</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#notify()">notify</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#notifyAll()">notifyAll</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#toString()">toString</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#wait()">wait</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#wait(long)">wait</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#wait(long, int)">wait</A></CODE></TD> </TR> </TABLE> <P> <!-- ============ FIELD DETAIL =========== --> <A NAME="field_detail"><!-- --></A> <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TD COLSPAN=1><FONT SIZE="+2"> <B>Field Detail</B></FONT></TD> </TR> </TABLE> <A NAME="DEFAULT_STACK_DEPTH"><!-- --></A><H3> DEFAULT_STACK_DEPTH</H3> <PRE> public static final int <B>DEFAULT_STACK_DEPTH</B></PRE> <DL> <DD><B>Deprecated.</B> <DD>The constant defining the default stack depth when none other is specified. <P> <DL> <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.log.format.AvalonFormatter.DEFAULT_STACK_DEPTH">Constant Field Values</A></DL> </DL> <HR> <A NAME="DEFAULT_PRINT_CASCADING"><!-- --></A><H3> DEFAULT_PRINT_CASCADING</H3> <PRE> public static final boolean <B>DEFAULT_PRINT_CASCADING</B></PRE> <DL> <DD><B>Deprecated.</B> <DD>The constant defining the default behaviour for printing nested exceptions. <P> <DL> <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.log.format.AvalonFormatter.DEFAULT_PRINT_CASCADING">Constant Field Values</A></DL> </DL> <!-- ========= CONSTRUCTOR DETAIL ======== --> <A NAME="constructor_detail"><!-- --></A> <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TD COLSPAN=1><FONT SIZE="+2"> <B>Constructor Detail</B></FONT></TD> </TR> </TABLE> <A NAME="AvalonFormatter(java.lang.String)"><!-- --></A><H3> AvalonFormatter</H3> <PRE> public <B>AvalonFormatter</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> pattern)</PRE> <DL> <DD><B>Deprecated.</B> <DD>Construct the formatter with the specified pattern and which which prints out exceptions to stackDepth of 8. <P> <DT><B>Parameters:</B><DD><CODE>pattern</CODE> - The pattern to use to format the log entries</DL> <HR> <A NAME="AvalonFormatter(java.lang.String, int, boolean)"><!-- --></A><H3> AvalonFormatter</H3> <PRE> public <B>AvalonFormatter</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> pattern, int stackDepth, boolean printCascading)</PRE> <DL> <DD><B>Deprecated.</B> <DD>Construct the formatter with the specified pattern and which which prints out exceptions to stackDepth specified. <P> <DT><B>Parameters:</B><DD><CODE>pattern</CODE> - The pattern to use to format the log entries<DD><CODE>stackDepth</CODE> - The depth to which stacktraces are printed out<DD><CODE>printCascading</CODE> - true enables printing of nested exceptions, false only prints out the outermost exception</DL> <!-- ============ METHOD DETAIL ========== --> <A NAME="method_detail"><!-- --></A> <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TD COLSPAN=1><FONT SIZE="+2"> <B>Method Detail</B></FONT></TD> </TR> </TABLE> <A NAME="getStackTrace(java.lang.Throwable, java.lang.String)"><!-- --></A><H3> getStackTrace</H3> <PRE> protected <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> <B>getStackTrace</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Throwable.html">Throwable</A> throwable, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> format)</PRE> <DL> <DD><B>Deprecated.</B> <DD>Utility method to format stack trace. <P> <DD><DL> <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/apache/log/format/PatternFormatter.html#getStackTrace(java.lang.Throwable, java.lang.String)">getStackTrace</A></CODE> in class <CODE><A HREF="../../../../org/apache/log/format/PatternFormatter.html">PatternFormatter</A></CODE></DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>throwable</CODE> - the throwable instance<DD><CODE>format</CODE> - ancilliary format parameter - allowed to be null <DT><B>Returns:</B><DD>the formatted string</DL> </DD> </DL> <HR> <A NAME="getTypeIdFor(java.lang.String)"><!-- --></A><H3> getTypeIdFor</H3> <PRE> protected int <B>getTypeIdFor</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> type)</PRE> <DL> <DD><B>Deprecated.</B> <DD>Retrieve the type-id for a particular string. <P> <DD><DL> <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/apache/log/format/ExtendedPatternFormatter.html#getTypeIdFor(java.lang.String)">getTypeIdFor</A></CODE> in class <CODE><A HREF="../../../../org/apache/log/format/ExtendedPatternFormatter.html">ExtendedPatternFormatter</A></CODE></DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>type</CODE> - the string <DT><B>Returns:</B><DD>the type-id</DL> </DD> </DL> <HR> <A NAME="formatPatternRun(org.apache.log.LogEvent, org.apache.log.format.PatternFormatter.PatternRun)"><!-- --></A><H3> formatPatternRun</H3> <PRE> protected <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> <B>formatPatternRun</B>(<A HREF="../../../../org/apache/log/LogEvent.html">LogEvent</A> event, <A HREF="../../../../org/apache/log/format/PatternFormatter.PatternRun.html">PatternFormatter.PatternRun</A> run)</PRE> <DL> <DD><B>Deprecated.</B> <DD><B>Description copied from class: <CODE><A HREF="../../../../org/apache/log/format/ExtendedPatternFormatter.html">ExtendedPatternFormatter</A></CODE></B></DD> <DD>Formats a single pattern run (can be extended in subclasses). <P> <DD><DL> <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/apache/log/format/ExtendedPatternFormatter.html#formatPatternRun(org.apache.log.LogEvent, org.apache.log.format.PatternFormatter.PatternRun)">formatPatternRun</A></CODE> in class <CODE><A HREF="../../../../org/apache/log/format/ExtendedPatternFormatter.html">ExtendedPatternFormatter</A></CODE></DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>event</CODE> - the log event<DD><CODE>run</CODE> - the pattern run to format. <DT><B>Returns:</B><DD>the formatted result.</DL> </DD> </DL> <!-- ========= END OF CLASS DATA ========= --> <HR> <!-- ========== START OF NAVBAR ========== --> <A NAME="navbar_bottom"><!-- --></A> <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0"> <TR> <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A NAME="navbar_bottom_firstrow"><!-- --></A> <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3"> <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> </EM> </TD> </TR> <TR> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> PREV CLASS <A HREF="../../../../org/apache/log/format/ExtendedPatternFormatter.html"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../index.html" TARGET="_top"><B>FRAMES</B></A> <A HREF="AvalonFormatter.html" TARGET="_top"><B>NO FRAMES</B></A> <SCRIPT> <!-- if(window==top) { document.writeln('<A HREF="../../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>'); } //--> </SCRIPT> <NOSCRIPT> <A HREF="../../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A> </NOSCRIPT> </FONT></TD> </TR> <TR> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> SUMMARY: <A HREF="#nested_classes_inherited_from_class_org.apache.log.format.PatternFormatter">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> <!-- =========== END OF NAVBAR =========== --> <HR> Copyright © 2001 Apache Jakarta Project. All Rights Reserved. </BODY> </HTML>
--------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]