BoundedInputStream.html 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339
  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. <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
  6. <title>BoundedInputStream (Apache Commons Compress 1.13 API)</title>
  7. <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
  8. </head>
  9. <body>
  10. <script type="text/javascript"><!--
  11. try {
  12. if (location.href.indexOf('is-external=true') == -1) {
  13. parent.document.title="BoundedInputStream (Apache Commons Compress 1.13 API)";
  14. }
  15. }
  16. catch(err) {
  17. }
  18. //-->
  19. </script>
  20. <noscript>
  21. <div>JavaScript is disabled on your browser.</div>
  22. </noscript>
  23. <!-- ========= START OF TOP NAVBAR ======= -->
  24. <div class="topNav"><a name="navbar_top">
  25. <!-- -->
  26. </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
  27. <!-- -->
  28. </a>
  29. <ul class="navList" title="Navigation">
  30. <li><a href="../../../../../overview-summary.html">Overview</a></li>
  31. <li><a href="package-summary.html">Package</a></li>
  32. <li class="navBarCell1Rev">Class</li>
  33. <li><a href="class-use/BoundedInputStream.html">Use</a></li>
  34. <li><a href="package-tree.html">Tree</a></li>
  35. <li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
  36. <li><a href="../../../../../index-all.html">Index</a></li>
  37. <li><a href="../../../../../help-doc.html">Help</a></li>
  38. </ul>
  39. </div>
  40. <div class="subNav">
  41. <ul class="navList">
  42. <li><a href="../../../../../org/apache/commons/compress/utils/BitInputStream.html" title="class in org.apache.commons.compress.utils"><span class="strong">Prev Class</span></a></li>
  43. <li><a href="../../../../../org/apache/commons/compress/utils/CharsetNames.html" title="class in org.apache.commons.compress.utils"><span class="strong">Next Class</span></a></li>
  44. </ul>
  45. <ul class="navList">
  46. <li><a href="../../../../../index.html?org/apache/commons/compress/utils/BoundedInputStream.html" target="_top">Frames</a></li>
  47. <li><a href="BoundedInputStream.html" target="_top">No Frames</a></li>
  48. </ul>
  49. <ul class="navList" id="allclasses_navbar_top">
  50. <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
  51. </ul>
  52. <div>
  53. <script type="text/javascript"><!--
  54. allClassesLink = document.getElementById("allclasses_navbar_top");
  55. if(window==top) {
  56. allClassesLink.style.display = "block";
  57. }
  58. else {
  59. allClassesLink.style.display = "none";
  60. }
  61. //-->
  62. </script>
  63. </div>
  64. <div>
  65. <ul class="subNavList">
  66. <li>Summary:&nbsp;</li>
  67. <li>Nested&nbsp;|&nbsp;</li>
  68. <li>Field&nbsp;|&nbsp;</li>
  69. <li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
  70. <li><a href="#method_summary">Method</a></li>
  71. </ul>
  72. <ul class="subNavList">
  73. <li>Detail:&nbsp;</li>
  74. <li>Field&nbsp;|&nbsp;</li>
  75. <li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
  76. <li><a href="#method_detail">Method</a></li>
  77. </ul>
  78. </div>
  79. <a name="skip-navbar_top">
  80. <!-- -->
  81. </a></div>
  82. <!-- ========= END OF TOP NAVBAR ========= -->
  83. <!-- ======== START OF CLASS DATA ======== -->
  84. <div class="header">
  85. <div class="subTitle">org.apache.commons.compress.utils</div>
  86. <h2 title="Class BoundedInputStream" class="title">Class BoundedInputStream</h2>
  87. </div>
  88. <div class="contentContainer">
  89. <ul class="inheritance">
  90. <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>
  91. <li>
  92. <ul class="inheritance">
  93. <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>
  94. <li>
  95. <ul class="inheritance">
  96. <li>org.apache.commons.compress.utils.BoundedInputStream</li>
  97. </ul>
  98. </li>
  99. </ul>
  100. </li>
  101. </ul>
  102. <div class="description">
  103. <ul class="blockList">
  104. <li class="blockList">
  105. <dl>
  106. <dt>All Implemented Interfaces:</dt>
  107. <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>
  108. </dl>
  109. <hr>
  110. <br>
  111. <pre>public class <a href="../../../../../src-html/org/apache/commons/compress/utils/BoundedInputStream.html#line.28">BoundedInputStream</a>
  112. 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>
  113. <div class="block">A stream that limits reading from a wrapped stream to a given number of bytes.</div>
  114. <dl><dt><span class="strong">Since:</span></dt>
  115. <dd>1.6</dd>
  116. <dt><span class="strong">This class is not thread-safe</span></dt>
  117. <dd></dd></dl>
  118. </li>
  119. </ul>
  120. </div>
  121. <div class="summary">
  122. <ul class="blockList">
  123. <li class="blockList">
  124. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  125. <ul class="blockList">
  126. <li class="blockList"><a name="constructor_summary">
  127. <!-- -->
  128. </a>
  129. <h3>Constructor Summary</h3>
  130. <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  131. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  132. <tr>
  133. <th class="colOne" scope="col">Constructor and Description</th>
  134. </tr>
  135. <tr class="altColor">
  136. <td class="colOne"><code><strong><a href="../../../../../org/apache/commons/compress/utils/BoundedInputStream.html#BoundedInputStream(java.io.InputStream,%20long)">BoundedInputStream</a></strong>(<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,
  137. long&nbsp;size)</code>
  138. <div class="block">Creates the stream that will at most read the given amount of
  139. bytes from the given stream.</div>
  140. </td>
  141. </tr>
  142. </table>
  143. </li>
  144. </ul>
  145. <!-- ========== METHOD SUMMARY =========== -->
  146. <ul class="blockList">
  147. <li class="blockList"><a name="method_summary">
  148. <!-- -->
  149. </a>
  150. <h3>Method Summary</h3>
  151. <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  152. <caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
  153. <tr>
  154. <th class="colFirst" scope="col">Modifier and Type</th>
  155. <th class="colLast" scope="col">Method and Description</th>
  156. </tr>
  157. <tr class="altColor">
  158. <td class="colFirst"><code>void</code></td>
  159. <td class="colLast"><code><strong><a href="../../../../../org/apache/commons/compress/utils/BoundedInputStream.html#close()">close</a></strong>()</code>&nbsp;</td>
  160. </tr>
  161. <tr class="rowColor">
  162. <td class="colFirst"><code>int</code></td>
  163. <td class="colLast"><code><strong><a href="../../../../../org/apache/commons/compress/utils/BoundedInputStream.html#read()">read</a></strong>()</code>&nbsp;</td>
  164. </tr>
  165. <tr class="altColor">
  166. <td class="colFirst"><code>int</code></td>
  167. <td class="colLast"><code><strong><a href="../../../../../org/apache/commons/compress/utils/BoundedInputStream.html#read(byte[],%20int,%20int)">read</a></strong>(byte[]&nbsp;b,
  168. int&nbsp;off,
  169. int&nbsp;len)</code>&nbsp;</td>
  170. </tr>
  171. </table>
  172. <ul class="blockList">
  173. <li class="blockList"><a name="methods_inherited_from_class_java.io.InputStream">
  174. <!-- -->
  175. </a>
  176. <h3>Methods inherited from class&nbsp;java.io.<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></h3>
  177. <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>, <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>, <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>, <a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true#read(byte[])" title="class or interface in java.io">read</a>, <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>, <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></li>
  178. </ul>
  179. <ul class="blockList">
  180. <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
  181. <!-- -->
  182. </a>
  183. <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>
  184. <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#toString()" title="class or interface in java.lang">toString</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,%20int)" title="class or interface in java.lang">wait</a></code></li>
  185. </ul>
  186. </li>
  187. </ul>
  188. </li>
  189. </ul>
  190. </div>
  191. <div class="details">
  192. <ul class="blockList">
  193. <li class="blockList">
  194. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  195. <ul class="blockList">
  196. <li class="blockList"><a name="constructor_detail">
  197. <!-- -->
  198. </a>
  199. <h3>Constructor Detail</h3>
  200. <a name="BoundedInputStream(java.io.InputStream, long)">
  201. <!-- -->
  202. </a>
  203. <ul class="blockListLast">
  204. <li class="blockList">
  205. <h4>BoundedInputStream</h4>
  206. <pre>public&nbsp;<a href="../../../../../src-html/org/apache/commons/compress/utils/BoundedInputStream.html#line.38">BoundedInputStream</a>(<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,
  207. long&nbsp;size)</pre>
  208. <div class="block">Creates the stream that will at most read the given amount of
  209. bytes from the given stream.</div>
  210. <dl><dt><span class="strong">Parameters:</span></dt><dd><code>in</code> - the stream to read from</dd><dd><code>size</code> - the maximum amount of bytes to read</dd></dl>
  211. </li>
  212. </ul>
  213. </li>
  214. </ul>
  215. <!-- ============ METHOD DETAIL ========== -->
  216. <ul class="blockList">
  217. <li class="blockList"><a name="method_detail">
  218. <!-- -->
  219. </a>
  220. <h3>Method Detail</h3>
  221. <a name="read()">
  222. <!-- -->
  223. </a>
  224. <ul class="blockList">
  225. <li class="blockList">
  226. <h4>read</h4>
  227. <pre>public&nbsp;int&nbsp;<a href="../../../../../src-html/org/apache/commons/compress/utils/BoundedInputStream.html#line.44">read</a>()
  228. 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>
  229. <dl>
  230. <dt><strong>Specified by:</strong></dt>
  231. <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>
  232. <dt><span class="strong">Throws:</span></dt>
  233. <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></dl>
  234. </li>
  235. </ul>
  236. <a name="read(byte[], int, int)">
  237. <!-- -->
  238. </a>
  239. <ul class="blockList">
  240. <li class="blockList">
  241. <h4>read</h4>
  242. <pre>public&nbsp;int&nbsp;<a href="../../../../../src-html/org/apache/commons/compress/utils/BoundedInputStream.html#line.53">read</a>(byte[]&nbsp;b,
  243. int&nbsp;off,
  244. int&nbsp;len)
  245. 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>
  246. <dl>
  247. <dt><strong>Overrides:</strong></dt>
  248. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true#read(byte[],%20int,%20int)" 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>
  249. <dt><span class="strong">Throws:</span></dt>
  250. <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></dl>
  251. </li>
  252. </ul>
  253. <a name="close()">
  254. <!-- -->
  255. </a>
  256. <ul class="blockListLast">
  257. <li class="blockList">
  258. <h4>close</h4>
  259. <pre>public&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/commons/compress/utils/BoundedInputStream.html#line.69">close</a>()</pre>
  260. <dl>
  261. <dt><strong>Specified by:</strong></dt>
  262. <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>
  263. <dt><strong>Specified by:</strong></dt>
  264. <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>
  265. <dt><strong>Overrides:</strong></dt>
  266. <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>
  267. </dl>
  268. </li>
  269. </ul>
  270. </li>
  271. </ul>
  272. </li>
  273. </ul>
  274. </div>
  275. </div>
  276. <!-- ========= END OF CLASS DATA ========= -->
  277. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  278. <div class="bottomNav"><a name="navbar_bottom">
  279. <!-- -->
  280. </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
  281. <!-- -->
  282. </a>
  283. <ul class="navList" title="Navigation">
  284. <li><a href="../../../../../overview-summary.html">Overview</a></li>
  285. <li><a href="package-summary.html">Package</a></li>
  286. <li class="navBarCell1Rev">Class</li>
  287. <li><a href="class-use/BoundedInputStream.html">Use</a></li>
  288. <li><a href="package-tree.html">Tree</a></li>
  289. <li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
  290. <li><a href="../../../../../index-all.html">Index</a></li>
  291. <li><a href="../../../../../help-doc.html">Help</a></li>
  292. </ul>
  293. </div>
  294. <div class="subNav">
  295. <ul class="navList">
  296. <li><a href="../../../../../org/apache/commons/compress/utils/BitInputStream.html" title="class in org.apache.commons.compress.utils"><span class="strong">Prev Class</span></a></li>
  297. <li><a href="../../../../../org/apache/commons/compress/utils/CharsetNames.html" title="class in org.apache.commons.compress.utils"><span class="strong">Next Class</span></a></li>
  298. </ul>
  299. <ul class="navList">
  300. <li><a href="../../../../../index.html?org/apache/commons/compress/utils/BoundedInputStream.html" target="_top">Frames</a></li>
  301. <li><a href="BoundedInputStream.html" target="_top">No Frames</a></li>
  302. </ul>
  303. <ul class="navList" id="allclasses_navbar_bottom">
  304. <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
  305. </ul>
  306. <div>
  307. <script type="text/javascript"><!--
  308. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  309. if(window==top) {
  310. allClassesLink.style.display = "block";
  311. }
  312. else {
  313. allClassesLink.style.display = "none";
  314. }
  315. //-->
  316. </script>
  317. </div>
  318. <div>
  319. <ul class="subNavList">
  320. <li>Summary:&nbsp;</li>
  321. <li>Nested&nbsp;|&nbsp;</li>
  322. <li>Field&nbsp;|&nbsp;</li>
  323. <li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
  324. <li><a href="#method_summary">Method</a></li>
  325. </ul>
  326. <ul class="subNavList">
  327. <li>Detail:&nbsp;</li>
  328. <li>Field&nbsp;|&nbsp;</li>
  329. <li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
  330. <li><a href="#method_detail">Method</a></li>
  331. </ul>
  332. </div>
  333. <a name="skip-navbar_bottom">
  334. <!-- -->
  335. </a></div>
  336. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  337. <p class="legalCopy"><small>Copyright &#169; 2016 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
  338. </body>
  339. </html>