| <!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> |
| 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> |
| <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=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/FormFile.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"> |
| PREV CLASS |
| <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> |
| |
| <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 | 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> |
| </TR> |
| </TABLE> |
| <!-- =========== END OF NAVBAR =========== --> |
| |
| <HR> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <H2> |
| <FONT SIZE="-1"> |
| org.apache.struts.upload</FONT> |
| <BR> |
| Interface FormFile</H2> |
| <DL> |
| <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../org/apache/struts/upload/CommonsMultipartRequestHandler.CommonsFormFile.html">CommonsMultipartRequestHandler.CommonsFormFile</A>, <A HREF="../../../../org/apache/struts/upload/DiskFile.html">DiskFile</A></DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT>public interface <B>FormFile</B></DL> |
| |
| <P> |
| 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> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| |
| |
| <!-- =========== FIELD SUMMARY =========== --> |
| |
| |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| |
| |
| <!-- ========== 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/FormFile.html#destroy()">destroy</A></B>()</CODE> |
| |
| <BR> |
| 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"> |
| <CODE> java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/upload/FormFile.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/FormFile.html#getFileData()">getFileData</A></B>()</CODE> |
| |
| <BR> |
| 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"> |
| <CODE> java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/upload/FormFile.html#getFileName()">getFileName</A></B>()</CODE> |
| |
| <BR> |
| Returns the file name of 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/FormFile.html#getFileSize()">getFileSize</A></B>()</CODE> |
| |
| <BR> |
| Returns the size 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/FormFile.html#getInputStream()">getInputStream</A></B>()</CODE> |
| |
| <BR> |
| Returns an input stream 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/FormFile.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/FormFile.html#setFileName(java.lang.String)">setFileName</A></B>(java.lang.String fileName)</CODE> |
| |
| <BR> |
| 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> |
| |
| <BR> |
| Sets the file size.</TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| |
| <!-- ============ FIELD DETAIL =========== --> |
| |
| |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| |
| |
| <!-- ============ 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>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> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>contentType</CODE> - The content type for the file.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getFileSize()"><!-- --></A><H3> |
| getFileSize</H3> |
| <PRE> |
| public int <B>getFileSize</B>()</PRE> |
| <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> |
| |
| <A NAME="setFileSize(int)"><!-- --></A><H3> |
| setFileSize</H3> |
| <PRE> |
| public void <B>setFileSize</B>(int fileSize)</PRE> |
| <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> |
| |
| <A NAME="getFileName()"><!-- --></A><H3> |
| getFileName</H3> |
| <PRE> |
| public java.lang.String <B>getFileName</B>()</PRE> |
| <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> |
| |
| <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 file name of this file. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>fileName</CODE> - The base file name.</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 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> |
| |
| <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>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> |
| |
| <A NAME="destroy()"><!-- --></A><H3> |
| destroy</H3> |
| <PRE> |
| public void <B>destroy</B>()</PRE> |
| <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> |
| |
| <!-- ========== 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/FormFile.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"> |
| PREV CLASS |
| <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> |
| |
| <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 | 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> |
| </TR> |
| </TABLE> |
| <!-- =========== END OF NAVBAR =========== --> |
| |
| <HR> |
| Copyright © 2000-2003 - Apache Software Foundation |
| </BODY> |
| </HTML> |
