📄 fileitem.html
字号:
<!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 Dec 06 19:57:10 CET 2002 --><TITLE>jakarta-turbine-2 2.2 API: Class FileItem</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="class-use/FileItem.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/turbine/util/upload/FileHandler.html"><B>PREV CLASS</B></A> <A HREF="../../../../../org/apache/turbine/util/upload/MultipartStream.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="FileItem.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.turbine.util.upload</FONT><BR>Class FileItem</H2><PRE>java.lang.Object | +--<B>org.apache.turbine.util.upload.FileItem</B></PRE><DL><DT><B>All Implemented Interfaces:</B> <DD>javax.activation.DataSource</DD></DL><HR><DL><DT>public class <B>FileItem</B><DT>extends java.lang.Object<DT>implements javax.activation.DataSource</DL><P><p> This class represents a file that was received by Turbine using <code>multipart/form-data</code> POST request. <p> After retrieving an instance of this class from the <A HREF="../../../../../org/apache/turbine/util/ParameterParser.html"><CODE>ParameterParser</CODE></A> (see <A HREF="../../../../../org/apache/turbine/util/ParameterParser.html#getFileItem(java.lang.String)"><CODE>ParameterParser.getFileItem(String)</CODE></A> and <A HREF="../../../../../org/apache/turbine/util/ParameterParser.html#getFileItems(java.lang.String)"><CODE>ParameterParser.getFileItems(String)</CODE></A>) you can use it to acces the data that was sent by the browser. You may either request all contents of file at once using <A HREF="../../../../../org/apache/turbine/util/upload/FileItem.html#get()"><CODE>get()</CODE></A> or request an <CODE>InputStream</CODE> with <A HREF="../../../../../org/apache/turbine/util/upload/FileItem.html#getStream()"><CODE>getStream()</CODE></A> and process the file without attempting to load it into memory, which may come handy with large files. Implements the javax.activation.DataSource interface (which allows for example the adding of a FileItem as an attachment to a multipart email).<P><DL><DT><B>Version: </B><DD>$Id: FileItem.java,v 1.6 2002/07/11 16:53:19 mpoeschl Exp $</DD><DT><B>Author: </B><DD><a href="mailto:Rafal.Krzewski@e-point.pl">Rafal Krzewski</a>, <a href="mailto:sean@informage.net">Sean Legassick</a>, <a href="mailto:jvanzyl@apache.org">Jason van Zyl</a></DD></DL><HR><P><!-- ======== INNER CLASS SUMMARY ======== --><!-- =========== FIELD SUMMARY =========== --><A NAME="field_summary"><!-- --></A><TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"><TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"><TD COLSPAN=2><FONT SIZE="+2"><B>Field Summary</B></FONT></TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>protected java.io.ByteArrayOutputStream</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../org/apache/turbine/util/upload/FileItem.html#byteStream">byteStream</A></B></CODE><BR> Temporary storage for in-memory files.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>protected byte[]</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../org/apache/turbine/util/upload/FileItem.html#content">content</A></B></CODE><BR> Cached contents of the 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/turbine/util/upload/FileItem.html#contentType">contentType</A></B></CODE><BR> The content type passed by the browser or <code>null</code> if not defined.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>static int</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../org/apache/turbine/util/upload/FileItem.html#DEFAULT_UPLOAD_SIZE_THRESHOLD">DEFAULT_UPLOAD_SIZE_THRESHOLD</A></B></CODE><BR> The maximal size of request that will have it's elements stored in memory.</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/turbine/util/upload/FileItem.html#fileName">fileName</A></B></CODE><BR> The original filename in the user's filesystem.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>protected java.io.File</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../org/apache/turbine/util/upload/FileItem.html#storeLocation">storeLocation</A></B></CODE><BR> Temporary storage location.</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 ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>protected </CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../org/apache/turbine/util/upload/FileItem.html#FileItem(java.lang.String, java.lang.String)">FileItem</A></B>(java.lang.String fileName, java.lang.String contentType)</CODE><BR> Constructs a new <code>FileItem</code>.</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>protected void</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../org/apache/turbine/util/upload/FileItem.html#finalize()">finalize</A></B>()</CODE><BR> Removes the file contents from the temporary storage.</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/turbine/util/upload/FileItem.html#get()">get</A></B>()</CODE><BR> Returns the contents of the file as an array of bytes.</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/turbine/util/upload/FileItem.html#getContentType()">getContentType</A></B>()</CODE><BR> Returns the content type passed by the browser or <code>null</code> if not defined.</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/turbine/util/upload/FileItem.html#getFileName()">getFileName</A></B>()</CODE><BR> Returns the original filename in the user's filesystem.</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/turbine/util/upload/FileItem.html#getInputStream()">getInputStream</A></B>()</CODE><BR> Returns an <CODE>InputStream</CODE> that can be used to retrieve the contents of the 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/turbine/util/upload/FileItem.html#getName()">getName</A></B>()</CODE><BR> Returns the original filename in the user's filesystem.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> java.io.OutputStream</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../org/apache/turbine/util/upload/FileItem.html#getOutputStream()">getOutputStream</A></B>()</CODE><BR> Returns an <CODE>OutputStream</CODE> that can be used for storing the contents of the file.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> long</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../org/apache/turbine/util/upload/FileItem.html#getSize()">getSize</A></B>()</CODE><BR> Returns the size of the file.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> java.io.File</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../org/apache/turbine/util/upload/FileItem.html#getStoreLocation()">getStoreLocation</A></B>()</CODE><BR> Returns the <CODE>File</CODE> objects for the FileItems's data temporary location on the disk.</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/turbine/util/upload/FileItem.html#getStream()">getStream</A></B>()</CODE><BR> Returns an <CODE>InputStream</CODE> that can be used to retrieve the contents of the 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/turbine/util/upload/FileItem.html#getString()">getString</A></B>()</CODE><BR> Returns the contents of the file as a String, using default encoding.</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/turbine/util/upload/FileItem.html#getString(java.lang.String)">getString</A></B>(java.lang.String encoding)</CODE><BR> Returns the contents of the file as a String, using specified encoding.</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/turbine/util/upload/FileItem.html#inMemory()">inMemory</A></B>()</CODE><BR> Provides a hint if the file contents will be read from memory.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>static <A HREF="../../../../../org/apache/turbine/util/upload/FileItem.html">FileItem</A></CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../org/apache/turbine/util/upload/FileItem.html#newInstance(java.lang.String, java.lang.String, java.lang.String, int)">newInstance</A></B>(java.lang.String path, java.lang.String name, java.lang.String contentType, int requestSize)</CODE><BR> Instantiates a FileItem.</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/turbine/util/upload/FileItem.html#write(java.lang.String)">write</A></B>(java.lang.String file)</CODE><BR> A convenience method to write an uploaded file to disk.</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, getClass, hashCode, notify, notifyAll, 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="DEFAULT_UPLOAD_SIZE_THRESHOLD"><!-- --></A><H3>DEFAULT_UPLOAD_SIZE_THRESHOLD</H3><PRE>public static final int <B>DEFAULT_UPLOAD_SIZE_THRESHOLD</B></PRE><DL><DD>The maximal size of request that will have it's elements stored in memory.</DL><HR><A NAME="fileName"><!-- --></A><H3>fileName</H3><PRE>protected java.lang.String <B>fileName</B></PRE><DL><DD>The original filename in the user's filesystem.</DL><HR><A NAME="contentType"><!-- --></A><H3>contentType</H3><PRE>protected java.lang.String <B>contentType</B></PRE><DL><DD>The content type passed by the browser or <code>null</code> if⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -