| <!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 ActionErrors |
| </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> </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"> |
| <A HREF="../../../../org/apache/struts/action/ActionError.html"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/apache/struts/action/ActionForm.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="ActionErrors.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: INNER | <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.struts.action</FONT> |
| <BR> |
| Class ActionErrors</H2> |
| <PRE> |
| java.lang.Object |
| | |
| +--<B>org.apache.struts.action.ActionErrors</B> |
| </PRE> |
| <DL> |
| <DT><B>All Implemented Interfaces:</B> <DD>java.io.Serializable</DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT>public class <B>ActionErrors</B><DT>extends java.lang.Object<DT>implements java.io.Serializable</DL> |
| |
| <P> |
| <p>A class that encapsulates the error messages being reported by |
| the <code>validate()</code> method of an <code>ActionForm</code>. |
| Validation errors are either global to the entire <code>ActionForm</code> |
| bean they are associated with, or they are specific to a particular |
| bean property (and, therefore, a particular input field on the corresponding |
| form).</p> |
| |
| <p>Each individual error is described by an <code>ActionError</code> |
| object, which contains a message key (to be looked up in an appropriate |
| message resources database), and up to four placeholder arguments used for |
| parametric substitution in the resulting message.</p> |
| |
| <p><strong>IMPLEMENTATION NOTE</strong> - It is assumed that these objects |
| are created and manipulated only within the context of a single thread. |
| Therefore, no synchronization is required for access to internal |
| collections.</p> |
| <P> |
| <DL> |
| <DT><B>Author: </B><DD>David Geary, Craig R. McClanahan</DD> |
| <DT><B>See Also: </B><DD><A HREF="../../../../serialized-form.html#org.apache.struts.action.ActionErrors">Serialized Form</A></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 java.util.HashMap</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionErrors.html#errors">errors</A></B></CODE> |
| |
| <BR> |
| The accumulated set of <code>ActionError</code> objects (represented |
| as an ArrayList) for each property, keyed by property name.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionErrors.html#GLOBAL_ERROR">GLOBAL_ERROR</A></B></CODE> |
| |
| <BR> |
| The "property name" marker to use for global errors, as opposed to |
| those related to a specific property.</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/struts/action/ActionErrors.html#ActionErrors()">ActionErrors</A></B>()</CODE> |
| |
| <BR> |
| </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> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionErrors.html#add(java.lang.String, org.apache.struts.action.ActionError)">add</A></B>(java.lang.String property, |
| <A HREF="../../../../org/apache/struts/action/ActionError.html">ActionError</A> error)</CODE> |
| |
| <BR> |
| Add an error message to the set of errors for the specified property.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionErrors.html#clear()">clear</A></B>()</CODE> |
| |
| <BR> |
| Clear all error messages recorded by this object.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionErrors.html#empty()">empty</A></B>()</CODE> |
| |
| <BR> |
| Return <code>true</code> if there are no error messages recorded |
| in this collection, or <code>false</code> otherwise.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.util.Iterator</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionErrors.html#get()">get</A></B>()</CODE> |
| |
| <BR> |
| Return the set of all recorded error messages, without distinction |
| by which property the messages are associated with.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.util.Iterator</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionErrors.html#get(java.lang.String)">get</A></B>(java.lang.String property)</CODE> |
| |
| <BR> |
| Return the set of error messages related to a specific property.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.util.Iterator</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionErrors.html#properties()">properties</A></B>()</CODE> |
| |
| <BR> |
| Return the set of property names for which at least one error has |
| been recorded.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionErrors.html#size()">size</A></B>()</CODE> |
| |
| <BR> |
| Return the number of errors recorded for all properties (including |
| global errors).</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionErrors.html#size(java.lang.String)">size</A></B>(java.lang.String property)</CODE> |
| |
| <BR> |
| Return the number of errors associated with the specified property.</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.Object</B></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><clinit>, clone, equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, toString, wait, wait, wait</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="GLOBAL_ERROR"><!-- --></A><H3> |
| GLOBAL_ERROR</H3> |
| <PRE> |
| public static final java.lang.String <B>GLOBAL_ERROR</B></PRE> |
| <DL> |
| <DD>The "property name" marker to use for global errors, as opposed to |
| those related to a specific property.</DL> |
| <HR> |
| |
| <A NAME="errors"><!-- --></A><H3> |
| errors</H3> |
| <PRE> |
| protected java.util.HashMap <B>errors</B></PRE> |
| <DL> |
| <DD>The accumulated set of <code>ActionError</code> objects (represented |
| as an ArrayList) for each property, keyed by property name.</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="ActionErrors()"><!-- --></A><H3> |
| ActionErrors</H3> |
| <PRE> |
| public <B>ActionErrors</B>()</PRE> |
| <DL> |
| </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="add(java.lang.String, org.apache.struts.action.ActionError)"><!-- --></A><H3> |
| add</H3> |
| <PRE> |
| public void <B>add</B>(java.lang.String property, |
| <A HREF="../../../../org/apache/struts/action/ActionError.html">ActionError</A> error)</PRE> |
| <DL> |
| <DD>Add an error message to the set of errors for the specified property.<DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>property</CODE> - Property name (or ActionErrors.GLOBAL_ERROR)<DD><CODE>error</CODE> - The error message to be added</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="clear()"><!-- --></A><H3> |
| clear</H3> |
| <PRE> |
| public void <B>clear</B>()</PRE> |
| <DL> |
| <DD>Clear all error messages recorded by this object.<DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="empty()"><!-- --></A><H3> |
| empty</H3> |
| <PRE> |
| public boolean <B>empty</B>()</PRE> |
| <DL> |
| <DD>Return <code>true</code> if there are no error messages recorded |
| in this collection, or <code>false</code> otherwise.<DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="get()"><!-- --></A><H3> |
| get</H3> |
| <PRE> |
| public java.util.Iterator <B>get</B>()</PRE> |
| <DL> |
| <DD>Return the set of all recorded error messages, without distinction |
| by which property the messages are associated with. If there are |
| no error messages recorded, an empty enumeration is returned.<DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="get(java.lang.String)"><!-- --></A><H3> |
| get</H3> |
| <PRE> |
| public java.util.Iterator <B>get</B>(java.lang.String property)</PRE> |
| <DL> |
| <DD>Return the set of error messages related to a specific property. |
| If there are no such errors, an empty enumeration is returned.<DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>property</CODE> - Property name (or ActionErrors.GLOBAL_ERROR)</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="properties()"><!-- --></A><H3> |
| properties</H3> |
| <PRE> |
| public java.util.Iterator <B>properties</B>()</PRE> |
| <DL> |
| <DD>Return the set of property names for which at least one error has |
| been recorded. If there are no errors, an empty Iterator is returned. |
| If you have recorded global errors, the String value of |
| <code>ActionErrors.GLOBAL_ERROR</code> will be one of the returned |
| property names.<DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="size()"><!-- --></A><H3> |
| size</H3> |
| <PRE> |
| public int <B>size</B>()</PRE> |
| <DL> |
| <DD>Return the number of errors recorded for all properties (including |
| global errors). <strong>NOTE</strong> - it is more efficient to call |
| <code>empty()</code> if all you care about is whether or not there are |
| any error messages at all.<DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="size(java.lang.String)"><!-- --></A><H3> |
| size</H3> |
| <PRE> |
| public int <B>size</B>(java.lang.String property)</PRE> |
| <DL> |
| <DD>Return the number of errors associated with the specified property.<DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>property</CODE> - Property name (or ActionErrors.GLOBAL_ERROR)</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> </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"> |
| <A HREF="../../../../org/apache/struts/action/ActionError.html"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/apache/struts/action/ActionForm.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="ActionErrors.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: INNER | <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 © 2000-2001 - Apache Software Foundation |
| </BODY> |
| </HTML> |
