blob: 322210d5c2f32c4fdee8f5a8ea6a026067c38802 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Frameset//EN""http://www.w3.org/TR/REC-html40/frameset.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc on Fri Jun 15 16:53:35 PDT 2001 -->
<TITLE>
Apache Struts API Documentation: Class Digester
</TITLE>
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
</HEAD>
<BODY BGCOLOR="white">
<!-- ========== START OF NAVBAR ========== -->
<A NAME="navbar_top"><!-- --></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=2 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>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../org/apache/struts/digester/CallParamRule.html"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../org/apache/struts/digester/ObjectCreateRule.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> &nbsp;
&nbsp;<A HREF="Digester.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: &nbsp;INNER&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: &nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
org.apache.struts.digester</FONT>
<BR>
Class Digester</H2>
<PRE>
<B>org.apache.struts.digester.Digester</B>
</PRE>
<HR>
<DL>
<DT>public class <B>Digester</B></DL>
<P>
<p>A <strong>Digester</strong> processes an XML input stream by matching a
series of element nesting patterns to execute Rules that have been added
prior to the start of parsing. This package was inspired by the
<code>XmlMapper</code> class that was part of Tomcat 3.0 and 3.1,
but is organized somewhat differently.</p>
<p>See the <a href="package-summary.html#package_description">Digester
Developer Guide</a> for more information.</p>
<p><strong>IMPLEMENTATION NOTE</strong> - A single Digester instance may
only be used within the context of a single thread at a time, and a call
to <code>parse()</code> must be completed before another can be initiated
even from the same thread.</p>
<P>
<DL>
<DT><B>Version: </B><DD>$Revision: 1.1 $ $Date$</DD>
<DT><B>Author: </B><DD>Craig McClanahan</DD>
</DL>
<HR>
<P>
<!-- ======== INNER CLASS SUMMARY ======== -->
<!-- =========== 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>protected &nbsp;java.lang.StringBuffer</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/digester/Digester.html#bodyText">bodyText</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The body text of the current element.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected &nbsp;<A HREF="../../../../org/apache/struts/util/ArrayStack.html">ArrayStack</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/digester/Digester.html#bodyTexts">bodyTexts</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The stack of body text string buffers for surrounding elements.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected &nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/digester/Digester.html#debug">debug</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The debugging detail level of this component.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected &nbsp;java.util.HashMap</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/digester/Digester.html#dtds">dtds</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The URLs of DTDs that have been registered, keyed by the public
identifier that corresponds.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected &nbsp;org.xml.sax.ErrorHandler</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/digester/Digester.html#errorHandler">errorHandler</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The application-supplied error handler that is notified when parsing
warnings, errors, or fatal errors occur.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected &nbsp;org.xml.sax.Locator</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/digester/Digester.html#locator">locator</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The Locator associated with our parser.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected &nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/digester/Digester.html#match">match</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The current match pattern for nested element processing.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected &nbsp;javax.xml.parsers.SAXParser</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/digester/Digester.html#parser">parser</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The SAXParser we will use to parse the input stream.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected &nbsp;java.lang.Object</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/digester/Digester.html#root">root</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The "root" element of the stack (in other words, the last object
that was popped.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected &nbsp;java.util.HashMap</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/digester/Digester.html#rules">rules</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The set of Rules that have been registered with this Digester.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected &nbsp;<A HREF="../../../../org/apache/struts/util/ArrayStack.html">ArrayStack</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/digester/Digester.html#stack">stack</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The object stack being constructed.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected &nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/digester/Digester.html#validating">validating</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Do we want to use a validating parser?</TD>
</TR>
</TABLE>
&nbsp;
<!-- ======== 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/struts/digester/Digester.html#Digester()">Digester</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Construct a new Digester with default properties.</TD>
</TR>
</TABLE>
&nbsp;
<!-- ========== 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>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/digester/Digester.html#addCallMethod(java.lang.String, java.lang.String, int)">addCallMethod</A></B>(java.lang.String&nbsp;pattern,
java.lang.String&nbsp;methodName,
int&nbsp;paramCount)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Add an "call method" rule for the specified parameters.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/digester/Digester.html#addCallMethod(java.lang.String, java.lang.String, int, java.lang.Class[])">addCallMethod</A></B>(java.lang.String&nbsp;pattern,
java.lang.String&nbsp;methodName,
int&nbsp;paramCount,
java.lang.Class[]&nbsp;paramTypes)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Add an "call method" rule for the specified parameters.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/digester/Digester.html#addCallMethod(java.lang.String, java.lang.String, int, java.lang.String[])">addCallMethod</A></B>(java.lang.String&nbsp;pattern,
java.lang.String&nbsp;methodName,
int&nbsp;paramCount,
java.lang.String[]&nbsp;paramTypes)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Add an "call method" rule for the specified parameters.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/digester/Digester.html#addCallParam(java.lang.String, int)">addCallParam</A></B>(java.lang.String&nbsp;pattern,
int&nbsp;paramIndex)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Add a "call parameter" rule for the specified parameters.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/digester/Digester.html#addCallParam(java.lang.String, int, java.lang.String)">addCallParam</A></B>(java.lang.String&nbsp;pattern,
int&nbsp;paramIndex,
java.lang.String&nbsp;attributeName)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Add a "call parameter" rule for the specified parameters.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/digester/Digester.html#addObjectCreate(java.lang.String, java.lang.String)">addObjectCreate</A></B>(java.lang.String&nbsp;pattern,
java.lang.String&nbsp;className)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Add an "object create" rule for the specified parameters.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/digester/Digester.html#addObjectCreate(java.lang.String, java.lang.String, java.lang.String)">addObjectCreate</A></B>(java.lang.String&nbsp;pattern,
java.lang.String&nbsp;className,
java.lang.String&nbsp;attributeName)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Add an "object create" rule for the specified parameters.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/digester/Digester.html#addRule(java.lang.String, org.apache.struts.digester.Rule)">addRule</A></B>(java.lang.String&nbsp;pattern,
<A HREF="../../../../org/apache/struts/digester/Rule.html">Rule</A>&nbsp;rule)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Register a new Rule matching the specified pattern.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/digester/Digester.html#addSetNext(java.lang.String, java.lang.String)">addSetNext</A></B>(java.lang.String&nbsp;pattern,
java.lang.String&nbsp;methodName)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Add a "set next" rule for the specified parameters.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/digester/Digester.html#addSetNext(java.lang.String, java.lang.String, java.lang.String)">addSetNext</A></B>(java.lang.String&nbsp;pattern,
java.lang.String&nbsp;methodName,
java.lang.String&nbsp;paramType)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Add a "set next" rule for the specified parameters.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/digester/Digester.html#addSetProperties(java.lang.String)">addSetProperties</A></B>(java.lang.String&nbsp;pattern)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Add a "set properties" rule for the specified parameters.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/digester/Digester.html#addSetProperty(java.lang.String, java.lang.String, java.lang.String)">addSetProperty</A></B>(java.lang.String&nbsp;pattern,
java.lang.String&nbsp;name,
java.lang.String&nbsp;value)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Add a "set property" rule for the specified parameters.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/digester/Digester.html#addSetTop(java.lang.String, java.lang.String)">addSetTop</A></B>(java.lang.String&nbsp;pattern,
java.lang.String&nbsp;methodName)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Add a "set top" rule for the specified parameters.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/digester/Digester.html#addSetTop(java.lang.String, java.lang.String, java.lang.String)">addSetTop</A></B>(java.lang.String&nbsp;pattern,
java.lang.String&nbsp;methodName,
java.lang.String&nbsp;paramType)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Add a "set top" rule for the specified parameters.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/digester/Digester.html#characters(char[], int, int)">characters</A></B>(char[]&nbsp;buffer,
int&nbsp;start,
int&nbsp;length)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Process notification of character data received from the body of
an XML element.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/digester/Digester.html#clear()">clear</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Clear the current contents of the object stack.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/digester/Digester.html#endDocument()">endDocument</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Process notification of the end of the document being reached.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/digester/Digester.html#endElement(java.lang.String)">endElement</A></B>(java.lang.String&nbsp;name)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Process notification of the end of an XML element being reached.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/digester/Digester.html#error(org.xml.sax.SAXParseException)">error</A></B>(org.xml.sax.SAXParseException&nbsp;exception)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Forward notification of a parsing error to the application supplied
error handler (if any).</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/digester/Digester.html#fatalError(org.xml.sax.SAXParseException)">fatalError</A></B>(org.xml.sax.SAXParseException&nbsp;exception)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Forward notification of a fatal parsing error to the application
supplied error handler (if any).</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/digester/Digester.html#getCount()">getCount</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return the current depth of the element stack.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/digester/Digester.html#getDebug()">getDebug</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return the debugging detail level of this Digester.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;org.xml.sax.ErrorHandler</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/digester/Digester.html#getErrorHandler()">getErrorHandler</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return the error handler for this Digester.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;javax.xml.parsers.SAXParser</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/digester/Digester.html#getParser()">getParser</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return the SAXParser we will use to parse the input stream.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected &nbsp;java.util.List</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/digester/Digester.html#getRules(java.lang.String)">getRules</A></B>(java.lang.String&nbsp;match)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return the set of rules that apply to the specified match position.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/digester/Digester.html#getValidating()">getValidating</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return the validating parser flag.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/digester/Digester.html#ignorableWhitespace(char[], int, int)">ignorableWhitespace</A></B>(char[]&nbsp;buffer,
int&nbsp;start,
int&nbsp;len)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Process notification of ignorable whitespace received from the body of
an XML element.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/digester/Digester.html#log(java.lang.String)">log</A></B>(java.lang.String&nbsp;message)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Log a message to the log writer associated with this context.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/digester/Digester.html#log(java.lang.String, java.lang.Throwable)">log</A></B>(java.lang.String&nbsp;message,
java.lang.Throwable&nbsp;exception)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Log a message and associated exception to the log writer
associated with this context.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/digester/Digester.html#notationDecl(java.lang.String, java.lang.String, java.lang.String)">notationDecl</A></B>(java.lang.String&nbsp;name,
java.lang.String&nbsp;publicId,
java.lang.String&nbsp;systemId)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Receive notification of a notation declaration event.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.Object</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/digester/Digester.html#parse(java.io.File)">parse</A></B>(java.io.File&nbsp;file)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Parse the content of the specified file using this Digester.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.Object</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/digester/Digester.html#parse(org.xml.sax.InputSource)">parse</A></B>(org.xml.sax.InputSource&nbsp;input)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Parse the content of the specified input source using this Digester.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.Object</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/digester/Digester.html#parse(java.io.InputStream)">parse</A></B>(java.io.InputStream&nbsp;input)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Parse the content of the specified input stream using this Digester.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.Object</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/digester/Digester.html#parse(java.lang.String)">parse</A></B>(java.lang.String&nbsp;uri)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Parse the content of the specified URI using this Digester.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.Object</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/digester/Digester.html#peek()">peek</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return the top object on the stack without removing it.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.Object</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/digester/Digester.html#peek(int)">peek</A></B>(int&nbsp;n)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return the n'th object down the stack, where 0 is the top element
and [getCount()-1] is the bottom element.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.Object</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/digester/Digester.html#pop()">pop</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Pop the top object off of the stack, and return it.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/digester/Digester.html#processingInstruction(java.lang.String, java.lang.String)">processingInstruction</A></B>(java.lang.String&nbsp;target,
java.lang.String&nbsp;data)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Process notification of a processing instruction that was encountered.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/digester/Digester.html#push(java.lang.Object)">push</A></B>(java.lang.Object&nbsp;object)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Push a new object onto the top of the object stack.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/digester/Digester.html#register(java.lang.String, java.lang.String)">register</A></B>(java.lang.String&nbsp;publicId,
java.lang.String&nbsp;dtdURL)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Register the specified DTD URL for the specified public identifier.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;org.xml.sax.InputSource</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/digester/Digester.html#resolveEntity(java.lang.String, java.lang.String)">resolveEntity</A></B>(java.lang.String&nbsp;publicId,
java.lang.String&nbsp;systemId)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Resolve the requested external entity.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/digester/Digester.html#setDebug(int)">setDebug</A></B>(int&nbsp;debug)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the debugging detail level of this Digester.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/digester/Digester.html#setDocumentLocator(org.xml.sax.Locator)">setDocumentLocator</A></B>(org.xml.sax.Locator&nbsp;locator)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the document locator associated with our parser.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/digester/Digester.html#setErrorHandler(org.xml.sax.ErrorHandler)">setErrorHandler</A></B>(org.xml.sax.ErrorHandler&nbsp;errorHandler)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the error handler for this Digester.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/digester/Digester.html#setValidating(boolean)">setValidating</A></B>(boolean&nbsp;validating)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the validating parser flag.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/digester/Digester.html#startDocument()">startDocument</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Process notification of the beginning of the document being reached.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/digester/Digester.html#startElement(java.lang.String, org.xml.sax.AttributeList)">startElement</A></B>(java.lang.String&nbsp;name,
org.xml.sax.AttributeList&nbsp;list)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Process notification of the start of an XML element being reached.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/digester/Digester.html#unparsedEntityDecl(java.lang.String, java.lang.String, java.lang.String, java.lang.String)">unparsedEntityDecl</A></B>(java.lang.String&nbsp;name,
java.lang.String&nbsp;publicId,
java.lang.String&nbsp;systemId,
java.lang.String&nbsp;notation)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Receive notification of an unparsed entity declaration event.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/digester/Digester.html#warning(org.xml.sax.SAXParseException)">warning</A></B>(org.xml.sax.SAXParseException&nbsp;exception)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Forward notification of a parse warning to the application supplied
error handler (if any).</TD>
</TR>
</TABLE>
&nbsp;
<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="bodyText"><!-- --></A><H3>
bodyText</H3>
<PRE>
protected java.lang.StringBuffer <B>bodyText</B></PRE>
<DL>
<DD>The body text of the current element.</DL>
<HR>
<A NAME="bodyTexts"><!-- --></A><H3>
bodyTexts</H3>
<PRE>
protected <A HREF="../../../../org/apache/struts/util/ArrayStack.html">ArrayStack</A> <B>bodyTexts</B></PRE>
<DL>
<DD>The stack of body text string buffers for surrounding elements.</DL>
<HR>
<A NAME="debug"><!-- --></A><H3>
debug</H3>
<PRE>
protected int <B>debug</B></PRE>
<DL>
<DD>The debugging detail level of this component.</DL>
<HR>
<A NAME="dtds"><!-- --></A><H3>
dtds</H3>
<PRE>
protected java.util.HashMap <B>dtds</B></PRE>
<DL>
<DD>The URLs of DTDs that have been registered, keyed by the public
identifier that corresponds.</DL>
<HR>
<A NAME="errorHandler"><!-- --></A><H3>
errorHandler</H3>
<PRE>
protected org.xml.sax.ErrorHandler <B>errorHandler</B></PRE>
<DL>
<DD>The application-supplied error handler that is notified when parsing
warnings, errors, or fatal errors occur.</DL>
<HR>
<A NAME="locator"><!-- --></A><H3>
locator</H3>
<PRE>
protected org.xml.sax.Locator <B>locator</B></PRE>
<DL>
<DD>The Locator associated with our parser.</DL>
<HR>
<A NAME="match"><!-- --></A><H3>
match</H3>
<PRE>
protected java.lang.String <B>match</B></PRE>
<DL>
<DD>The current match pattern for nested element processing.</DL>
<HR>
<A NAME="parser"><!-- --></A><H3>
parser</H3>
<PRE>
protected javax.xml.parsers.SAXParser <B>parser</B></PRE>
<DL>
<DD>The SAXParser we will use to parse the input stream.</DL>
<HR>
<A NAME="root"><!-- --></A><H3>
root</H3>
<PRE>
protected java.lang.Object <B>root</B></PRE>
<DL>
<DD>The "root" element of the stack (in other words, the last object
that was popped.</DL>
<HR>
<A NAME="rules"><!-- --></A><H3>
rules</H3>
<PRE>
protected java.util.HashMap <B>rules</B></PRE>
<DL>
<DD>The set of Rules that have been registered with this Digester. The
key is the matching pattern against the current element stack, and
the value is a List containing the Rules for that pattern, in the
order that they were registered.</DL>
<HR>
<A NAME="stack"><!-- --></A><H3>
stack</H3>
<PRE>
protected <A HREF="../../../../org/apache/struts/util/ArrayStack.html">ArrayStack</A> <B>stack</B></PRE>
<DL>
<DD>The object stack being constructed.</DL>
<HR>
<A NAME="validating"><!-- --></A><H3>
validating</H3>
<PRE>
protected boolean <B>validating</B></PRE>
<DL>
<DD>Do we want to use a validating parser?</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="Digester()"><!-- --></A><H3>
Digester</H3>
<PRE>
public <B>Digester</B>()</PRE>
<DL>
<DD>Construct a new Digester with default properties.</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="getCount()"><!-- --></A><H3>
getCount</H3>
<PRE>
public int <B>getCount</B>()</PRE>
<DL>
<DD>Return the current depth of the element stack.</DL>
<HR>
<A NAME="getDebug()"><!-- --></A><H3>
getDebug</H3>
<PRE>
public int <B>getDebug</B>()</PRE>
<DL>
<DD>Return the debugging detail level of this Digester.</DL>
<HR>
<A NAME="setDebug(int)"><!-- --></A><H3>
setDebug</H3>
<PRE>
public void <B>setDebug</B>(int&nbsp;debug)</PRE>
<DL>
<DD>Set the debugging detail level of this Digester.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>debug</CODE> - The new debugging detail level</DL>
</DD>
</DL>
<HR>
<A NAME="getErrorHandler()"><!-- --></A><H3>
getErrorHandler</H3>
<PRE>
public org.xml.sax.ErrorHandler <B>getErrorHandler</B>()</PRE>
<DL>
<DD>Return the error handler for this Digester.</DL>
<HR>
<A NAME="setErrorHandler(org.xml.sax.ErrorHandler)"><!-- --></A><H3>
setErrorHandler</H3>
<PRE>
public void <B>setErrorHandler</B>(org.xml.sax.ErrorHandler&nbsp;errorHandler)</PRE>
<DL>
<DD>Set the error handler for this Digester.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>errorHandler</CODE> - The new error handler</DL>
</DD>
</DL>
<HR>
<A NAME="getParser()"><!-- --></A><H3>
getParser</H3>
<PRE>
public javax.xml.parsers.SAXParser <B>getParser</B>()</PRE>
<DL>
<DD>Return the SAXParser we will use to parse the input stream. If there
is a problem creating the parser, return <code>null</code>.</DL>
<HR>
<A NAME="getValidating()"><!-- --></A><H3>
getValidating</H3>
<PRE>
public boolean <B>getValidating</B>()</PRE>
<DL>
<DD>Return the validating parser flag.</DL>
<HR>
<A NAME="setValidating(boolean)"><!-- --></A><H3>
setValidating</H3>
<PRE>
public void <B>setValidating</B>(boolean&nbsp;validating)</PRE>
<DL>
<DD>Set the validating parser flag. This must be called before
<code>parse()</code> is called the first time.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>validating</CODE> - The new validating parser flag.</DL>
</DD>
</DL>
<HR>
<A NAME="characters(char[], int, int)"><!-- --></A><H3>
characters</H3>
<PRE>
public void <B>characters</B>(char[]&nbsp;buffer,
int&nbsp;start,
int&nbsp;length)
throws org.xml.sax.SAXException</PRE>
<DL>
<DD>Process notification of character data received from the body of
an XML element.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>buffer</CODE> - The characters from the XML document<DD><CODE>start</CODE> - Starting offset into the buffer<DD><CODE>length</CODE> - Number of characters from the buffer<DT><B>Throws:</B><DD><CODE>SAXException</CODE> - if a parsing error is to be reported</DL>
</DD>
</DL>
<HR>
<A NAME="endDocument()"><!-- --></A><H3>
endDocument</H3>
<PRE>
public void <B>endDocument</B>()
throws org.xml.sax.SAXException</PRE>
<DL>
<DD>Process notification of the end of the document being reached.<DD><DL>
<DT><B>Throws:</B><DD><CODE>SAXException</CODE> - if a parsing error is to be reported</DL>
</DD>
</DL>
<HR>
<A NAME="endElement(java.lang.String)"><!-- --></A><H3>
endElement</H3>
<PRE>
public void <B>endElement</B>(java.lang.String&nbsp;name)
throws org.xml.sax.SAXException</PRE>
<DL>
<DD>Process notification of the end of an XML element being reached.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - Name of the element that is ending<DT><B>Throws:</B><DD><CODE>SAXException</CODE> - if a parsing error is to be reported</DL>
</DD>
</DL>
<HR>
<A NAME="ignorableWhitespace(char[], int, int)"><!-- --></A><H3>
ignorableWhitespace</H3>
<PRE>
public void <B>ignorableWhitespace</B>(char[]&nbsp;buffer,
int&nbsp;start,
int&nbsp;len)
throws org.xml.sax.SAXException</PRE>
<DL>
<DD>Process notification of ignorable whitespace received from the body of
an XML element.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>buffer</CODE> - The characters from the XML document<DD><CODE>start</CODE> - Starting offset into the buffer<DD><CODE>length</CODE> - Number of characters from the buffer<DT><B>Throws:</B><DD><CODE>SAXException</CODE> - if a parsing error is to be reported</DL>
</DD>
</DL>
<HR>
<A NAME="processingInstruction(java.lang.String, java.lang.String)"><!-- --></A><H3>
processingInstruction</H3>
<PRE>
public void <B>processingInstruction</B>(java.lang.String&nbsp;target,
java.lang.String&nbsp;data)
throws org.xml.sax.SAXException</PRE>
<DL>
<DD>Process notification of a processing instruction that was encountered.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>target</CODE> - The processing instruction target<DD><CODE>data</CODE> - The processing instruction data (if any)<DT><B>Throws:</B><DD><CODE>SAXException</CODE> - if a parsing error is to be reported</DL>
</DD>
</DL>
<HR>
<A NAME="setDocumentLocator(org.xml.sax.Locator)"><!-- --></A><H3>
setDocumentLocator</H3>
<PRE>
public void <B>setDocumentLocator</B>(org.xml.sax.Locator&nbsp;locator)</PRE>
<DL>
<DD>Set the document locator associated with our parser.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>locator</CODE> - The new locator</DL>
</DD>
</DL>
<HR>
<A NAME="startDocument()"><!-- --></A><H3>
startDocument</H3>
<PRE>
public void <B>startDocument</B>()
throws org.xml.sax.SAXException</PRE>
<DL>
<DD>Process notification of the beginning of the document being reached.<DD><DL>
<DT><B>Throws:</B><DD><CODE>SAXException</CODE> - if a parsing error is to be reported</DL>
</DD>
</DL>
<HR>
<A NAME="startElement(java.lang.String, org.xml.sax.AttributeList)"><!-- --></A><H3>
startElement</H3>
<PRE>
public void <B>startElement</B>(java.lang.String&nbsp;name,
org.xml.sax.AttributeList&nbsp;list)
throws org.xml.sax.SAXException</PRE>
<DL>
<DD>Process notification of the start of an XML element being reached.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - Name of the element that is starting<DD><CODE>list</CODE> - The attributes associated with this element<DT><B>Throws:</B><DD><CODE>SAXException</CODE> - if a parsing error is to be reported</DL>
</DD>
</DL>
<HR>
<A NAME="notationDecl(java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
notationDecl</H3>
<PRE>
public void <B>notationDecl</B>(java.lang.String&nbsp;name,
java.lang.String&nbsp;publicId,
java.lang.String&nbsp;systemId)</PRE>
<DL>
<DD>Receive notification of a notation declaration event.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - The notation name<DD><CODE>publicId</CODE> - The public identifier (if any)<DD><CODE>systemId</CODE> - The system identifier (if any)</DL>
</DD>
</DL>
<HR>
<A NAME="unparsedEntityDecl(java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
unparsedEntityDecl</H3>
<PRE>
public void <B>unparsedEntityDecl</B>(java.lang.String&nbsp;name,
java.lang.String&nbsp;publicId,
java.lang.String&nbsp;systemId,
java.lang.String&nbsp;notation)</PRE>
<DL>
<DD>Receive notification of an unparsed entity declaration event.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - The unparsed entity name<DD><CODE>publicId</CODE> - The public identifier (if any)<DD><CODE>systemId</CODE> - The system identifier (if any)<DD><CODE>notation</CODE> - The name of the associated notation</DL>
</DD>
</DL>
<HR>
<A NAME="resolveEntity(java.lang.String, java.lang.String)"><!-- --></A><H3>
resolveEntity</H3>
<PRE>
public org.xml.sax.InputSource <B>resolveEntity</B>(java.lang.String&nbsp;publicId,
java.lang.String&nbsp;systemId)
throws org.xml.sax.SAXException</PRE>
<DL>
<DD>Resolve the requested external entity.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>publicId</CODE> - The public identifier of the entity being referenced<DD><CODE>systemId</CODE> - The system identifier of the entity being referenced<DT><B>Throws:</B><DD><CODE>SAXException</CODE> - if a parsing exception occurs</DL>
</DD>
</DL>
<HR>
<A NAME="error(org.xml.sax.SAXParseException)"><!-- --></A><H3>
error</H3>
<PRE>
public void <B>error</B>(org.xml.sax.SAXParseException&nbsp;exception)
throws org.xml.sax.SAXException</PRE>
<DL>
<DD>Forward notification of a parsing error to the application supplied
error handler (if any).<DD><DL>
<DT><B>Parameters:</B><DD><CODE>exception</CODE> - The error information<DT><B>Throws:</B><DD><CODE>SAXException</CODE> - if a parsing exception occurs</DL>
</DD>
</DL>
<HR>
<A NAME="fatalError(org.xml.sax.SAXParseException)"><!-- --></A><H3>
fatalError</H3>
<PRE>
public void <B>fatalError</B>(org.xml.sax.SAXParseException&nbsp;exception)
throws org.xml.sax.SAXException</PRE>
<DL>
<DD>Forward notification of a fatal parsing error to the application
supplied error handler (if any).<DD><DL>
<DT><B>Parameters:</B><DD><CODE>exception</CODE> - The fatal error information<DT><B>Throws:</B><DD><CODE>SAXException</CODE> - if a parsing exception occurs</DL>
</DD>
</DL>
<HR>
<A NAME="warning(org.xml.sax.SAXParseException)"><!-- --></A><H3>
warning</H3>
<PRE>
public void <B>warning</B>(org.xml.sax.SAXParseException&nbsp;exception)
throws org.xml.sax.SAXException</PRE>
<DL>
<DD>Forward notification of a parse warning to the application supplied
error handler (if any).<DD><DL>
<DT><B>Parameters:</B><DD><CODE>exception</CODE> - The warning information<DT><B>Throws:</B><DD><CODE>SAXException</CODE> - if a parsing exception occurs</DL>
</DD>
</DL>
<HR>
<A NAME="log(java.lang.String)"><!-- --></A><H3>
log</H3>
<PRE>
public void <B>log</B>(java.lang.String&nbsp;message)</PRE>
<DL>
<DD>Log a message to the log writer associated with this context.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>message</CODE> - The message to be logged</DL>
</DD>
</DL>
<HR>
<A NAME="log(java.lang.String, java.lang.Throwable)"><!-- --></A><H3>
log</H3>
<PRE>
public void <B>log</B>(java.lang.String&nbsp;message,
java.lang.Throwable&nbsp;exception)</PRE>
<DL>
<DD>Log a message and associated exception to the log writer
associated with this context.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>message</CODE> - The message to be logged<DD><CODE>exception</CODE> - The associated exception to be logged</DL>
</DD>
</DL>
<HR>
<A NAME="parse(java.io.File)"><!-- --></A><H3>
parse</H3>
<PRE>
public java.lang.Object <B>parse</B>(java.io.File&nbsp;file)
throws java.io.IOException,
org.xml.sax.SAXException</PRE>
<DL>
<DD>Parse the content of the specified file using this Digester. Returns
the root element from the object stack (if any).<DD><DL>
<DT><B>Parameters:</B><DD><CODE>file</CODE> - File containing the XML data to be parsed<DT><B>Throws:</B><DD><CODE>java.io.IOException</CODE> - if an input/output error occurs<DD><CODE>SAXException</CODE> - if a parsing exception occurs</DL>
</DD>
</DL>
<HR>
<A NAME="parse(org.xml.sax.InputSource)"><!-- --></A><H3>
parse</H3>
<PRE>
public java.lang.Object <B>parse</B>(org.xml.sax.InputSource&nbsp;input)
throws java.io.IOException,
org.xml.sax.SAXException</PRE>
<DL>
<DD>Parse the content of the specified input source using this Digester.
Returns the root element from the object stack (if any).<DD><DL>
<DT><B>Parameters:</B><DD><CODE>input</CODE> - Input source containing the XML data to be parsed<DT><B>Throws:</B><DD><CODE>java.io.IOException</CODE> - if an input/output error occurs<DD><CODE>SAXException</CODE> - if a parsing exception occurs</DL>
</DD>
</DL>
<HR>
<A NAME="parse(java.io.InputStream)"><!-- --></A><H3>
parse</H3>
<PRE>
public java.lang.Object <B>parse</B>(java.io.InputStream&nbsp;input)
throws java.io.IOException,
org.xml.sax.SAXException</PRE>
<DL>
<DD>Parse the content of the specified input stream using this Digester.
Returns the root element from the object stack (if any).<DD><DL>
<DT><B>Parameters:</B><DD><CODE>input</CODE> - Input stream containing the XML data to be parsed<DT><B>Throws:</B><DD><CODE>java.io.IOException</CODE> - if an input/output error occurs<DD><CODE>SAXException</CODE> - if a parsing exception occurs</DL>
</DD>
</DL>
<HR>
<A NAME="parse(java.lang.String)"><!-- --></A><H3>
parse</H3>
<PRE>
public java.lang.Object <B>parse</B>(java.lang.String&nbsp;uri)
throws java.io.IOException,
org.xml.sax.SAXException</PRE>
<DL>
<DD>Parse the content of the specified URI using this Digester.
Returns the root element from the object stack (if any).<DD><DL>
<DT><B>Parameters:</B><DD><CODE>uri</CODE> - URI containing the XML data to be parsed<DT><B>Throws:</B><DD><CODE>java.io.IOException</CODE> - if an input/output error occurs<DD><CODE>SAXException</CODE> - if a parsing exception occurs</DL>
</DD>
</DL>
<HR>
<A NAME="register(java.lang.String, java.lang.String)"><!-- --></A><H3>
register</H3>
<PRE>
public void <B>register</B>(java.lang.String&nbsp;publicId,
java.lang.String&nbsp;dtdURL)</PRE>
<DL>
<DD>Register the specified DTD URL for the specified public identifier.
This must be called before the first call to <code>parse()</code>.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>publicId</CODE> - Public identifier of the DTD to be resolved<DD><CODE>dtdURL</CODE> - The URL to use for reading this DTD</DL>
</DD>
</DL>
<HR>
<A NAME="addRule(java.lang.String, org.apache.struts.digester.Rule)"><!-- --></A><H3>
addRule</H3>
<PRE>
public void <B>addRule</B>(java.lang.String&nbsp;pattern,
<A HREF="../../../../org/apache/struts/digester/Rule.html">Rule</A>&nbsp;rule)</PRE>
<DL>
<DD>Register a new Rule matching the specified pattern.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>pattern</CODE> - Element matching pattern<DD><CODE>rule</CODE> - Rule to be registered</DL>
</DD>
</DL>
<HR>
<A NAME="addCallMethod(java.lang.String, java.lang.String, int)"><!-- --></A><H3>
addCallMethod</H3>
<PRE>
public void <B>addCallMethod</B>(java.lang.String&nbsp;pattern,
java.lang.String&nbsp;methodName,
int&nbsp;paramCount)</PRE>
<DL>
<DD>Add an "call method" rule for the specified parameters.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>pattern</CODE> - Element matching pattern<DD><CODE>methodName</CODE> - Method name to be called<DD><CODE>paramCount</CODE> - Number of expected parameters (or zero
for a single parameter from the body of this element)</DL>
</DD>
</DL>
<HR>
<A NAME="addCallMethod(java.lang.String, java.lang.String, int, java.lang.String[])"><!-- --></A><H3>
addCallMethod</H3>
<PRE>
public void <B>addCallMethod</B>(java.lang.String&nbsp;pattern,
java.lang.String&nbsp;methodName,
int&nbsp;paramCount,
java.lang.String[]&nbsp;paramTypes)</PRE>
<DL>
<DD>Add an "call method" rule for the specified parameters.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>pattern</CODE> - Element matching pattern<DD><CODE>methodName</CODE> - Method name to be called<DD><CODE>paramCount</CODE> - Number of expected parameters (or zero
for a single parameter from the body of this element)<DD><CODE>paramTypes</CODE> - Set of Java class names for the types
of the expected parameters
(if you wish to use a primitive type, specify the corresonding
Java wrapper class instead, such as <code>java.lang.Boolean</code>
for a <code>boolean</code> parameter)</DL>
</DD>
</DL>
<HR>
<A NAME="addCallMethod(java.lang.String, java.lang.String, int, java.lang.Class[])"><!-- --></A><H3>
addCallMethod</H3>
<PRE>
public void <B>addCallMethod</B>(java.lang.String&nbsp;pattern,
java.lang.String&nbsp;methodName,
int&nbsp;paramCount,
java.lang.Class[]&nbsp;paramTypes)</PRE>
<DL>
<DD>Add an "call method" rule for the specified parameters.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>pattern</CODE> - Element matching pattern<DD><CODE>methodName</CODE> - Method name to be called<DD><CODE>paramCount</CODE> - Number of expected parameters (or zero
for a single parameter from the body of this element)<DD><CODE>paramTypes</CODE> - The Java class names of the arguments
(if you wish to use a primitive type, specify the corresonding
Java wrapper class instead, such as <code>java.lang.Boolean</code>
for a <code>boolean</code> parameter)</DL>
</DD>
</DL>
<HR>
<A NAME="addCallParam(java.lang.String, int)"><!-- --></A><H3>
addCallParam</H3>
<PRE>
public void <B>addCallParam</B>(java.lang.String&nbsp;pattern,
int&nbsp;paramIndex)</PRE>
<DL>
<DD>Add a "call parameter" rule for the specified parameters.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>pattern</CODE> - Element matching pattern<DD><CODE>paramIndex</CODE> - Zero-relative parameter index to set
(from the body of this element)</DL>
</DD>
</DL>
<HR>
<A NAME="addCallParam(java.lang.String, int, java.lang.String)"><!-- --></A><H3>
addCallParam</H3>
<PRE>
public void <B>addCallParam</B>(java.lang.String&nbsp;pattern,
int&nbsp;paramIndex,
java.lang.String&nbsp;attributeName)</PRE>
<DL>
<DD>Add a "call parameter" rule for the specified parameters.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>pattern</CODE> - Element matching pattern<DD><CODE>paramIndex</CODE> - Zero-relative parameter index to set
(from the specified attribute)<DD><CODE>attributeName</CODE> - Attribute whose value is used as the
parameter value</DL>
</DD>
</DL>
<HR>
<A NAME="addObjectCreate(java.lang.String, java.lang.String)"><!-- --></A><H3>
addObjectCreate</H3>
<PRE>
public void <B>addObjectCreate</B>(java.lang.String&nbsp;pattern,
java.lang.String&nbsp;className)</PRE>
<DL>
<DD>Add an "object create" rule for the specified parameters.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>pattern</CODE> - Element matching pattern<DD><CODE>className</CODE> - Java class name to be created</DL>
</DD>
</DL>
<HR>
<A NAME="addObjectCreate(java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
addObjectCreate</H3>
<PRE>
public void <B>addObjectCreate</B>(java.lang.String&nbsp;pattern,
java.lang.String&nbsp;className,
java.lang.String&nbsp;attributeName)</PRE>
<DL>
<DD>Add an "object create" rule for the specified parameters.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>pattern</CODE> - Element matching pattern<DD><CODE>className</CODE> - Default Java class name to be created<DD><CODE>attributeName</CODE> - Attribute name that optionally overrides
the default Java class name to be created</DL>
</DD>
</DL>
<HR>
<A NAME="addSetNext(java.lang.String, java.lang.String)"><!-- --></A><H3>
addSetNext</H3>
<PRE>
public void <B>addSetNext</B>(java.lang.String&nbsp;pattern,
java.lang.String&nbsp;methodName)</PRE>
<DL>
<DD>Add a "set next" rule for the specified parameters.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>pattern</CODE> - Element matching pattern<DD><CODE>methodName</CODE> - Method name to call on the parent element</DL>
</DD>
</DL>
<HR>
<A NAME="addSetNext(java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
addSetNext</H3>
<PRE>
public void <B>addSetNext</B>(java.lang.String&nbsp;pattern,
java.lang.String&nbsp;methodName,
java.lang.String&nbsp;paramType)</PRE>
<DL>
<DD>Add a "set next" rule for the specified parameters.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>pattern</CODE> - Element matching pattern<DD><CODE>methodName</CODE> - Method name to call on the parent element<DD><CODE>paramType</CODE> - Java class name of the expected parameter type
(if you wish to use a primitive type, specify the corresonding
Java wrapper class instead, such as <code>java.lang.Boolean</code>
for a <code>boolean</code> parameter)</DL>
</DD>
</DL>
<HR>
<A NAME="addSetProperties(java.lang.String)"><!-- --></A><H3>
addSetProperties</H3>
<PRE>
public void <B>addSetProperties</B>(java.lang.String&nbsp;pattern)</PRE>
<DL>
<DD>Add a "set properties" rule for the specified parameters.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>pattern</CODE> - Element matching pattern</DL>
</DD>
</DL>
<HR>
<A NAME="addSetProperty(java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
addSetProperty</H3>
<PRE>
public void <B>addSetProperty</B>(java.lang.String&nbsp;pattern,
java.lang.String&nbsp;name,
java.lang.String&nbsp;value)</PRE>
<DL>
<DD>Add a "set property" rule for the specified parameters.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>pattern</CODE> - Element matching pattern<DD><CODE>name</CODE> - Attribute name containing the property name to be set<DD><CODE>value</CODE> - Attribute name containing the property value to set</DL>
</DD>
</DL>
<HR>
<A NAME="addSetTop(java.lang.String, java.lang.String)"><!-- --></A><H3>
addSetTop</H3>
<PRE>
public void <B>addSetTop</B>(java.lang.String&nbsp;pattern,
java.lang.String&nbsp;methodName)</PRE>
<DL>
<DD>Add a "set top" rule for the specified parameters.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>pattern</CODE> - Element matching pattern<DD><CODE>methodName</CODE> - Method name to call on the parent element</DL>
</DD>
</DL>
<HR>
<A NAME="addSetTop(java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
addSetTop</H3>
<PRE>
public void <B>addSetTop</B>(java.lang.String&nbsp;pattern,
java.lang.String&nbsp;methodName,
java.lang.String&nbsp;paramType)</PRE>
<DL>
<DD>Add a "set top" rule for the specified parameters.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>pattern</CODE> - Element matching pattern<DD><CODE>methodName</CODE> - Method name to call on the parent element<DD><CODE>paramType</CODE> - Java class name of the expected parameter type
(if you wish to use a primitive type, specify the corresonding
Java wrapper class instead, such as <code>java.lang.Boolean</code>
for a <code>boolean</code> parameter)</DL>
</DD>
</DL>
<HR>
<A NAME="clear()"><!-- --></A><H3>
clear</H3>
<PRE>
public void <B>clear</B>()</PRE>
<DL>
<DD>Clear the current contents of the object stack.</DL>
<HR>
<A NAME="peek()"><!-- --></A><H3>
peek</H3>
<PRE>
public java.lang.Object <B>peek</B>()</PRE>
<DL>
<DD>Return the top object on the stack without removing it. If there are
no objects on the stack, return <code>null</code>.</DL>
<HR>
<A NAME="peek(int)"><!-- --></A><H3>
peek</H3>
<PRE>
public java.lang.Object <B>peek</B>(int&nbsp;n)</PRE>
<DL>
<DD>Return the n'th object down the stack, where 0 is the top element
and [getCount()-1] is the bottom element. If the specified index
is out of range, return <code>null</code>.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>n</CODE> - Index of the desired element, where 0 is the top of the stack,
1 is the next element down, and so on.</DL>
</DD>
</DL>
<HR>
<A NAME="pop()"><!-- --></A><H3>
pop</H3>
<PRE>
public java.lang.Object <B>pop</B>()</PRE>
<DL>
<DD>Pop the top object off of the stack, and return it. If there are
no objects on the stack, return <code>null</code>.</DL>
<HR>
<A NAME="push(java.lang.Object)"><!-- --></A><H3>
push</H3>
<PRE>
public void <B>push</B>(java.lang.Object&nbsp;object)</PRE>
<DL>
<DD>Push a new object onto the top of the object stack.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>object</CODE> - The new object</DL>
</DD>
</DL>
<HR>
<A NAME="getRules(java.lang.String)"><!-- --></A><H3>
getRules</H3>
<PRE>
protected java.util.List <B>getRules</B>(java.lang.String&nbsp;match)</PRE>
<DL>
<DD>Return the set of rules that apply to the specified match position.
The selected rules are those that match exactly, or those rules
that specify a suffix match and the tail of the rule matches the
current match position. Exact matches have precedence over
suffix matches, then (among suffix matches) the longest match
is preferred.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>match</CODE> - The current match position</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=2 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>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../org/apache/struts/digester/CallParamRule.html"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../org/apache/struts/digester/ObjectCreateRule.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> &nbsp;
&nbsp;<A HREF="Digester.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: &nbsp;INNER&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: &nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->
<HR>
Copyright © 2000-2001 - Apache Software Foundation
</BODY>
</HTML>