You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@struts.apache.org by rl...@apache.org on 2003/04/21 05:56:51 UTC
cvs commit: jakarta-struts/legacy/api-1.0/org/apache/struts/upload DiskMultipartRequestHandler.html FormFile.html MaxLengthExceededException.html
rleland 2003/04/20 20:56:51
Modified: legacy/api-1.0/org/apache/struts/upload
DiskMultipartRequestHandler.html FormFile.html
MaxLengthExceededException.html
Log:
Struts CVS main trunk, Update Javadoc for legacy 1.0
items based on Backport all changes to DiskXXXX
code so it is identical to struts 1.1 code as of April 20th 2003.
Revision Changes Path
1.2 +236 -70 jakarta-struts/legacy/api-1.0/org/apache/struts/upload/DiskMultipartRequestHandler.html
Index: DiskMultipartRequestHandler.html
===================================================================
RCS file: /home/cvs/jakarta-struts/legacy/api-1.0/org/apache/struts/upload/DiskMultipartRequestHandler.html,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- DiskMultipartRequestHandler.html 17 Sep 2001 20:12:43 -0000 1.1
+++ DiskMultipartRequestHandler.html 21 Apr 2003 03:56:51 -0000 1.2
@@ -1,20 +1,27 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Frameset//EN""http://www.w3.org/TR/REC-html40/frameset.dtd">
+<!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 Fri Jun 15 16:53:37 PDT 2001 -->
+<!-- Generated by javadoc on Sun Apr 20 23:50:13 EDT 2003 -->
<TITLE>
-Apache Struts API Documentation: Class DiskMultipartRequestHandler
+DiskMultipartRequestHandler (Apache Struts API Documentation)
</TITLE>
+<META NAME="keywords" CONTENT="org.apache.struts.upload.DiskMultipartRequestHandler,DiskMultipartRequestHandler class">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
</HEAD>
-<BODY BGCOLOR="white">
+<SCRIPT>
+function asd()
+{
+parent.document.title="DiskMultipartRequestHandler (Apache Struts API Documentation)";
+}
+</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=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
+<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">
@@ -36,16 +43,28 @@
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../org/apache/struts/upload/DiskFile.html"><B>PREV CLASS</B></A>
- <A HREF="../../../../org/apache/struts/upload/MultipartElement.html"><B>NEXT CLASS</B></A></FONT></TD>
+ <A HREF="../../../../org/apache/struts/upload/MultipartBoundaryInputStream.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="DiskMultipartRequestHandler.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
+ <A HREF="DiskMultipartRequestHandler.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: INNER | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
+ SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
-DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
+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 =========== -->
@@ -56,7 +75,7 @@
<FONT SIZE="-1">
org.apache.struts.upload</FONT>
<BR>
-Class DiskMultipartRequestHandler</H2>
+Class DiskMultipartRequestHandler</H2>
<PRE>
java.lang.Object
|
@@ -73,13 +92,16 @@
This is a MultipartRequestHandler that writes file data directly to
to temporary files on disk.
<P>
+
+<P>
<DL>
-<DT><B>Author: </B><DD>Mike Schachter</DD>
+<DT><B>Author:</B></DT>
+ <DD>Mike Schachter</DD>
</DL>
<HR>
<P>
-<!-- ======== INNER CLASS SUMMARY ======== -->
+<!-- ======== NESTED CLASS SUMMARY ======== -->
<!-- =========== FIELD SUMMARY =========== -->
@@ -96,7 +118,7 @@
<TD><CODE><B><A HREF="../../../../org/apache/struts/upload/DiskMultipartRequestHandler.html#allElements">allElements</A></B></CODE>
<BR>
- A Hashtable representing all elemnents</TD>
+ A Hashtable representing all elemnents.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -104,7 +126,7 @@
<TD><CODE><B><A HREF="../../../../org/apache/struts/upload/DiskMultipartRequestHandler.html#fileElements">fileElements</A></B></CODE>
<BR>
- A Hashtable representing the form files uploaded</TD>
+ A Hashtable representing the form files uploaded.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -112,7 +134,7 @@
<TD><CODE><B><A HREF="../../../../org/apache/struts/upload/DiskMultipartRequestHandler.html#mapping">mapping</A></B></CODE>
<BR>
- The ActionMapping instance used for this class</TD>
+ The ActionMapping instance used for this class.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -120,7 +142,7 @@
<TD><CODE><B><A HREF="../../../../org/apache/struts/upload/DiskMultipartRequestHandler.html#servlet">servlet</A></B></CODE>
<BR>
- The ActionServlet instance used for this class</TD>
+ The ActionServlet instance used for this class.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -128,7 +150,7 @@
<TD><CODE><B><A HREF="../../../../org/apache/struts/upload/DiskMultipartRequestHandler.html#tempDir">tempDir</A></B></CODE>
<BR>
- The temporary directory</TD>
+ The temporary directory.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -136,7 +158,16 @@
<TD><CODE><B><A HREF="../../../../org/apache/struts/upload/DiskMultipartRequestHandler.html#textElements">textElements</A></B></CODE>
<BR>
- A Hashtable representing the form text input names and values</TD>
+ A Hashtable representing the form text input names and values.</TD>
+</TR>
+</TABLE>
+ <A NAME="fields_inherited_from_class_org.apache.struts.upload.MultipartRequestHandler"><!-- --></A>
+<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
+<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
+<TD><B>Fields inherited from interface org.apache.struts.upload.<A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html">MultipartRequestHandler</A></B></TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD><CODE><A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html#ATTRIBUTE_MAX_LENGTH_EXCEEDED">ATTRIBUTE_MAX_LENGTH_EXCEEDED</A></CODE></TD>
</TR>
</TABLE>
@@ -166,12 +197,29 @@
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>protected void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../org/apache/struts/upload/DiskMultipartRequestHandler.html#createDiskFile(org.apache.struts.upload.MultipartElement)">createDiskFile</A></B>(<A HREF="../../../../org/apache/struts/upload/MultipartElement.html">MultipartElement</A> element)</CODE>
+
+<BR>
+ </TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>protected void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../org/apache/struts/upload/DiskMultipartRequestHandler.html#createTextElement(javax.servlet.http.HttpServletRequest, org.apache.struts.upload.MultipartElement)">createTextElement</A></B>(javax.servlet.http.HttpServletRequest request,
+ <A HREF="../../../../org/apache/struts/upload/MultipartElement.html">MultipartElement</A> element)</CODE>
+
+<BR>
+ </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/upload/DiskMultipartRequestHandler.html#finish()">finish</A></B>()</CODE>
<BR>
Calls on <A HREF="../../../../org/apache/struts/upload/DiskMultipartRequestHandler.html#rollback()"><CODE>rollback()</CODE></A> to delete
- temporary files</TD>
+ temporary files.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -201,11 +249,11 @@
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected long</CODE></FONT></TD>
-<TD><CODE><B><A HREF="../../../../org/apache/struts/upload/DiskMultipartRequestHandler.html#getMaxSizeFromServlet()">getMaxSizeFromServlet</A></B>()</CODE>
+<TD><CODE><B><A HREF="../../../../org/apache/struts/upload/DiskMultipartRequestHandler.html#getMaxSize()">getMaxSize</A></B>()</CODE>
<BR>
Gets the maximum post data size in bytes from the string
- representation in ActionServlet</TD>
+ representation in the configuration file.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -239,7 +287,7 @@
<BR>
Retrieves the temporary directory from either ActionServlet, a context
- property, or a system property, in that order</TD>
+ property, or a system property, in that order.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -247,7 +295,7 @@
<TD><CODE><B><A HREF="../../../../org/apache/struts/upload/DiskMultipartRequestHandler.html#rollback()">rollback</A></B>()</CODE>
<BR>
- Delete all the files uploaded</TD>
+ Delete all the files uploaded.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -274,7 +322,7 @@
<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>
+<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
@@ -295,7 +343,11 @@
<PRE>
protected <A HREF="../../../../org/apache/struts/action/ActionServlet.html">ActionServlet</A> <B>servlet</B></PRE>
<DL>
-<DD>The ActionServlet instance used for this class</DL>
+<DD>The ActionServlet instance used for this class.
+<P>
+<DL>
+</DL>
+</DL>
<HR>
<A NAME="mapping"><!-- --></A><H3>
@@ -303,7 +355,11 @@
<PRE>
protected <A HREF="../../../../org/apache/struts/action/ActionMapping.html">ActionMapping</A> <B>mapping</B></PRE>
<DL>
-<DD>The ActionMapping instance used for this class</DL>
+<DD>The ActionMapping instance used for this class.
+<P>
+<DL>
+</DL>
+</DL>
<HR>
<A NAME="fileElements"><!-- --></A><H3>
@@ -311,7 +367,11 @@
<PRE>
protected java.util.Hashtable <B>fileElements</B></PRE>
<DL>
-<DD>A Hashtable representing the form files uploaded</DL>
+<DD>A Hashtable representing the form files uploaded.
+<P>
+<DL>
+</DL>
+</DL>
<HR>
<A NAME="textElements"><!-- --></A><H3>
@@ -319,7 +379,11 @@
<PRE>
protected java.util.Hashtable <B>textElements</B></PRE>
<DL>
-<DD>A Hashtable representing the form text input names and values</DL>
+<DD>A Hashtable representing the form text input names and values.
+<P>
+<DL>
+</DL>
+</DL>
<HR>
<A NAME="allElements"><!-- --></A><H3>
@@ -327,7 +391,11 @@
<PRE>
protected java.util.Hashtable <B>allElements</B></PRE>
<DL>
-<DD>A Hashtable representing all elemnents</DL>
+<DD>A Hashtable representing all elemnents.
+<P>
+<DL>
+</DL>
+</DL>
<HR>
<A NAME="tempDir"><!-- --></A><H3>
@@ -335,7 +403,11 @@
<PRE>
protected java.lang.String <B>tempDir</B></PRE>
<DL>
-<DD>The temporary directory</DL>
+<DD>The temporary directory.
+<P>
+<DL>
+</DL>
+</DL>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
@@ -372,12 +444,44 @@
<DL>
<DD>This method populates the internal hashtables with multipart request data.
If the request argument is an instance of MultipartRequestWrapper,
- the request wrapper will be populated as well.<DD><DL>
-<DT><B>Specified by: </B><DD><CODE><A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html#handleRequest(javax.servlet.http.HttpServletRequest)">handleRequest</A></CODE> in interface <CODE><A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html">MultipartRequestHandler</A></CODE></DL>
+ the request wrapper will be populated as well.
+<P>
+<DD><DL>
+<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html#handleRequest(javax.servlet.http.HttpServletRequest)">handleRequest</A></CODE> in interface <CODE><A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html">MultipartRequestHandler</A></CODE></DL>
</DD>
-<DD>Following copied from interface: <CODE>org.apache.struts.upload.MultipartRequestHandler</CODE></DD>
<DD><DL>
-<DT><B>Throws:</B><DD><CODE>javax.servlet.ServletException</CODE> - thrown if something goes wrong</DL>
+
+<DT><B>Throws:</B>
+<DD><CODE>javax.servlet.ServletException</CODE> - thrown if something goes wrong</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="createTextElement(javax.servlet.http.HttpServletRequest, org.apache.struts.upload.MultipartElement)"><!-- --></A><H3>
+createTextElement</H3>
+<PRE>
+protected void <B>createTextElement</B>(javax.servlet.http.HttpServletRequest request,
+ <A HREF="../../../../org/apache/struts/upload/MultipartElement.html">MultipartElement</A> element)</PRE>
+<DL>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="createDiskFile(org.apache.struts.upload.MultipartElement)"><!-- --></A><H3>
+createDiskFile</H3>
+<PRE>
+protected void <B>createDiskFile</B>(<A HREF="../../../../org/apache/struts/upload/MultipartElement.html">MultipartElement</A> element)</PRE>
+<DL>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+</DL>
</DD>
</DL>
<HR>
@@ -388,12 +492,15 @@
public java.util.Hashtable <B>getAllElements</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html">MultipartRequestHandler</A></CODE></B></DD>
-<DD>This method returns all elements of a multipart request.<DD><DL>
-<DT><B>Specified by: </B><DD><CODE><A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html#getAllElements()">getAllElements</A></CODE> in interface <CODE><A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html">MultipartRequestHandler</A></CODE></DL>
+<DD>This method returns all elements of a multipart request.
+<P>
+<DD><DL>
+<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html#getAllElements()">getAllElements</A></CODE> in interface <CODE><A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html">MultipartRequestHandler</A></CODE></DL>
</DD>
-<DD>Following copied from interface: <CODE>org.apache.struts.upload.MultipartRequestHandler</CODE></DD>
<DD><DL>
-<DT><B>Returns:</B><DD>A Hashtable where the keys are input names and values are either Strings or FormFiles</DL>
+
+<DT><B>Returns:</B><DD>A Hashtable where the keys are input names and values
+ are either Strings or FormFiles</DL>
</DD>
</DL>
<HR>
@@ -405,12 +512,15 @@
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html">MultipartRequestHandler</A></CODE></B></DD>
<DD>This method is called on to retrieve all the text
- input elements of the request.<DD><DL>
-<DT><B>Specified by: </B><DD><CODE><A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html#getTextElements()">getTextElements</A></CODE> in interface <CODE><A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html">MultipartRequestHandler</A></CODE></DL>
+ input elements of the request.
+<P>
+<DD><DL>
+<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html#getTextElements()">getTextElements</A></CODE> in interface <CODE><A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html">MultipartRequestHandler</A></CODE></DL>
</DD>
-<DD>Following copied from interface: <CODE>org.apache.struts.upload.MultipartRequestHandler</CODE></DD>
<DD><DL>
-<DT><B>Returns:</B><DD>A Hashtable where the keys and values are the names and values of the request input parameters</DL>
+
+<DT><B>Returns:</B><DD>A Hashtable where the keys and values are the names and
+ values of the request input parameters</DL>
</DD>
</DL>
<HR>
@@ -422,12 +532,15 @@
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html">MultipartRequestHandler</A></CODE></B></DD>
<DD>This method is called on to retrieve all the FormFile
- input elements of the request.<DD><DL>
-<DT><B>Specified by: </B><DD><CODE><A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html#getFileElements()">getFileElements</A></CODE> in interface <CODE><A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html">MultipartRequestHandler</A></CODE></DL>
+ input elements of the request.
+<P>
+<DD><DL>
+<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html#getFileElements()">getFileElements</A></CODE> in interface <CODE><A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html">MultipartRequestHandler</A></CODE></DL>
</DD>
-<DD>Following copied from interface: <CODE>org.apache.struts.upload.MultipartRequestHandler</CODE></DD>
<DD><DL>
-<DT><B>Returns:</B><DD>A Hashtable where the keys are the input names of the files and the values are FormFile objects<DT><B>See Also: </B><DD><A HREF="../../../../org/apache/struts/upload/FormFile.html"><CODE>FormFile</CODE></A></DL>
+
+<DT><B>Returns:</B><DD>A Hashtable where the keys are the input names of the
+ files and the values are FormFile objects<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/struts/upload/FormFile.html"><CODE>FormFile</CODE></A></DL>
</DD>
</DL>
<HR>
@@ -437,8 +550,13 @@
<PRE>
public void <B>rollback</B>()</PRE>
<DL>
-<DD>Delete all the files uploaded<DD><DL>
-<DT><B>Specified by: </B><DD><CODE><A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html#rollback()">rollback</A></CODE> in interface <CODE><A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html">MultipartRequestHandler</A></CODE></DL>
+<DD>Delete all the files uploaded.
+<P>
+<DD><DL>
+<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html#rollback()">rollback</A></CODE> in interface <CODE><A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html">MultipartRequestHandler</A></CODE></DL>
+</DD>
+<DD><DL>
+</DL>
</DD>
</DL>
<HR>
@@ -449,8 +567,13 @@
public void <B>finish</B>()</PRE>
<DL>
<DD>Calls on <A HREF="../../../../org/apache/struts/upload/DiskMultipartRequestHandler.html#rollback()"><CODE>rollback()</CODE></A> to delete
- temporary files<DD><DL>
-<DT><B>Specified by: </B><DD><CODE><A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html#finish()">finish</A></CODE> in interface <CODE><A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html">MultipartRequestHandler</A></CODE></DL>
+ temporary files.
+<P>
+<DD><DL>
+<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html#finish()">finish</A></CODE> in interface <CODE><A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html">MultipartRequestHandler</A></CODE></DL>
+</DD>
+<DD><DL>
+</DL>
</DD>
</DL>
<HR>
@@ -462,8 +585,13 @@
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html">MultipartRequestHandler</A></CODE></B></DD>
<DD>Convienience method to set a reference to a working
- ActionServlet instance.<DD><DL>
-<DT><B>Specified by: </B><DD><CODE><A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html#setServlet(org.apache.struts.action.ActionServlet)">setServlet</A></CODE> in interface <CODE><A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html">MultipartRequestHandler</A></CODE></DL>
+ ActionServlet instance.
+<P>
+<DD><DL>
+<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html#setServlet(org.apache.struts.action.ActionServlet)">setServlet</A></CODE> in interface <CODE><A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html">MultipartRequestHandler</A></CODE></DL>
+</DD>
+<DD><DL>
+</DL>
</DD>
</DL>
<HR>
@@ -475,8 +603,13 @@
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html">MultipartRequestHandler</A></CODE></B></DD>
<DD>Convienience method to set a reference to a working
- ActionMapping instance.<DD><DL>
-<DT><B>Specified by: </B><DD><CODE><A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html#setMapping(org.apache.struts.action.ActionMapping)">setMapping</A></CODE> in interface <CODE><A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html">MultipartRequestHandler</A></CODE></DL>
+ ActionMapping instance.
+<P>
+<DD><DL>
+<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html#setMapping(org.apache.struts.action.ActionMapping)">setMapping</A></CODE> in interface <CODE><A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html">MultipartRequestHandler</A></CODE></DL>
+</DD>
+<DD><DL>
+</DL>
</DD>
</DL>
<HR>
@@ -487,8 +620,13 @@
public <A HREF="../../../../org/apache/struts/action/ActionServlet.html">ActionServlet</A> <B>getServlet</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html">MultipartRequestHandler</A></CODE></B></DD>
-<DD>Get the ActionServlet instance<DD><DL>
-<DT><B>Specified by: </B><DD><CODE><A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html#getServlet()">getServlet</A></CODE> in interface <CODE><A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html">MultipartRequestHandler</A></CODE></DL>
+<DD>Get the ActionServlet instance
+<P>
+<DD><DL>
+<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html#getServlet()">getServlet</A></CODE> in interface <CODE><A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html">MultipartRequestHandler</A></CODE></DL>
+</DD>
+<DD><DL>
+</DL>
</DD>
</DL>
<HR>
@@ -499,22 +637,33 @@
public <A HREF="../../../../org/apache/struts/action/ActionMapping.html">ActionMapping</A> <B>getMapping</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html">MultipartRequestHandler</A></CODE></B></DD>
-<DD>Get the ActionMapping instance for this request<DD><DL>
-<DT><B>Specified by: </B><DD><CODE><A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html#getMapping()">getMapping</A></CODE> in interface <CODE><A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html">MultipartRequestHandler</A></CODE></DL>
+<DD>Get the ActionMapping instance for this request
+<P>
+<DD><DL>
+<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html#getMapping()">getMapping</A></CODE> in interface <CODE><A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html">MultipartRequestHandler</A></CODE></DL>
+</DD>
+<DD><DL>
+</DL>
</DD>
</DL>
<HR>
-<A NAME="getMaxSizeFromServlet()"><!-- --></A><H3>
-getMaxSizeFromServlet</H3>
+<A NAME="getMaxSize()"><!-- --></A><H3>
+getMaxSize</H3>
<PRE>
-protected long <B>getMaxSizeFromServlet</B>()
- throws javax.servlet.ServletException</PRE>
+protected long <B>getMaxSize</B>()
+ throws javax.servlet.ServletException</PRE>
<DL>
<DD>Gets the maximum post data size in bytes from the string
- representation in ActionServlet<DD><DL>
+ representation in the configuration file.
+<P>
+<DD><DL>
</DL>
</DD>
+<DD><DL>
+
+<DD><CODE>javax.servlet.ServletException</CODE></DL>
+</DD>
</DL>
<HR>
@@ -524,7 +673,12 @@
protected void <B>retrieveTempDir</B>()</PRE>
<DL>
<DD>Retrieves the temporary directory from either ActionServlet, a context
- property, or a system property, in that order<DD><DL>
+ property, or a system property, in that order.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
</DL>
</DD>
</DL>
@@ -535,7 +689,7 @@
<A NAME="navbar_bottom"><!-- --></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
-<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
+<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">
@@ -557,21 +711,33 @@
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../org/apache/struts/upload/DiskFile.html"><B>PREV CLASS</B></A>
- <A HREF="../../../../org/apache/struts/upload/MultipartElement.html"><B>NEXT CLASS</B></A></FONT></TD>
+ <A HREF="../../../../org/apache/struts/upload/MultipartBoundaryInputStream.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="DiskMultipartRequestHandler.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
+ <A HREF="DiskMultipartRequestHandler.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: INNER | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
+ SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
-DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
+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
+Copyright � 2000-2002 - Apache Software Foundation
</BODY>
</HTML>
1.2 +119 -54 jakarta-struts/legacy/api-1.0/org/apache/struts/upload/FormFile.html
Index: FormFile.html
===================================================================
RCS file: /home/cvs/jakarta-struts/legacy/api-1.0/org/apache/struts/upload/FormFile.html,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- FormFile.html 17 Sep 2001 20:12:43 -0000 1.1
+++ FormFile.html 21 Apr 2003 03:56:51 -0000 1.2
@@ -1,20 +1,27 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Frameset//EN""http://www.w3.org/TR/REC-html40/frameset.dtd">
+<!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 Fri Jun 15 16:53:36 PDT 2001 -->
+<!-- Generated by javadoc on Sun Apr 20 23:50:13 EDT 2003 -->
<TITLE>
-Apache Struts API Documentation: Interface FormFile
+FormFile (Apache Struts API Documentation)
</TITLE>
+<META NAME="keywords" CONTENT="org.apache.struts.upload.FormFile,FormFile interface">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
</HEAD>
-<BODY BGCOLOR="white">
+<SCRIPT>
+function asd()
+{
+parent.document.title="FormFile (Apache Struts API Documentation)";
+}
+</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=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
+<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">
@@ -39,13 +46,25 @@
<A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.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="FormFile.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
+ <A HREF="FormFile.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: INNER | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
+ SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
-DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
+DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->
@@ -56,7 +75,7 @@
<FONT SIZE="-1">
org.apache.struts.upload</FONT>
<BR>
-Interface FormFile</H2>
+Interface FormFile</H2>
<DL>
<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../org/apache/struts/upload/DiskFile.html">DiskFile</A></DD>
</DL>
@@ -65,12 +84,16 @@
<DT>public interface <B>FormFile</B></DL>
<P>
-This interface is used to define a file uploaded by a client.
+This interface represents a file that has been uploaded by a client. It is
+ the only interface or class in upload package which is typically referenced
+ directly by a Struts application.
+<P>
+
<P>
<HR>
<P>
-<!-- ======== INNER CLASS SUMMARY ======== -->
+<!-- ======== NESTED CLASS SUMMARY ======== -->
<!-- =========== FIELD SUMMARY =========== -->
@@ -93,7 +116,8 @@
<TD><CODE><B><A HREF="../../../../org/apache/struts/upload/FormFile.html#destroy()">destroy</A></B>()</CODE>
<BR>
- Destroy all content for this form file.</TD>
+ Destroys all content for the uploaded file, including any underlying
+ data files.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -101,7 +125,7 @@
<TD><CODE><B><A HREF="../../../../org/apache/struts/upload/FormFile.html#getContentType()">getContentType</A></B>()</CODE>
<BR>
- Get the content type for this file.</TD>
+ Returns the content type for this file.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -109,7 +133,7 @@
<TD><CODE><B><A HREF="../../../../org/apache/struts/upload/FormFile.html#getFileData()">getFileData</A></B>()</CODE>
<BR>
- Get the data in byte array for for this file.</TD>
+ Returns the data for the entire file as byte array.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -117,7 +141,7 @@
<TD><CODE><B><A HREF="../../../../org/apache/struts/upload/FormFile.html#getFileName()">getFileName</A></B>()</CODE>
<BR>
- Get the file name of this file.</TD>
+ Returns the file name of this file.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -125,7 +149,7 @@
<TD><CODE><B><A HREF="../../../../org/apache/struts/upload/FormFile.html#getFileSize()">getFileSize</A></B>()</CODE>
<BR>
- Get the size of this file</TD>
+ Returns the size of this file.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -133,7 +157,7 @@
<TD><CODE><B><A HREF="../../../../org/apache/struts/upload/FormFile.html#getInputStream()">getInputStream</A></B>()</CODE>
<BR>
- Get an InputStream that represents this file.</TD>
+ Returns an input stream for this file.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -141,7 +165,7 @@
<TD><CODE><B><A HREF="../../../../org/apache/struts/upload/FormFile.html#setContentType(java.lang.String)">setContentType</A></B>(java.lang.String contentType)</CODE>
<BR>
- Set the content type for this file</TD>
+ Sets the content type for this file.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -149,15 +173,15 @@
<TD><CODE><B><A HREF="../../../../org/apache/struts/upload/FormFile.html#setFileName(java.lang.String)">setFileName</A></B>(java.lang.String fileName)</CODE>
<BR>
- Set the filename of this file</TD>
+ Sets the file name of this file.</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/upload/FormFile.html#setFileSize(int)">setFileSize</A></B>(int filesize)</CODE>
+<TD><CODE><B><A HREF="../../../../org/apache/struts/upload/FormFile.html#setFileSize(int)">setFileSize</A></B>(int fileSize)</CODE>
<BR>
- Set the file size</TD>
+ Sets the file size.</TD>
</TR>
</TABLE>
@@ -184,8 +208,11 @@
<PRE>
public java.lang.String <B>getContentType</B>()</PRE>
<DL>
-<DD>Get the content type for this file.<DD><DL>
-<DT><B>Returns:</B><DD>A String representing content type</DL>
+<DD>Returns the content type for this file.
+<P>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>A String representing content type.</DL>
</DD>
</DL>
<HR>
@@ -195,8 +222,10 @@
<PRE>
public void <B>setContentType</B>(java.lang.String contentType)</PRE>
<DL>
-<DD>Set the content type for this file<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>contentType</CODE> - The content type</DL>
+<DD>Sets the content type for this file.
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>contentType</CODE> - The content type for the file.</DL>
</DD>
</DL>
<HR>
@@ -206,8 +235,11 @@
<PRE>
public int <B>getFileSize</B>()</PRE>
<DL>
-<DD>Get the size of this file<DD><DL>
-<DT><B>Returns:</B><DD>An int representing the size of the file in bytes</DL>
+<DD>Returns the size of this file.
+<P>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>The size of the file, in bytes.</DL>
</DD>
</DL>
<HR>
@@ -215,10 +247,12 @@
<A NAME="setFileSize(int)"><!-- --></A><H3>
setFileSize</H3>
<PRE>
-public void <B>setFileSize</B>(int filesize)</PRE>
+public void <B>setFileSize</B>(int fileSize)</PRE>
<DL>
-<DD>Set the file size<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>filesize</CODE> - An int reprsenting the size of the file in bytes</DL>
+<DD>Sets the file size.
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>fileSize</CODE> - The size of the file, in bytes,</DL>
</DD>
</DL>
<HR>
@@ -228,8 +262,12 @@
<PRE>
public java.lang.String <B>getFileName</B>()</PRE>
<DL>
-<DD>Get the file name of this file.<DD><DL>
-<DT><B>Returns:</B><DD>A String reprsenting a file name</DL>
+<DD>Returns the file name of this file. This is the base name of the file,
+ as supplied by the user when the file was uploaded.
+<P>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>The base file name.</DL>
</DD>
</DL>
<HR>
@@ -239,8 +277,10 @@
<PRE>
public void <B>setFileName</B>(java.lang.String fileName)</PRE>
<DL>
-<DD>Set the filename of this file<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>fileName</CODE> - The name of the file</DL>
+<DD>Sets the file name of this file.
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>fileName</CODE> - The base file name.</DL>
</DD>
</DL>
<HR>
@@ -252,14 +292,18 @@
throws java.io.FileNotFoundException,
java.io.IOException</PRE>
<DL>
-<DD>Get the data in byte array for for this file. Note that this can be
- a very hazardous method, files can be large enough to cause
- OutOfMemoryErrors. Short of being deprecated, it's strongly recommended
- that you use <A HREF="../../../../org/apache/struts/upload/FormFile.html#getInputStream()"><CODE>getInputStream</CODE></A> to get the file
- data.<DD><DL>
-<DT><B>Returns:</B><DD>An array of bytes representing the data contained
- in the form file<DT><B>Throws:</B><DD><CODE>java.io.FileNotFoundException</CODE> - If some sort of file representation
- cannot be found for the FormFile<DD><CODE>java.io.IOException</CODE> - If there is some sort of IOException</DL>
+<DD>Returns the data for the entire file as byte array. Care is needed when
+ using this method, since a large upload could easily exhaust available
+ memory. The preferred method for accessing the file data is
+ <A HREF="../../../../org/apache/struts/upload/FormFile.html#getInputStream()"><CODE>getInputStream</CODE></A>.
+<P>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>The file data as a byte array.
+<DT><B>Throws:</B>
+<DD><CODE>java.io.FileNotFoundException</CODE> - if the uploaded file is not found.
+<DD><CODE>java.io.IOException</CODE> - if an error occurred while reading the
+ file.</DL>
</DD>
</DL>
<HR>
@@ -271,10 +315,15 @@
throws java.io.FileNotFoundException,
java.io.IOException</PRE>
<DL>
-<DD>Get an InputStream that represents this file. This is the preferred
- method of getting file data.<DD><DL>
-<DT><B>Throws:</B><DD><CODE>java.io.FileNotFoundException</CODE> - If some sort of file representation
- cannot be found for the FormFile<DD><CODE>java.io.IOException</CODE> - If there is some sort of IOException</DL>
+<DD>Returns an input stream for this file. The caller must close the
+ stream when it is no longer needed.
+<P>
+<DD><DL>
+
+<DT><B>Throws:</B>
+<DD><CODE>java.io.FileNotFoundException</CODE> - if the uploaded file is not found.
+<DD><CODE>java.io.IOException</CODE> - if an error occurred while reading the
+ file.</DL>
</DD>
</DL>
<HR>
@@ -284,9 +333,13 @@
<PRE>
public void <B>destroy</B>()</PRE>
<DL>
-<DD>Destroy all content for this form file.
- Implementations should remove any temporary
- files or any temporary file data stored somewhere</DL>
+<DD>Destroys all content for the uploaded file, including any underlying
+ data files.
+<P>
+<DD><DL>
+</DL>
+</DD>
+</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
@@ -294,7 +347,7 @@
<A NAME="navbar_bottom"><!-- --></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
-<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
+<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">
@@ -319,18 +372,30 @@
<A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.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="FormFile.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
+ <A HREF="FormFile.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: INNER | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
+ SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
-DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
+DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->
<HR>
-Copyright � 2000-2001 - Apache Software Foundation
+Copyright � 2000-2002 - Apache Software Foundation
</BODY>
</HTML>
1.2 +66 -19 jakarta-struts/legacy/api-1.0/org/apache/struts/upload/MaxLengthExceededException.html
Index: MaxLengthExceededException.html
===================================================================
RCS file: /home/cvs/jakarta-struts/legacy/api-1.0/org/apache/struts/upload/MaxLengthExceededException.html,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- MaxLengthExceededException.html 17 Sep 2001 20:12:43 -0000 1.1
+++ MaxLengthExceededException.html 21 Apr 2003 03:56:51 -0000 1.2
@@ -1,20 +1,27 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Frameset//EN""http://www.w3.org/TR/REC-html40/frameset.dtd">
+<!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 Fri Jun 15 16:53:37 PDT 2001 -->
+<!-- Generated by javadoc on Sun Apr 20 23:50:14 EDT 2003 -->
<TITLE>
-Apache Struts API Documentation: Class MaxLengthExceededException
+MaxLengthExceededException (Apache Struts API Documentation)
</TITLE>
+<META NAME="keywords" CONTENT="org.apache.struts.upload.MaxLengthExceededException,MaxLengthExceededException class">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
</HEAD>
-<BODY BGCOLOR="white">
+<SCRIPT>
+function asd()
+{
+parent.document.title="MaxLengthExceededException (Apache Struts API Documentation)";
+}
+</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=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
+<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">
@@ -39,13 +46,25 @@
NEXT CLASS</FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html" TARGET="_top"><B>FRAMES</B></A>
- <A HREF="MaxLengthExceededException.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
+ <A HREF="MaxLengthExceededException.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: INNER | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
+ SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
-DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
+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 =========== -->
@@ -56,7 +75,7 @@
<FONT SIZE="-1">
org.apache.struts.upload</FONT>
<BR>
-Class MaxLengthExceededException</H2>
+Class MaxLengthExceededException</H2>
<PRE>
java.lang.Object
|
@@ -79,12 +98,14 @@
This exception is thrown when multipart post data exceeds the maximum
value set
<P>
+
+<P>
<DL>
-<DT><B>See Also: </B><DD><A HREF="../../../../serialized-form.html#org.apache.struts.upload.MaxLengthExceededException">Serialized Form</A></DL>
+<DT><B>See Also:</B><DD><A HREF="../../../../serialized-form.html" TARGET="org.apache.struts.upload.MaxLengthExceededException">Serialized Form</A></DL>
<HR>
<P>
-<!-- ======== INNER CLASS SUMMARY ======== -->
+<!-- ======== NESTED CLASS SUMMARY ======== -->
<!-- =========== FIELD SUMMARY =========== -->
@@ -104,13 +125,22 @@
</TD>
</TR>
</TABLE>
+ <A NAME="fields_inherited_from_class_java.lang.Exception"><!-- --></A>
+<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
+<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
+<TD><B>Fields inherited from class java.lang.Exception</B></TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD><CODE></CODE></TD>
+</TR>
+</TABLE>
<A NAME="fields_inherited_from_class_java.lang.Throwable"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TD><B>Fields inherited from class java.lang.Throwable</B></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
-<TD><CODE>backtrace, detailMessage, serialVersionUID</CODE></TD>
+<TD><CODE></CODE></TD>
</TR>
</TABLE>
@@ -159,7 +189,7 @@
<TD><B>Methods inherited from class java.lang.Throwable</B></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
-<TD><CODE>fillInStackTrace, getLocalizedMessage, printStackTrace, printStackTrace, printStackTrace, printStackTrace0, toString</CODE></TD>
+<TD><CODE>fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</CODE></TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
@@ -168,7 +198,7 @@
<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, wait, wait, wait</CODE></TD>
+<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
@@ -189,6 +219,8 @@
<PRE>
protected java.lang.String <B>message</B></PRE>
<DL>
+<DL>
+</DL>
</DL>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
@@ -234,6 +266,9 @@
<DD><DL>
<DT><B>Overrides:</B><DD><CODE>getMessage</CODE> in class <CODE>java.lang.Throwable</CODE></DL>
</DD>
+<DD><DL>
+</DL>
+</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
@@ -242,7 +277,7 @@
<A NAME="navbar_bottom"><!-- --></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
-<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
+<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">
@@ -267,18 +302,30 @@
NEXT CLASS</FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html" TARGET="_top"><B>FRAMES</B></A>
- <A HREF="MaxLengthExceededException.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
+ <A HREF="MaxLengthExceededException.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: INNER | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
+ SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
-DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
+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
+Copyright � 2000-2002 - Apache Software Foundation
</BODY>
</HTML>
---------------------------------------------------------------------
To unsubscribe, e-mail: struts-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: struts-dev-help@jakarta.apache.org