BoundedInputStream.html 32 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <!-- NewPage -->
  3. <html lang="de">
  4. <head>
  5. <!-- Generated by javadoc -->
  6. <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
  7. <title>BoundedInputStream (Apache Commons IO 2.6 API)</title>
  8. <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
  9. <script type="text/javascript" src="../../../../../script.js"></script>
  10. </head>
  11. <body>
  12. <script type="text/javascript"><!--
  13. try {
  14. if (location.href.indexOf('is-external=true') == -1) {
  15. parent.document.title="BoundedInputStream (Apache Commons IO 2.6 API)";
  16. }
  17. }
  18. catch(err) {
  19. }
  20. //-->
  21. var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10};
  22. var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
  23. var altColor = "altColor";
  24. var rowColor = "rowColor";
  25. var tableTab = "tableTab";
  26. var activeTableTab = "activeTableTab";
  27. </script>
  28. <noscript>
  29. <div>JavaScript is disabled on your browser.</div>
  30. </noscript>
  31. <!-- ========= START OF TOP NAVBAR ======= -->
  32. <div class="topNav"><a name="navbar.top">
  33. <!-- -->
  34. </a>
  35. <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
  36. <a name="navbar.top.firstrow">
  37. <!-- -->
  38. </a>
  39. <ul class="navList" title="Navigation">
  40. <li><a href="../../../../../overview-summary.html">Overview</a></li>
  41. <li><a href="package-summary.html">Package</a></li>
  42. <li class="navBarCell1Rev">Class</li>
  43. <li><a href="class-use/BoundedInputStream.html">Use</a></li>
  44. <li><a href="package-tree.html">Tree</a></li>
  45. <li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
  46. <li><a href="../../../../../index-all.html">Index</a></li>
  47. <li><a href="../../../../../help-doc.html">Help</a></li>
  48. </ul>
  49. </div>
  50. <div class="subNav">
  51. <ul class="navList">
  52. <li><a href="../../../../../org/apache/commons/io/input/BOMInputStream.html" title="class in org.apache.commons.io.input"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  53. <li><a href="../../../../../org/apache/commons/io/input/BoundedReader.html" title="class in org.apache.commons.io.input"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  54. </ul>
  55. <ul class="navList">
  56. <li><a href="../../../../../index.html?org/apache/commons/io/input/BoundedInputStream.html" target="_top">Frames</a></li>
  57. <li><a href="BoundedInputStream.html" target="_top">No&nbsp;Frames</a></li>
  58. </ul>
  59. <ul class="navList" id="allclasses_navbar_top">
  60. <li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  61. </ul>
  62. <div>
  63. <script type="text/javascript"><!--
  64. allClassesLink = document.getElementById("allclasses_navbar_top");
  65. if(window==top) {
  66. allClassesLink.style.display = "block";
  67. }
  68. else {
  69. allClassesLink.style.display = "none";
  70. }
  71. //-->
  72. </script>
  73. </div>
  74. <div>
  75. <ul class="subNavList">
  76. <li>Summary:&nbsp;</li>
  77. <li>Nested&nbsp;|&nbsp;</li>
  78. <li>Field&nbsp;|&nbsp;</li>
  79. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  80. <li><a href="#method.summary">Method</a></li>
  81. </ul>
  82. <ul class="subNavList">
  83. <li>Detail:&nbsp;</li>
  84. <li>Field&nbsp;|&nbsp;</li>
  85. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  86. <li><a href="#method.detail">Method</a></li>
  87. </ul>
  88. </div>
  89. <a name="skip.navbar.top">
  90. <!-- -->
  91. </a></div>
  92. <!-- ========= END OF TOP NAVBAR ========= -->
  93. <!-- ======== START OF CLASS DATA ======== -->
  94. <div class="header">
  95. <div class="subTitle">org.apache.commons.io.input</div>
  96. <h2 title="Class BoundedInputStream" class="title">Class BoundedInputStream</h2>
  97. </div>
  98. <div class="contentContainer">
  99. <ul class="inheritance">
  100. <li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
  101. <li>
  102. <ul class="inheritance">
  103. <li><a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">java.io.InputStream</a></li>
  104. <li>
  105. <ul class="inheritance">
  106. <li>org.apache.commons.io.input.BoundedInputStream</li>
  107. </ul>
  108. </li>
  109. </ul>
  110. </li>
  111. </ul>
  112. <div class="description">
  113. <ul class="blockList">
  114. <li class="blockList">
  115. <dl>
  116. <dt>All Implemented Interfaces:</dt>
  117. <dd><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></dd>
  118. </dl>
  119. <hr>
  120. <br>
  121. <pre>public class <span class="typeNameLabel">BoundedInputStream</span>
  122. extends <a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a></pre>
  123. <div class="block">This is a stream that will only supply bytes up to a certain length - if its
  124. position goes above that, it will stop.
  125. <p>
  126. This is useful to wrap ServletInputStreams. The ServletInputStream will block
  127. if you try to read content from it that isn't there, because it doesn't know
  128. whether the content hasn't arrived yet or whether the content has finished.
  129. So, one of these, initialized with the Content-length sent in the
  130. ServletInputStream's header, will stop it blocking, providing it's been sent
  131. with a correct content length.</div>
  132. <dl>
  133. <dt><span class="simpleTagLabel">Since:</span></dt>
  134. <dd>2.0</dd>
  135. </dl>
  136. </li>
  137. </ul>
  138. </div>
  139. <div class="summary">
  140. <ul class="blockList">
  141. <li class="blockList">
  142. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  143. <ul class="blockList">
  144. <li class="blockList"><a name="constructor.summary">
  145. <!-- -->
  146. </a>
  147. <h3>Constructor Summary</h3>
  148. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  149. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  150. <tr>
  151. <th class="colOne" scope="col">Constructor and Description</th>
  152. </tr>
  153. <tr class="altColor">
  154. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/input/BoundedInputStream.html#BoundedInputStream-java.io.InputStream-">BoundedInputStream</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a>&nbsp;in)</code>
  155. <div class="block">Creates a new <code>BoundedInputStream</code> that wraps the given input
  156. stream and is unlimited.</div>
  157. </td>
  158. </tr>
  159. <tr class="rowColor">
  160. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/input/BoundedInputStream.html#BoundedInputStream-java.io.InputStream-long-">BoundedInputStream</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a>&nbsp;in,
  161. long&nbsp;size)</code>
  162. <div class="block">Creates a new <code>BoundedInputStream</code> that wraps the given input
  163. stream and limits it to a certain size.</div>
  164. </td>
  165. </tr>
  166. </table>
  167. </li>
  168. </ul>
  169. <!-- ========== METHOD SUMMARY =========== -->
  170. <ul class="blockList">
  171. <li class="blockList"><a name="method.summary">
  172. <!-- -->
  173. </a>
  174. <h3>Method Summary</h3>
  175. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  176. <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
  177. <tr>
  178. <th class="colFirst" scope="col">Modifier and Type</th>
  179. <th class="colLast" scope="col">Method and Description</th>
  180. </tr>
  181. <tr id="i0" class="altColor">
  182. <td class="colFirst"><code>int</code></td>
  183. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/input/BoundedInputStream.html#available--">available</a></span>()</code></td>
  184. </tr>
  185. <tr id="i1" class="rowColor">
  186. <td class="colFirst"><code>void</code></td>
  187. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/input/BoundedInputStream.html#close--">close</a></span>()</code>
  188. <div class="block">Invokes the delegate's <code>close()</code> method
  189. if <a href="../../../../../org/apache/commons/io/input/BoundedInputStream.html#isPropagateClose--"><code>isPropagateClose()</code></a> is <code>true</code>.</div>
  190. </td>
  191. </tr>
  192. <tr id="i2" class="altColor">
  193. <td class="colFirst"><code>boolean</code></td>
  194. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/input/BoundedInputStream.html#isPropagateClose--">isPropagateClose</a></span>()</code>
  195. <div class="block">Indicates whether the <a href="../../../../../org/apache/commons/io/input/BoundedInputStream.html#close--"><code>close()</code></a> method
  196. should propagate to the underling <a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io"><code>InputStream</code></a>.</div>
  197. </td>
  198. </tr>
  199. <tr id="i3" class="rowColor">
  200. <td class="colFirst"><code>void</code></td>
  201. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/input/BoundedInputStream.html#mark-int-">mark</a></span>(int&nbsp;readlimit)</code>
  202. <div class="block">Invokes the delegate's <code>mark(int)</code> method.</div>
  203. </td>
  204. </tr>
  205. <tr id="i4" class="altColor">
  206. <td class="colFirst"><code>boolean</code></td>
  207. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/input/BoundedInputStream.html#markSupported--">markSupported</a></span>()</code>
  208. <div class="block">Invokes the delegate's <code>markSupported()</code> method.</div>
  209. </td>
  210. </tr>
  211. <tr id="i5" class="rowColor">
  212. <td class="colFirst"><code>int</code></td>
  213. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/input/BoundedInputStream.html#read--">read</a></span>()</code>
  214. <div class="block">Invokes the delegate's <code>read()</code> method if
  215. the current position is less than the limit.</div>
  216. </td>
  217. </tr>
  218. <tr id="i6" class="altColor">
  219. <td class="colFirst"><code>int</code></td>
  220. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/input/BoundedInputStream.html#read-byte:A-">read</a></span>(byte[]&nbsp;b)</code>
  221. <div class="block">Invokes the delegate's <code>read(byte[])</code> method.</div>
  222. </td>
  223. </tr>
  224. <tr id="i7" class="rowColor">
  225. <td class="colFirst"><code>int</code></td>
  226. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/input/BoundedInputStream.html#read-byte:A-int-int-">read</a></span>(byte[]&nbsp;b,
  227. int&nbsp;off,
  228. int&nbsp;len)</code>
  229. <div class="block">Invokes the delegate's <code>read(byte[], int, int)</code> method.</div>
  230. </td>
  231. </tr>
  232. <tr id="i8" class="altColor">
  233. <td class="colFirst"><code>void</code></td>
  234. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/input/BoundedInputStream.html#reset--">reset</a></span>()</code>
  235. <div class="block">Invokes the delegate's <code>reset()</code> method.</div>
  236. </td>
  237. </tr>
  238. <tr id="i9" class="rowColor">
  239. <td class="colFirst"><code>void</code></td>
  240. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/input/BoundedInputStream.html#setPropagateClose-boolean-">setPropagateClose</a></span>(boolean&nbsp;propagateClose)</code>
  241. <div class="block">Set whether the <a href="../../../../../org/apache/commons/io/input/BoundedInputStream.html#close--"><code>close()</code></a> method
  242. should propagate to the underling <a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io"><code>InputStream</code></a>.</div>
  243. </td>
  244. </tr>
  245. <tr id="i10" class="altColor">
  246. <td class="colFirst"><code>long</code></td>
  247. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/input/BoundedInputStream.html#skip-long-">skip</a></span>(long&nbsp;n)</code>
  248. <div class="block">Invokes the delegate's <code>skip(long)</code> method.</div>
  249. </td>
  250. </tr>
  251. <tr id="i11" class="rowColor">
  252. <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
  253. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/input/BoundedInputStream.html#toString--">toString</a></span>()</code>
  254. <div class="block">Invokes the delegate's <code>toString()</code> method.</div>
  255. </td>
  256. </tr>
  257. </table>
  258. <ul class="blockList">
  259. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  260. <!-- -->
  261. </a>
  262. <h3>Methods inherited from class&nbsp;java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
  263. <code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
  264. </ul>
  265. </li>
  266. </ul>
  267. </li>
  268. </ul>
  269. </div>
  270. <div class="details">
  271. <ul class="blockList">
  272. <li class="blockList">
  273. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  274. <ul class="blockList">
  275. <li class="blockList"><a name="constructor.detail">
  276. <!-- -->
  277. </a>
  278. <h3>Constructor Detail</h3>
  279. <a name="BoundedInputStream-java.io.InputStream-long-">
  280. <!-- -->
  281. </a>
  282. <ul class="blockList">
  283. <li class="blockList">
  284. <h4>BoundedInputStream</h4>
  285. <pre>public&nbsp;BoundedInputStream(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a>&nbsp;in,
  286. long&nbsp;size)</pre>
  287. <div class="block">Creates a new <code>BoundedInputStream</code> that wraps the given input
  288. stream and limits it to a certain size.</div>
  289. <dl>
  290. <dt><span class="paramLabel">Parameters:</span></dt>
  291. <dd><code>in</code> - The wrapped input stream</dd>
  292. <dd><code>size</code> - The maximum number of bytes to return</dd>
  293. </dl>
  294. </li>
  295. </ul>
  296. <a name="BoundedInputStream-java.io.InputStream-">
  297. <!-- -->
  298. </a>
  299. <ul class="blockListLast">
  300. <li class="blockList">
  301. <h4>BoundedInputStream</h4>
  302. <pre>public&nbsp;BoundedInputStream(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a>&nbsp;in)</pre>
  303. <div class="block">Creates a new <code>BoundedInputStream</code> that wraps the given input
  304. stream and is unlimited.</div>
  305. <dl>
  306. <dt><span class="paramLabel">Parameters:</span></dt>
  307. <dd><code>in</code> - The wrapped input stream</dd>
  308. </dl>
  309. </li>
  310. </ul>
  311. </li>
  312. </ul>
  313. <!-- ============ METHOD DETAIL ========== -->
  314. <ul class="blockList">
  315. <li class="blockList"><a name="method.detail">
  316. <!-- -->
  317. </a>
  318. <h3>Method Detail</h3>
  319. <a name="read--">
  320. <!-- -->
  321. </a>
  322. <ul class="blockList">
  323. <li class="blockList">
  324. <h4>read</h4>
  325. <pre>public&nbsp;int&nbsp;read()
  326. throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
  327. <div class="block">Invokes the delegate's <code>read()</code> method if
  328. the current position is less than the limit.</div>
  329. <dl>
  330. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  331. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true#read--" title="class or interface in java.io">read</a></code>&nbsp;in class&nbsp;<code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a></code></dd>
  332. <dt><span class="returnLabel">Returns:</span></dt>
  333. <dd>the byte read or -1 if the end of stream or
  334. the limit has been reached.</dd>
  335. <dt><span class="throwsLabel">Throws:</span></dt>
  336. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if an I/O error occurs</dd>
  337. </dl>
  338. </li>
  339. </ul>
  340. <a name="read-byte:A-">
  341. <!-- -->
  342. </a>
  343. <ul class="blockList">
  344. <li class="blockList">
  345. <h4>read</h4>
  346. <pre>public&nbsp;int&nbsp;read(byte[]&nbsp;b)
  347. throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
  348. <div class="block">Invokes the delegate's <code>read(byte[])</code> method.</div>
  349. <dl>
  350. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  351. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true#read-byte:A-" title="class or interface in java.io">read</a></code>&nbsp;in class&nbsp;<code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a></code></dd>
  352. <dt><span class="paramLabel">Parameters:</span></dt>
  353. <dd><code>b</code> - the buffer to read the bytes into</dd>
  354. <dt><span class="returnLabel">Returns:</span></dt>
  355. <dd>the number of bytes read or -1 if the end of stream or
  356. the limit has been reached.</dd>
  357. <dt><span class="throwsLabel">Throws:</span></dt>
  358. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if an I/O error occurs</dd>
  359. </dl>
  360. </li>
  361. </ul>
  362. <a name="read-byte:A-int-int-">
  363. <!-- -->
  364. </a>
  365. <ul class="blockList">
  366. <li class="blockList">
  367. <h4>read</h4>
  368. <pre>public&nbsp;int&nbsp;read(byte[]&nbsp;b,
  369. int&nbsp;off,
  370. int&nbsp;len)
  371. throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
  372. <div class="block">Invokes the delegate's <code>read(byte[], int, int)</code> method.</div>
  373. <dl>
  374. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  375. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true#read-byte:A-int-int-" title="class or interface in java.io">read</a></code>&nbsp;in class&nbsp;<code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a></code></dd>
  376. <dt><span class="paramLabel">Parameters:</span></dt>
  377. <dd><code>b</code> - the buffer to read the bytes into</dd>
  378. <dd><code>off</code> - The start offset</dd>
  379. <dd><code>len</code> - The number of bytes to read</dd>
  380. <dt><span class="returnLabel">Returns:</span></dt>
  381. <dd>the number of bytes read or -1 if the end of stream or
  382. the limit has been reached.</dd>
  383. <dt><span class="throwsLabel">Throws:</span></dt>
  384. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if an I/O error occurs</dd>
  385. </dl>
  386. </li>
  387. </ul>
  388. <a name="skip-long-">
  389. <!-- -->
  390. </a>
  391. <ul class="blockList">
  392. <li class="blockList">
  393. <h4>skip</h4>
  394. <pre>public&nbsp;long&nbsp;skip(long&nbsp;n)
  395. throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
  396. <div class="block">Invokes the delegate's <code>skip(long)</code> method.</div>
  397. <dl>
  398. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  399. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true#skip-long-" title="class or interface in java.io">skip</a></code>&nbsp;in class&nbsp;<code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a></code></dd>
  400. <dt><span class="paramLabel">Parameters:</span></dt>
  401. <dd><code>n</code> - the number of bytes to skip</dd>
  402. <dt><span class="returnLabel">Returns:</span></dt>
  403. <dd>the actual number of bytes skipped</dd>
  404. <dt><span class="throwsLabel">Throws:</span></dt>
  405. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if an I/O error occurs</dd>
  406. </dl>
  407. </li>
  408. </ul>
  409. <a name="available--">
  410. <!-- -->
  411. </a>
  412. <ul class="blockList">
  413. <li class="blockList">
  414. <h4>available</h4>
  415. <pre>public&nbsp;int&nbsp;available()
  416. throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
  417. <dl>
  418. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  419. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true#available--" title="class or interface in java.io">available</a></code>&nbsp;in class&nbsp;<code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a></code></dd>
  420. <dt><span class="throwsLabel">Throws:</span></dt>
  421. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
  422. </dl>
  423. </li>
  424. </ul>
  425. <a name="toString--">
  426. <!-- -->
  427. </a>
  428. <ul class="blockList">
  429. <li class="blockList">
  430. <h4>toString</h4>
  431. <pre>public&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;toString()</pre>
  432. <div class="block">Invokes the delegate's <code>toString()</code> method.</div>
  433. <dl>
  434. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  435. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a></code>&nbsp;in class&nbsp;<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd>
  436. <dt><span class="returnLabel">Returns:</span></dt>
  437. <dd>the delegate's <code>toString()</code></dd>
  438. </dl>
  439. </li>
  440. </ul>
  441. <a name="close--">
  442. <!-- -->
  443. </a>
  444. <ul class="blockList">
  445. <li class="blockList">
  446. <h4>close</h4>
  447. <pre>public&nbsp;void&nbsp;close()
  448. throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
  449. <div class="block">Invokes the delegate's <code>close()</code> method
  450. if <a href="../../../../../org/apache/commons/io/input/BoundedInputStream.html#isPropagateClose--"><code>isPropagateClose()</code></a> is <code>true</code>.</div>
  451. <dl>
  452. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  453. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Closeable.html?is-external=true#close--" title="class or interface in java.io">close</a></code>&nbsp;in interface&nbsp;<code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</a></code></dd>
  454. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  455. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/AutoCloseable.html?is-external=true#close--" title="class or interface in java.lang">close</a></code>&nbsp;in interface&nbsp;<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></code></dd>
  456. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  457. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true#close--" title="class or interface in java.io">close</a></code>&nbsp;in class&nbsp;<code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a></code></dd>
  458. <dt><span class="throwsLabel">Throws:</span></dt>
  459. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if an I/O error occurs</dd>
  460. </dl>
  461. </li>
  462. </ul>
  463. <a name="reset--">
  464. <!-- -->
  465. </a>
  466. <ul class="blockList">
  467. <li class="blockList">
  468. <h4>reset</h4>
  469. <pre>public&nbsp;void&nbsp;reset()
  470. throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
  471. <div class="block">Invokes the delegate's <code>reset()</code> method.</div>
  472. <dl>
  473. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  474. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true#reset--" title="class or interface in java.io">reset</a></code>&nbsp;in class&nbsp;<code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a></code></dd>
  475. <dt><span class="throwsLabel">Throws:</span></dt>
  476. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if an I/O error occurs</dd>
  477. </dl>
  478. </li>
  479. </ul>
  480. <a name="mark-int-">
  481. <!-- -->
  482. </a>
  483. <ul class="blockList">
  484. <li class="blockList">
  485. <h4>mark</h4>
  486. <pre>public&nbsp;void&nbsp;mark(int&nbsp;readlimit)</pre>
  487. <div class="block">Invokes the delegate's <code>mark(int)</code> method.</div>
  488. <dl>
  489. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  490. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true#mark-int-" title="class or interface in java.io">mark</a></code>&nbsp;in class&nbsp;<code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a></code></dd>
  491. <dt><span class="paramLabel">Parameters:</span></dt>
  492. <dd><code>readlimit</code> - read ahead limit</dd>
  493. </dl>
  494. </li>
  495. </ul>
  496. <a name="markSupported--">
  497. <!-- -->
  498. </a>
  499. <ul class="blockList">
  500. <li class="blockList">
  501. <h4>markSupported</h4>
  502. <pre>public&nbsp;boolean&nbsp;markSupported()</pre>
  503. <div class="block">Invokes the delegate's <code>markSupported()</code> method.</div>
  504. <dl>
  505. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  506. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true#markSupported--" title="class or interface in java.io">markSupported</a></code>&nbsp;in class&nbsp;<code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a></code></dd>
  507. <dt><span class="returnLabel">Returns:</span></dt>
  508. <dd>true if mark is supported, otherwise false</dd>
  509. </dl>
  510. </li>
  511. </ul>
  512. <a name="isPropagateClose--">
  513. <!-- -->
  514. </a>
  515. <ul class="blockList">
  516. <li class="blockList">
  517. <h4>isPropagateClose</h4>
  518. <pre>public&nbsp;boolean&nbsp;isPropagateClose()</pre>
  519. <div class="block">Indicates whether the <a href="../../../../../org/apache/commons/io/input/BoundedInputStream.html#close--"><code>close()</code></a> method
  520. should propagate to the underling <a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io"><code>InputStream</code></a>.</div>
  521. <dl>
  522. <dt><span class="returnLabel">Returns:</span></dt>
  523. <dd><code>true</code> if calling <a href="../../../../../org/apache/commons/io/input/BoundedInputStream.html#close--"><code>close()</code></a>
  524. propagates to the <code>close()</code> method of the
  525. underlying stream or <code>false</code> if it does not.</dd>
  526. </dl>
  527. </li>
  528. </ul>
  529. <a name="setPropagateClose-boolean-">
  530. <!-- -->
  531. </a>
  532. <ul class="blockListLast">
  533. <li class="blockList">
  534. <h4>setPropagateClose</h4>
  535. <pre>public&nbsp;void&nbsp;setPropagateClose(boolean&nbsp;propagateClose)</pre>
  536. <div class="block">Set whether the <a href="../../../../../org/apache/commons/io/input/BoundedInputStream.html#close--"><code>close()</code></a> method
  537. should propagate to the underling <a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io"><code>InputStream</code></a>.</div>
  538. <dl>
  539. <dt><span class="paramLabel">Parameters:</span></dt>
  540. <dd><code>propagateClose</code> - <code>true</code> if calling
  541. <a href="../../../../../org/apache/commons/io/input/BoundedInputStream.html#close--"><code>close()</code></a> propagates to the <code>close()</code>
  542. method of the underlying stream or
  543. <code>false</code> if it does not.</dd>
  544. </dl>
  545. </li>
  546. </ul>
  547. </li>
  548. </ul>
  549. </li>
  550. </ul>
  551. </div>
  552. </div>
  553. <!-- ========= END OF CLASS DATA ========= -->
  554. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  555. <div class="bottomNav"><a name="navbar.bottom">
  556. <!-- -->
  557. </a>
  558. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  559. <a name="navbar.bottom.firstrow">
  560. <!-- -->
  561. </a>
  562. <ul class="navList" title="Navigation">
  563. <li><a href="../../../../../overview-summary.html">Overview</a></li>
  564. <li><a href="package-summary.html">Package</a></li>
  565. <li class="navBarCell1Rev">Class</li>
  566. <li><a href="class-use/BoundedInputStream.html">Use</a></li>
  567. <li><a href="package-tree.html">Tree</a></li>
  568. <li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
  569. <li><a href="../../../../../index-all.html">Index</a></li>
  570. <li><a href="../../../../../help-doc.html">Help</a></li>
  571. </ul>
  572. </div>
  573. <div class="subNav">
  574. <ul class="navList">
  575. <li><a href="../../../../../org/apache/commons/io/input/BOMInputStream.html" title="class in org.apache.commons.io.input"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  576. <li><a href="../../../../../org/apache/commons/io/input/BoundedReader.html" title="class in org.apache.commons.io.input"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  577. </ul>
  578. <ul class="navList">
  579. <li><a href="../../../../../index.html?org/apache/commons/io/input/BoundedInputStream.html" target="_top">Frames</a></li>
  580. <li><a href="BoundedInputStream.html" target="_top">No&nbsp;Frames</a></li>
  581. </ul>
  582. <ul class="navList" id="allclasses_navbar_bottom">
  583. <li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  584. </ul>
  585. <div>
  586. <script type="text/javascript"><!--
  587. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  588. if(window==top) {
  589. allClassesLink.style.display = "block";
  590. }
  591. else {
  592. allClassesLink.style.display = "none";
  593. }
  594. //-->
  595. </script>
  596. </div>
  597. <div>
  598. <ul class="subNavList">
  599. <li>Summary:&nbsp;</li>
  600. <li>Nested&nbsp;|&nbsp;</li>
  601. <li>Field&nbsp;|&nbsp;</li>
  602. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  603. <li><a href="#method.summary">Method</a></li>
  604. </ul>
  605. <ul class="subNavList">
  606. <li>Detail:&nbsp;</li>
  607. <li>Field&nbsp;|&nbsp;</li>
  608. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  609. <li><a href="#method.detail">Method</a></li>
  610. </ul>
  611. </div>
  612. <a name="skip.navbar.bottom">
  613. <!-- -->
  614. </a></div>
  615. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  616. <p class="legalCopy"><small>Copyright &#169; 2002&#x2013;2017 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
  617. </body>
  618. </html>