📄 limitedinputstream.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>LimitedInputStream xref</title><link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" /></head><body><div id="overview"><a href="../../../../../../apidocs/org/apache/commons/fileupload/util/LimitedInputStream.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"> * Licensed to the Apache Software Foundation (ASF) under one or more</em><a name="3" href="#3">3</a> <em class="comment"> * contributor license agreements. See the NOTICE file distributed with</em><a name="4" href="#4">4</a> <em class="comment"> * this work for additional information regarding copyright ownership.</em><a name="5" href="#5">5</a> <em class="comment"> * The ASF licenses this file to You under the Apache License, Version 2.0</em><a name="6" href="#6">6</a> <em class="comment"> * (the "License"); you may not use this file except in compliance with</em><a name="7" href="#7">7</a> <em class="comment"> * the License. You may obtain a copy of the License at</em><a name="8" href="#8">8</a> <em class="comment"> *</em><a name="9" href="#9">9</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="10" href="#10">10</a> <em class="comment"> *</em><a name="11" href="#11">11</a> <em class="comment"> * Unless required by applicable law or agreed to in writing, software</em><a name="12" href="#12">12</a> <em class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em><a name="13" href="#13">13</a> <em class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em><a name="14" href="#14">14</a> <em class="comment"> * See the License for the specific language governing permissions and</em><a name="15" href="#15">15</a> <em class="comment"> * limitations under the License.</em><a name="16" href="#16">16</a> <em class="comment"> */</em><a name="17" href="#17">17</a> <strong>package</strong> org.apache.commons.fileupload.util;<a name="18" href="#18">18</a> <a name="19" href="#19">19</a> <strong>import</strong> java.io.FilterInputStream;<a name="20" href="#20">20</a> <strong>import</strong> java.io.IOException;<a name="21" href="#21">21</a> <strong>import</strong> java.io.InputStream;<a name="22" href="#22">22</a> <a name="23" href="#23">23</a> <a name="24" href="#24">24</a> <em>/**</em><a name="25" href="#25">25</a> <em> * An input stream, which limits its data size. This stream is</em><a name="26" href="#26">26</a> <em> * used, if the content length is unknown.</em><a name="27" href="#27">27</a> <em> */</em><a name="28" href="#28">28</a> <strong>public</strong> <strong>abstract</strong> <strong>class</strong> <a href="../../../../../org/apache/commons/fileupload/util/LimitedInputStream.html">LimitedInputStream</a><a name="29" href="#29">29</a> <strong>extends</strong> FilterInputStream implements <a href="../../../../../org/apache/commons/fileupload/util/Closeable.html">Closeable</a> {<a name="30" href="#30">30</a> <em>/**</em><a name="31" href="#31">31</a> <em> * The maximum size of an item, in bytes.</em><a name="32" href="#32">32</a> <em> */</em><a name="33" href="#33">33</a> <strong>private</strong> <strong>long</strong> sizeMax;<a name="34" href="#34">34</a> <em>/**</em><a name="35" href="#35">35</a> <em> * The current number of bytes.</em><a name="36" href="#36">36</a> <em> */</em><a name="37" href="#37">37</a> <strong>private</strong> <strong>long</strong> count;<a name="38" href="#38">38</a> <em>/**</em><a name="39" href="#39">39</a> <em> * Whether this stream is already closed.</em><a name="40" href="#40">40</a> <em> */</em><a name="41" href="#41">41</a> <strong>private</strong> <strong>boolean</strong> closed;<a name="42" href="#42">42</a> <a name="43" href="#43">43</a> <em>/**</em><a name="44" href="#44">44</a> <em> * Creates a new instance.</em><a name="45" href="#45">45</a> <em> * @param pIn The input stream, which shall be limited.</em><a name="46" href="#46">46</a> <em> * @param pSizeMax The limit; no more than this number of bytes</em><a name="47" href="#47">47</a> <em> * shall be returned by the source stream.</em><a name="48" href="#48">48</a> <em> */</em><a name="49" href="#49">49</a> <strong>public</strong> <a href="../../../../../org/apache/commons/fileupload/util/LimitedInputStream.html">LimitedInputStream</a>(InputStream pIn, <strong>long</strong> pSizeMax) {<a name="50" href="#50">50</a> <strong>super</strong>(pIn);<a name="51" href="#51">51</a> sizeMax = pSizeMax;<a name="52" href="#52">52</a> }<a name="53" href="#53">53</a> <a name="54" href="#54">54</a> <em>/**</em><a name="55" href="#55">55</a> <em> * Called to indicate, that the input streams limit has</em><a name="56" href="#56">56</a> <em> * been exceeded.</em><a name="57" href="#57">57</a> <em> * @param pSizeMax The input streams limit, in bytes.</em><a name="58" href="#58">58</a> <em> * @param pCount The actual number of bytes.</em><a name="59" href="#59">59</a> <em> * @throws IOException The called method is expected</em><a name="60" href="#60">60</a> <em> * to raise an IOException.</em><a name="61" href="#61">61</a> <em> */</em><a name="62" href="#62">62</a> <strong>protected</strong> <strong>abstract</strong> <strong>void</strong> raiseError(<strong>long</strong> pSizeMax, <strong>long</strong> pCount)<a name="63" href="#63">63</a> throws IOException;<a name="64" href="#64">64</a> <a name="65" href="#65">65</a> <em>/**</em><em> Called to check, whether the input streams</em><a name="66" href="#66">66</a> <em> * limit is reached.</em><a name="67" href="#67">67</a> <em> * @throws IOException The given limit is exceeded.</em><a name="68" href="#68">68</a> <em> */</em><a name="69" href="#69">69</a> <strong>private</strong> <strong>void</strong> checkLimit() throws IOException {<a name="70" href="#70">70</a> <strong>if</strong> (count > sizeMax) {<a name="71" href="#71">71</a> raiseError(sizeMax, count);<a name="72" href="#72">72</a> }<a name="73" href="#73">73</a> }<a name="74" href="#74">74</a> <a name="75" href="#75">75</a> <em>/**</em><a name="76" href="#76">76</a> <em> * Reads the next byte of data from this input stream. The value</em><a name="77" href="#77">77</a> <em> * byte is returned as an <code>int</code> in the range</em><a name="78" href="#78">78</a> <em> * <code>0</code> to <code>255</code>. If no byte is available</em><a name="79" href="#79">79</a> <em> * because the end of the stream has been reached, the value</em><a name="80" href="#80">80</a> <em> * <code>-1</code> is returned. This method blocks until input data</em><a name="81" href="#81">81</a> <em> * is available, the end of the stream is detected, or an exception</em><a name="82" href="#82">82</a> <em> * is thrown.</em><a name="83" href="#83">83</a> <em> * <p></em><a name="84" href="#84">84</a> <em> * This method</em><a name="85" href="#85">85</a> <em> * simply performs <code>in.read()</code> and returns the result.</em><a name="86" href="#86">86</a> <em> *</em><a name="87" href="#87">87</a> <em> * @return the next byte of data, or <code>-1</code> if the end of the</em><a name="88" href="#88">88</a> <em> * stream is reached.</em><a name="89" href="#89">89</a> <em> * @exception IOException if an I/O error occurs.</em><a name="90" href="#90">90</a> <em> * @see java.io.FilterInputStream#in</em><a name="91" href="#91">91</a> <em> */</em><a name="92" href="#92">92</a> <strong>public</strong> <strong>int</strong> read() throws IOException {<a name="93" href="#93">93</a> <strong>int</strong> res = <strong>super</strong>.read();<a name="94" href="#94">94</a> <strong>if</strong> (res != -1) {<a name="95" href="#95">95</a> count++;<a name="96" href="#96">96</a> checkLimit();<a name="97" href="#97">97</a> }<a name="98" href="#98">98</a> <strong>return</strong> res;<a name="99" href="#99">99</a> }<a name="100" href="#100">100</a> <a name="101" href="#101">101</a> <em>/**</em><a name="102" href="#102">102</a> <em> * Reads up to <code>len</code> bytes of data from this input stream</em><a name="103" href="#103">103</a> <em> * into an array of bytes. If <code>len</code> is not zero, the method</em><a name="104" href="#104">104</a> <em> * blocks until some input is available; otherwise, no</em><a name="105" href="#105">105</a> <em> * bytes are read and <code>0</code> is returned.</em><a name="106" href="#106">106</a> <em> * <p></em><a name="107" href="#107">107</a> <em> * This method simply performs <code>in.read(b, off, len)</code></em><a name="108" href="#108">108</a> <em> * and returns the result.</em><a name="109" href="#109">109</a> <em> *</em><a name="110" href="#110">110</a> <em> * @param b the buffer into which the data is read.</em><a name="111" href="#111">111</a> <em> * @param off The start offset in the destination array</em><a name="112" href="#112">112</a> <em> * <code>b</code>.</em><a name="113" href="#113">113</a> <em> * @param len the maximum number of bytes read.</em><a name="114" href="#114">114</a> <em> * @return the total number of bytes read into the buffer, or</em><a name="115" href="#115">115</a> <em> * <code>-1</code> if there is no more data because the end of</em><a name="116" href="#116">116</a> <em> * the stream has been reached.</em><a name="117" href="#117">117</a> <em> * @exception NullPointerException If <code>b</code> is <code>null</code>.</em><a name="118" href="#118">118</a> <em> * @exception IndexOutOfBoundsException If <code>off</code> is negative,</em><a name="119" href="#119">119</a> <em> * <code>len</code> is negative, or <code>len</code> is greater than</em><a name="120" href="#120">120</a> <em> * <code>b.length - off</code></em><a name="121" href="#121">121</a> <em> * @exception IOException if an I/O error occurs.</em><a name="122" href="#122">122</a> <em> * @see java.io.FilterInputStream#in</em><a name="123" href="#123">123</a> <em> */</em><a name="124" href="#124">124</a> <strong>public</strong> <strong>int</strong> read(byte[] b, <strong>int</strong> off, <strong>int</strong> len) throws IOException {<a name="125" href="#125">125</a> <strong>int</strong> res = <strong>super</strong>.read(b, off, len);<a name="126" href="#126">126</a> <strong>if</strong> (res > 0) {<a name="127" href="#127">127</a> count += res;<a name="128" href="#128">128</a> checkLimit();<a name="129" href="#129">129</a> }<a name="130" href="#130">130</a> <strong>return</strong> res;<a name="131" href="#131">131</a> }<a name="132" href="#132">132</a> <a name="133" href="#133">133</a> <em>/**</em><a name="134" href="#134">134</a> <em> * Returns, whether this stream is already closed.</em><a name="135" href="#135">135</a> <em> * @return True, if the stream is closed, otherwise false.</em><a name="136" href="#136">136</a> <em> * @throws IOException An I/O error occurred.</em><a name="137" href="#137">137</a> <em> */</em><a name="138" href="#138">138</a> <strong>public</strong> <strong>boolean</strong> isClosed() throws IOException {<a name="139" href="#139">139</a> <strong>return</strong> closed;<a name="140" href="#140">140</a> }<a name="141" href="#141">141</a> <a name="142" href="#142">142</a> <em>/**</em><a name="143" href="#143">143</a> <em> * Closes this input stream and releases any system resources</em><a name="144" href="#144">144</a> <em> * associated with the stream.</em><a name="145" href="#145">145</a> <em> * This</em><a name="146" href="#146">146</a> <em> * method simply performs <code>in.close()</code>.</em><a name="147" href="#147">147</a> <em> *</em><a name="148" href="#148">148</a> <em> * @exception IOException if an I/O error occurs.</em><a name="149" href="#149">149</a> <em> * @see java.io.FilterInputStream#in</em><a name="150" href="#150">150</a> <em> */</em><a name="151" href="#151">151</a> <strong>public</strong> <strong>void</strong> close() throws IOException {<a name="152" href="#152">152</a> closed = <strong>true</strong>;<a name="153" href="#153">153</a> <strong>super</strong>.close();<a name="154" href="#154">154</a> }<a name="155" href="#155">155</a> }</pre><hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body></html>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -