| <!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 Aug 22 03:43:58 EDT 2003 --> |
| <TITLE> |
| CommonsMultipartRequestHandler.CommonsFormFile (Apache Struts API Documentation) |
| </TITLE> |
| <META NAME="keywords" CONTENT="org.apache.struts.upload.CommonsMultipartRequestHandler.CommonsFormFile,CommonsMultipartRequestHandler.CommonsFormFile class"> |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> |
| </HEAD> |
| <SCRIPT> |
| function asd() |
| { |
| parent.document.title="CommonsMultipartRequestHandler.CommonsFormFile (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=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_top_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3"> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/CommonsMultipartRequestHandler.CommonsFormFile.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../org/apache/struts/upload/CommonsMultipartRequestHandler.html"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/apache/struts/upload/DiskFile.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="CommonsMultipartRequestHandler.CommonsFormFile.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: 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> |
| </TR> |
| </TABLE> |
| <!-- =========== END OF NAVBAR =========== --> |
| |
| <HR> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <H2> |
| <FONT SIZE="-1"> |
| org.apache.struts.upload</FONT> |
| <BR> |
| Class CommonsMultipartRequestHandler.CommonsFormFile</H2> |
| <PRE> |
| java.lang.Object |
| | |
| +--<B>org.apache.struts.upload.CommonsMultipartRequestHandler.CommonsFormFile</B> |
| </PRE> |
| <DL> |
| <DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../org/apache/struts/upload/FormFile.html">FormFile</A></DD> |
| </DL> |
| <DL> |
| <DT><B>Enclosing class:</B><DD><A HREF="../../../../org/apache/struts/upload/CommonsMultipartRequestHandler.html">CommonsMultipartRequestHandler</A></DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT>static class <B>CommonsMultipartRequestHandler.CommonsFormFile</B><DT>extends java.lang.Object<DT>implements <A HREF="../../../../org/apache/struts/upload/FormFile.html">FormFile</A></DL> |
| |
| <P> |
| This class implements the Struts <code>FormFile</code> interface by |
| wrapping the Commons FileUpload <code>FileItem</code> interface. This |
| implementation is <i>read-only</i>; any attempt to modify an instance |
| of this class will result in an <code>UnsupportedOperationException</code>. |
| <P> |
| |
| <P> |
| <HR> |
| |
| <P> |
| <!-- ======== NESTED 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>(package private) org.apache.commons.fileupload.FileItem</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/upload/CommonsMultipartRequestHandler.CommonsFormFile.html#fileItem">fileItem</A></B></CODE> |
| |
| <BR> |
| The <code>FileItem</code> instance wrapped by this object.</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/upload/CommonsMultipartRequestHandler.CommonsFormFile.html#CommonsMultipartRequestHandler.CommonsFormFile(org.apache.commons.fileupload.FileItem)">CommonsMultipartRequestHandler.CommonsFormFile</A></B>(org.apache.commons.fileupload.FileItem fileItem)</CODE> |
| |
| <BR> |
| Constructs an instance of this class which wraps the supplied |
| file item.</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/upload/CommonsMultipartRequestHandler.CommonsFormFile.html#destroy()">destroy</A></B>()</CODE> |
| |
| <BR> |
| Destroy all content for this form file.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/upload/CommonsMultipartRequestHandler.CommonsFormFile.html#getBaseFileName(java.lang.String)">getBaseFileName</A></B>(java.lang.String filePath)</CODE> |
| |
| <BR> |
| Returns the base file name from the supplied file path.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/upload/CommonsMultipartRequestHandler.CommonsFormFile.html#getContentType()">getContentType</A></B>()</CODE> |
| |
| <BR> |
| Returns the content type for this file.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> byte[]</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/upload/CommonsMultipartRequestHandler.CommonsFormFile.html#getFileData()">getFileData</A></B>()</CODE> |
| |
| <BR> |
| Returns the data for this file as a byte array.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/upload/CommonsMultipartRequestHandler.CommonsFormFile.html#getFileName()">getFileName</A></B>()</CODE> |
| |
| <BR> |
| Returns the (client-side) file name for this file.</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/upload/CommonsMultipartRequestHandler.CommonsFormFile.html#getFileSize()">getFileSize</A></B>()</CODE> |
| |
| <BR> |
| Returns the size, in bytes, of this file.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.io.InputStream</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/upload/CommonsMultipartRequestHandler.CommonsFormFile.html#getInputStream()">getInputStream</A></B>()</CODE> |
| |
| <BR> |
| Get an InputStream that represents 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/CommonsMultipartRequestHandler.CommonsFormFile.html#setContentType(java.lang.String)">setContentType</A></B>(java.lang.String contentType)</CODE> |
| |
| <BR> |
| Sets the content type for 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/CommonsMultipartRequestHandler.CommonsFormFile.html#setFileName(java.lang.String)">setFileName</A></B>(java.lang.String fileName)</CODE> |
| |
| <BR> |
| Sets the (client-side) file name for 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/CommonsMultipartRequestHandler.CommonsFormFile.html#setFileSize(int)">setFileSize</A></B>(int filesize)</CODE> |
| |
| <BR> |
| Sets the size, in bytes, for this file.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/upload/CommonsMultipartRequestHandler.CommonsFormFile.html#toString()">toString</A></B>()</CODE> |
| |
| <BR> |
| Returns the (client-side) file name for this file.</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>clone, equals, finalize, getClass, hashCode, notify, notifyAll, 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="fileItem"><!-- --></A><H3> |
| fileItem</H3> |
| <PRE> |
| org.apache.commons.fileupload.FileItem <B>fileItem</B></PRE> |
| <DL> |
| <DD>The <code>FileItem</code> instance wrapped by this object. |
| <P> |
| <DL> |
| </DL> |
| </DL> |
| |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| |
| <A NAME="constructor_detail"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=1><FONT SIZE="+2"> |
| <B>Constructor Detail</B></FONT></TD> |
| </TR> |
| </TABLE> |
| |
| <A NAME="CommonsMultipartRequestHandler.CommonsFormFile(org.apache.commons.fileupload.FileItem)"><!-- --></A><H3> |
| CommonsMultipartRequestHandler.CommonsFormFile</H3> |
| <PRE> |
| public <B>CommonsMultipartRequestHandler.CommonsFormFile</B>(org.apache.commons.fileupload.FileItem fileItem)</PRE> |
| <DL> |
| <DD>Constructs an instance of this class which wraps the supplied |
| file item. |
| <P> |
| <DT><B>Parameters:</B><DD><CODE>fileItem</CODE> - The Commons file item to be wrapped.</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="getContentType()"><!-- --></A><H3> |
| getContentType</H3> |
| <PRE> |
| public java.lang.String <B>getContentType</B>()</PRE> |
| <DL> |
| <DD>Returns the content type for this file. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/struts/upload/FormFile.html#getContentType()">getContentType</A></CODE> in interface <CODE><A HREF="../../../../org/apache/struts/upload/FormFile.html">FormFile</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>A String representing content type.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setContentType(java.lang.String)"><!-- --></A><H3> |
| setContentType</H3> |
| <PRE> |
| public void <B>setContentType</B>(java.lang.String contentType)</PRE> |
| <DL> |
| <DD>Sets the content type for this file. |
| <p> |
| NOTE: This method is not supported in this implementation. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/struts/upload/FormFile.html#setContentType(java.lang.String)">setContentType</A></CODE> in interface <CODE><A HREF="../../../../org/apache/struts/upload/FormFile.html">FormFile</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>contentType</CODE> - A string representing the content type.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getFileSize()"><!-- --></A><H3> |
| getFileSize</H3> |
| <PRE> |
| public int <B>getFileSize</B>()</PRE> |
| <DL> |
| <DD>Returns the size, in bytes, of this file. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/struts/upload/FormFile.html#getFileSize()">getFileSize</A></CODE> in interface <CODE><A HREF="../../../../org/apache/struts/upload/FormFile.html">FormFile</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>The size of the file, in bytes.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setFileSize(int)"><!-- --></A><H3> |
| setFileSize</H3> |
| <PRE> |
| public void <B>setFileSize</B>(int filesize)</PRE> |
| <DL> |
| <DD>Sets the size, in bytes, for this file. |
| <p> |
| NOTE: This method is not supported in this implementation. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/struts/upload/FormFile.html#setFileSize(int)">setFileSize</A></CODE> in interface <CODE><A HREF="../../../../org/apache/struts/upload/FormFile.html">FormFile</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>filesize</CODE> - The size of the file, in bytes.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getFileName()"><!-- --></A><H3> |
| getFileName</H3> |
| <PRE> |
| public java.lang.String <B>getFileName</B>()</PRE> |
| <DL> |
| <DD>Returns the (client-side) file name for this file. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/struts/upload/FormFile.html#getFileName()">getFileName</A></CODE> in interface <CODE><A HREF="../../../../org/apache/struts/upload/FormFile.html">FormFile</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>The client-size file name.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setFileName(java.lang.String)"><!-- --></A><H3> |
| setFileName</H3> |
| <PRE> |
| public void <B>setFileName</B>(java.lang.String fileName)</PRE> |
| <DL> |
| <DD>Sets the (client-side) file name for this file. |
| <p> |
| NOTE: This method is not supported in this implementation. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/struts/upload/FormFile.html#setFileName(java.lang.String)">setFileName</A></CODE> in interface <CODE><A HREF="../../../../org/apache/struts/upload/FormFile.html">FormFile</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>fileName</CODE> - The client-side name for the file.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getFileData()"><!-- --></A><H3> |
| getFileData</H3> |
| <PRE> |
| public byte[] <B>getFileData</B>() |
| throws java.io.FileNotFoundException, |
| java.io.IOException</PRE> |
| <DL> |
| <DD>Returns the data for this file as a byte array. Note that this may |
| result in excessive memory usage for large uploads. The use of the |
| <A HREF="../../../../org/apache/struts/upload/CommonsMultipartRequestHandler.CommonsFormFile.html#getInputStream()"><CODE>getInputStream</CODE></A> method is encouraged |
| as an alternative. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/struts/upload/FormFile.html#getFileData()">getFileData</A></CODE> in interface <CODE><A HREF="../../../../org/apache/struts/upload/FormFile.html">FormFile</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>An array of bytes representing the data contained in this |
| 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> |
| </DL> |
| <HR> |
| |
| <A NAME="getInputStream()"><!-- --></A><H3> |
| getInputStream</H3> |
| <PRE> |
| public java.io.InputStream <B>getInputStream</B>() |
| 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. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/struts/upload/FormFile.html#getInputStream()">getInputStream</A></CODE> in interface <CODE><A HREF="../../../../org/apache/struts/upload/FormFile.html">FormFile</A></CODE></DL> |
| </DD> |
| <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> |
| </DL> |
| <HR> |
| |
| <A NAME="destroy()"><!-- --></A><H3> |
| destroy</H3> |
| <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 |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/struts/upload/FormFile.html#destroy()">destroy</A></CODE> in interface <CODE><A HREF="../../../../org/apache/struts/upload/FormFile.html">FormFile</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getBaseFileName(java.lang.String)"><!-- --></A><H3> |
| getBaseFileName</H3> |
| <PRE> |
| protected java.lang.String <B>getBaseFileName</B>(java.lang.String filePath)</PRE> |
| <DL> |
| <DD>Returns the base file name from the supplied file path. On the surface, |
| this would appear to be a trivial task. Apparently, however, some Linux |
| JDKs do not implement <code>File.getName()</code> correctly for Windows |
| paths, so we attempt to take care of that here. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>filePath</CODE> - The full path to the file. |
| <DT><B>Returns:</B><DD>The base file name, from the end of the path.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="toString()"><!-- --></A><H3> |
| toString</H3> |
| <PRE> |
| public java.lang.String <B>toString</B>()</PRE> |
| <DL> |
| <DD>Returns the (client-side) file name for this file. |
| <P> |
| <DD><DL> |
| <DT><B>Overrides:</B><DD><CODE>toString</CODE> in class <CODE>java.lang.Object</CODE></DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>The client-size file name.</DL> |
| </DD> |
| </DL> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <HR> |
| |
| <!-- ========== START OF NAVBAR ========== --> |
| <A NAME="navbar_bottom"><!-- --></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0"> |
| <TR> |
| <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_bottom_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3"> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/CommonsMultipartRequestHandler.CommonsFormFile.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../org/apache/struts/upload/CommonsMultipartRequestHandler.html"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/apache/struts/upload/DiskFile.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="CommonsMultipartRequestHandler.CommonsFormFile.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: 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> |
| </TR> |
| </TABLE> |
| <!-- =========== END OF NAVBAR =========== --> |
| |
| <HR> |
| Copyright © 2000-2003 - Apache Software Foundation |
| </BODY> |
| </HTML> |
