📄 fileitem.html
字号:
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"><head><meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /><title>FileItem xref</title><link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" /></head><body><div id="overview"><a href="../../../../../apidocs/org/apache/commons/fileupload/FileItem.html">View Javadoc</a></div><pre><a name="1" href="#1">1</a> <em class="comment">/*</em><a name="2" href="#2">2</a> <em class="comment"> * Copyright 2001-2005 The Apache Software Foundation</em><a name="3" href="#3">3</a> <em class="comment"> *</em><a name="4" href="#4">4</a> <em class="comment"> * Licensed under the Apache License, Version 2.0 (the "License");</em><a name="5" href="#5">5</a> <em class="comment"> * you may not use this file except in compliance with the License.</em><a name="6" href="#6">6</a> <em class="comment"> * You may obtain a copy of the License at</em><a name="7" href="#7">7</a> <em class="comment"> *</em><a name="8" href="#8">8</a> <em class="comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em><a name="9" href="#9">9</a> <em class="comment"> *</em><a name="10" href="#10">10</a> <em class="comment"> * Unless required by applicable law or agreed to in writing, software</em><a name="11" href="#11">11</a> <em class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em><a name="12" href="#12">12</a> <em class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em><a name="13" href="#13">13</a> <em class="comment"> * See the License for the specific language governing permissions and</em><a name="14" href="#14">14</a> <em class="comment"> * limitations under the License.</em><a name="15" href="#15">15</a> <em class="comment"> */</em><a name="16" href="#16">16</a> <strong>package</strong> <a href="../../../../org/apache/commons/fileupload/package-summary.html">org.apache.commons.fileupload</a>;<a name="17" href="#17">17</a> <a name="18" href="#18">18</a> <strong>import</strong> java.io.File;<a name="19" href="#19">19</a> <strong>import</strong> java.io.IOException;<a name="20" href="#20">20</a> <strong>import</strong> java.io.InputStream;<a name="21" href="#21">21</a> <strong>import</strong> java.io.OutputStream;<a name="22" href="#22">22</a> <strong>import</strong> java.io.Serializable;<a name="23" href="#23">23</a> <strong>import</strong> java.io.UnsupportedEncodingException;<a name="24" href="#24">24</a> <a name="25" href="#25">25</a> <em>/**<em>*</em></em><a name="26" href="#26">26</a> <em> * <p> This class represents a file or form item that was received within a</em><a name="27" href="#27">27</a> <em> * <code>multipart/form-data</code> POST request.</em><a name="28" href="#28">28</a> <em> *</em><a name="29" href="#29">29</a> <em> * <p> After retrieving an instance of this class from a {@link</em><a name="30" href="#30">30</a> <em> * org.apache.commons.fileupload.FileUpload FileUpload} instance (see</em><a name="31" href="#31">31</a> <em> * {@link org.apache.commons.fileupload.FileUpload</em><a name="32" href="#32">32</a> <em> * #parseRequest(javax.servlet.http.HttpServletRequest)}), you may</em><a name="33" href="#33">33</a> <em> * either request all contents of the file at once using {@link #get()} or</em><a name="34" href="#34">34</a> <em> * request an {@link java.io.InputStream InputStream} with</em><a name="35" href="#35">35</a> <em> * {@link #getInputStream()} and process the file without attempting to load</em><a name="36" href="#36">36</a> <em> * it into memory, which may come handy with large files.</em><a name="37" href="#37">37</a> <em> *</em><a name="38" href="#38">38</a> <em> * <p> While this interface does not extend</em><a name="39" href="#39">39</a> <em> * <code>javax.activation.DataSource</code> per se (to avoid a seldom used</em><a name="40" href="#40">40</a> <em> * dependency), several of the defined methods are specifically defined with</em><a name="41" href="#41">41</a> <em> * the same signatures as methods in that interface. This allows an</em><a name="42" href="#42">42</a> <em> * implementation of this interface to also implement</em><a name="43" href="#43">43</a> <em> * <code>javax.activation.DataSource</code> with minimal additional work.</em><a name="44" href="#44">44</a> <em> *</em><a name="45" href="#45">45</a> <em> * @author <a href="<a href="mailto:Rafal.Krzewski@e-point.pl" target="alexandria_uri">mailto:Rafal.Krzewski@e-point.pl</a>">Rafal Krzewski</a></em><a name="46" href="#46">46</a> <em> * @author <a href="<a href="mailto:sean@informage.net" target="alexandria_uri">mailto:sean@informage.net</a>">Sean Legassick</a></em><a name="47" href="#47">47</a> <em> * @author <a href="<a href="mailto:jvanzyl@apache.org" target="alexandria_uri">mailto:jvanzyl@apache.org</a>">Jason van Zyl</a></em><a name="48" href="#48">48</a> <em> * @author <a href="<a href="mailto:martinc@apache.org" target="alexandria_uri">mailto:martinc@apache.org</a>">Martin Cooper</a></em><a name="49" href="#49">49</a> <em> *</em><a name="50" href="#50">50</a> <em> * @version $Id: FileItem.java 349366 2005-11-28 04:44:57Z martinc $</em><a name="51" href="#51">51</a> <em> */</em><a name="52" href="#52">52</a> <strong>public</strong> <strong>interface</strong> <a href="../../../../org/apache/commons/fileupload/FileItem.html">FileItem</a><a name="53" href="#53">53</a> <strong>extends</strong> Serializable {<a name="54" href="#54">54</a> <a name="55" href="#55">55</a> <a name="56" href="#56">56</a> <em class="comment">// ------------------------------- Methods from javax.activation.DataSource</em><a name="57" href="#57">57</a> <a name="58" href="#58">58</a> <a name="59" href="#59">59</a> <em>/**<em>*</em></em><a name="60" href="#60">60</a> <em> * Returns an {@link java.io.InputStream InputStream} that can be</em><a name="61" href="#61">61</a> <em> * used to retrieve the contents of the file.</em><a name="62" href="#62">62</a> <em> *</em><a name="63" href="#63">63</a> <em> * @return An {@link java.io.InputStream InputStream} that can be</em><a name="64" href="#64">64</a> <em> * used to retrieve the contents of the file.</em><a name="65" href="#65">65</a> <em> *</em><a name="66" href="#66">66</a> <em> * @throws IOException if an error occurs.</em><a name="67" href="#67">67</a> <em> */</em><a name="68" href="#68">68</a> InputStream getInputStream()<a name="69" href="#69">69</a> throws IOException;<a name="70" href="#70">70</a> <a name="71" href="#71">71</a> <a name="72" href="#72">72</a> <em>/**<em>*</em></em><a name="73" href="#73">73</a> <em> * Returns the content type passed by the browser or <code>null</code> if</em><a name="74" href="#74">74</a> <em> * not defined.</em><a name="75" href="#75">75</a> <em> *</em><a name="76" href="#76">76</a> <em> * @return The content type passed by the browser or <code>null</code> if</em><a name="77" href="#77">77</a> <em> * not defined.</em><a name="78" href="#78">78</a> <em> */</em><a name="79" href="#79">79</a> String getContentType();<a name="80" href="#80">80</a> <a name="81" href="#81">81</a> <a name="82" href="#82">82</a> <em>/**<em>*</em></em><a name="83" href="#83">83</a> <em> * Returns the original filename in the client's filesystem, as provided by</em><a name="84" href="#84">84</a> <em> * the browser (or other client software). In most cases, this will be the</em><a name="85" href="#85">85</a> <em> * base file name, without path information. However, some clients, such as</em><a name="86" href="#86">86</a> <em> * the Opera browser, do include path information.</em><a name="87" href="#87">87</a> <em> *</em><a name="88" href="#88">88</a> <em> * @return The original filename in the client's filesystem.</em><a name="89" href="#89">89</a> <em> */</em><a name="90" href="#90">90</a> String getName();<a name="91" href="#91">91</a> <a name="92" href="#92">92</a> <a name="93" href="#93">93</a> <em class="comment">// ------------------------------------------------------- FileItem methods</em><a name="94" href="#94">94</a> <a name="95" href="#95">95</a> <a name="96" href="#96">96</a> <em>/**<em>*</em></em><a name="97" href="#97">97</a> <em> * Provides a hint as to whether or not the file contents will be read</em><a name="98" href="#98">98</a> <em> * from memory.</em><a name="99" href="#99">99</a> <em> *</em><a name="100" href="#100">100</a> <em> * @return <code>true</code> if the file contents will be read from memory;</em><a name="101" href="#101">101</a> <em> * <code>false</code> otherwise.</em><a name="102" href="#102">102</a> <em> */</em><a name="103" href="#103">103</a> <strong>boolean</strong> isInMemory();<a name="104" href="#104">104</a> <a name="105" href="#105">105</a> <a name="106" href="#106">106</a> <em>/**<em>*</em></em><a name="107" href="#107">107</a> <em> * Returns the size of the file item.</em><a name="108" href="#108">108</a> <em> *</em><a name="109" href="#109">109</a> <em> * @return The size of the file item, in bytes.</em><a name="110" href="#110">110</a> <em> */</em><a name="111" href="#111">111</a> <strong>long</strong> getSize();⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -