CompressorInputStream.html 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363
  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>CompressorInputStream (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="CompressorInputStream (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/CompressorInputStream.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/compressors/CompressorException.html" title="class in org.apache.commons.compress.compressors"><span class="strong">Prev Class</span></a></li>
  43. <li><a href="../../../../../org/apache/commons/compress/compressors/CompressorOutputStream.html" title="class in org.apache.commons.compress.compressors"><span class="strong">Next Class</span></a></li>
  44. </ul>
  45. <ul class="navList">
  46. <li><a href="../../../../../index.html?org/apache/commons/compress/compressors/CompressorInputStream.html" target="_top">Frames</a></li>
  47. <li><a href="CompressorInputStream.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.compressors</div>
  86. <h2 title="Class CompressorInputStream" class="title">Class CompressorInputStream</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.compressors.CompressorInputStream</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. <dl>
  110. <dt>Direct Known Subclasses:</dt>
  111. <dd><a href="../../../../../org/apache/commons/compress/compressors/bzip2/BZip2CompressorInputStream.html" title="class in org.apache.commons.compress.compressors.bzip2">BZip2CompressorInputStream</a>, <a href="../../../../../org/apache/commons/compress/compressors/deflate/DeflateCompressorInputStream.html" title="class in org.apache.commons.compress.compressors.deflate">DeflateCompressorInputStream</a>, <a href="../../../../../org/apache/commons/compress/compressors/snappy/FramedSnappyCompressorInputStream.html" title="class in org.apache.commons.compress.compressors.snappy">FramedSnappyCompressorInputStream</a>, <a href="../../../../../org/apache/commons/compress/compressors/gzip/GzipCompressorInputStream.html" title="class in org.apache.commons.compress.compressors.gzip">GzipCompressorInputStream</a>, <a href="../../../../../org/apache/commons/compress/compressors/lzma/LZMACompressorInputStream.html" title="class in org.apache.commons.compress.compressors.lzma">LZMACompressorInputStream</a>, <a href="../../../../../org/apache/commons/compress/compressors/lzw/LZWInputStream.html" title="class in org.apache.commons.compress.compressors.lzw">LZWInputStream</a>, <a href="../../../../../org/apache/commons/compress/compressors/pack200/Pack200CompressorInputStream.html" title="class in org.apache.commons.compress.compressors.pack200">Pack200CompressorInputStream</a>, <a href="../../../../../org/apache/commons/compress/compressors/snappy/SnappyCompressorInputStream.html" title="class in org.apache.commons.compress.compressors.snappy">SnappyCompressorInputStream</a>, <a href="../../../../../org/apache/commons/compress/compressors/xz/XZCompressorInputStream.html" title="class in org.apache.commons.compress.compressors.xz">XZCompressorInputStream</a></dd>
  112. </dl>
  113. <hr>
  114. <br>
  115. <pre>public abstract class <a href="../../../../../src-html/org/apache/commons/compress/compressors/CompressorInputStream.html#line.23">CompressorInputStream</a>
  116. 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>
  117. </li>
  118. </ul>
  119. </div>
  120. <div class="summary">
  121. <ul class="blockList">
  122. <li class="blockList">
  123. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  124. <ul class="blockList">
  125. <li class="blockList"><a name="constructor_summary">
  126. <!-- -->
  127. </a>
  128. <h3>Constructor Summary</h3>
  129. <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  130. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  131. <tr>
  132. <th class="colOne" scope="col">Constructor and Description</th>
  133. </tr>
  134. <tr class="altColor">
  135. <td class="colOne"><code><strong><a href="../../../../../org/apache/commons/compress/compressors/CompressorInputStream.html#CompressorInputStream()">CompressorInputStream</a></strong>()</code>&nbsp;</td>
  136. </tr>
  137. </table>
  138. </li>
  139. </ul>
  140. <!-- ========== METHOD SUMMARY =========== -->
  141. <ul class="blockList">
  142. <li class="blockList"><a name="method_summary">
  143. <!-- -->
  144. </a>
  145. <h3>Method Summary</h3>
  146. <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  147. <caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
  148. <tr>
  149. <th class="colFirst" scope="col">Modifier and Type</th>
  150. <th class="colLast" scope="col">Method and Description</th>
  151. </tr>
  152. <tr class="altColor">
  153. <td class="colFirst"><code>protected void</code></td>
  154. <td class="colLast"><code><strong><a href="../../../../../org/apache/commons/compress/compressors/CompressorInputStream.html#count(int)">count</a></strong>(int&nbsp;read)</code>
  155. <div class="block">Increments the counter of already read bytes.</div>
  156. </td>
  157. </tr>
  158. <tr class="rowColor">
  159. <td class="colFirst"><code>protected void</code></td>
  160. <td class="colLast"><code><strong><a href="../../../../../org/apache/commons/compress/compressors/CompressorInputStream.html#count(long)">count</a></strong>(long&nbsp;read)</code>
  161. <div class="block">Increments the counter of already read bytes.</div>
  162. </td>
  163. </tr>
  164. <tr class="altColor">
  165. <td class="colFirst"><code>long</code></td>
  166. <td class="colLast"><code><strong><a href="../../../../../org/apache/commons/compress/compressors/CompressorInputStream.html#getBytesRead()">getBytesRead</a></strong>()</code>
  167. <div class="block">Returns the current number of bytes read from this stream.</div>
  168. </td>
  169. </tr>
  170. <tr class="rowColor">
  171. <td class="colFirst"><code>int</code></td>
  172. <td class="colLast"><code><strong><a href="../../../../../org/apache/commons/compress/compressors/CompressorInputStream.html#getCount()">getCount</a></strong>()</code>
  173. <div class="block"><strong>Deprecated.</strong>&nbsp;
  174. <div class="block"><i>this method may yield wrong results for large
  175. archives, use #getBytesRead instead</i></div>
  176. </div>
  177. </td>
  178. </tr>
  179. <tr class="altColor">
  180. <td class="colFirst"><code>protected void</code></td>
  181. <td class="colLast"><code><strong><a href="../../../../../org/apache/commons/compress/compressors/CompressorInputStream.html#pushedBackBytes(long)">pushedBackBytes</a></strong>(long&nbsp;pushedBack)</code>
  182. <div class="block">Decrements the counter of already read bytes.</div>
  183. </td>
  184. </tr>
  185. </table>
  186. <ul class="blockList">
  187. <li class="blockList"><a name="methods_inherited_from_class_java.io.InputStream">
  188. <!-- -->
  189. </a>
  190. <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>
  191. <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#close()" title="class or interface in java.io">close</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()" 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#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#read(byte[],%20int,%20int)" 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>
  192. </ul>
  193. <ul class="blockList">
  194. <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
  195. <!-- -->
  196. </a>
  197. <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>
  198. <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>
  199. </ul>
  200. </li>
  201. </ul>
  202. </li>
  203. </ul>
  204. </div>
  205. <div class="details">
  206. <ul class="blockList">
  207. <li class="blockList">
  208. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  209. <ul class="blockList">
  210. <li class="blockList"><a name="constructor_detail">
  211. <!-- -->
  212. </a>
  213. <h3>Constructor Detail</h3>
  214. <a name="CompressorInputStream()">
  215. <!-- -->
  216. </a>
  217. <ul class="blockListLast">
  218. <li class="blockList">
  219. <h4>CompressorInputStream</h4>
  220. <pre>public&nbsp;<a href="../../../../../src-html/org/apache/commons/compress/compressors/CompressorInputStream.html#line.23">CompressorInputStream</a>()</pre>
  221. </li>
  222. </ul>
  223. </li>
  224. </ul>
  225. <!-- ============ METHOD DETAIL ========== -->
  226. <ul class="blockList">
  227. <li class="blockList"><a name="method_detail">
  228. <!-- -->
  229. </a>
  230. <h3>Method Detail</h3>
  231. <a name="count(int)">
  232. <!-- -->
  233. </a>
  234. <ul class="blockList">
  235. <li class="blockList">
  236. <h4>count</h4>
  237. <pre>protected&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/commons/compress/compressors/CompressorInputStream.html#line.34">count</a>(int&nbsp;read)</pre>
  238. <div class="block">Increments the counter of already read bytes.
  239. Doesn't increment if the EOF has been hit (read == -1)</div>
  240. <dl><dt><span class="strong">Parameters:</span></dt><dd><code>read</code> - the number of bytes read</dd><dt><span class="strong">Since:</span></dt>
  241. <dd>1.1</dd></dl>
  242. </li>
  243. </ul>
  244. <a name="count(long)">
  245. <!-- -->
  246. </a>
  247. <ul class="blockList">
  248. <li class="blockList">
  249. <h4>count</h4>
  250. <pre>protected&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/commons/compress/compressors/CompressorInputStream.html#line.44">count</a>(long&nbsp;read)</pre>
  251. <div class="block">Increments the counter of already read bytes.
  252. Doesn't increment if the EOF has been hit (read == -1)</div>
  253. <dl><dt><span class="strong">Parameters:</span></dt><dd><code>read</code> - the number of bytes read</dd></dl>
  254. </li>
  255. </ul>
  256. <a name="pushedBackBytes(long)">
  257. <!-- -->
  258. </a>
  259. <ul class="blockList">
  260. <li class="blockList">
  261. <h4>pushedBackBytes</h4>
  262. <pre>protected&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/commons/compress/compressors/CompressorInputStream.html#line.56">pushedBackBytes</a>(long&nbsp;pushedBack)</pre>
  263. <div class="block">Decrements the counter of already read bytes.</div>
  264. <dl><dt><span class="strong">Parameters:</span></dt><dd><code>pushedBack</code> - the number of bytes pushed back.</dd><dt><span class="strong">Since:</span></dt>
  265. <dd>1.7</dd></dl>
  266. </li>
  267. </ul>
  268. <a name="getCount()">
  269. <!-- -->
  270. </a>
  271. <ul class="blockList">
  272. <li class="blockList">
  273. <h4>getCount</h4>
  274. <pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
  275. public&nbsp;int&nbsp;<a href="../../../../../src-html/org/apache/commons/compress/compressors/CompressorInputStream.html#line.67">getCount</a>()</pre>
  276. <div class="block"><span class="strong">Deprecated.</span>&nbsp;<i>this method may yield wrong results for large
  277. archives, use #getBytesRead instead</i></div>
  278. <div class="block">Returns the current number of bytes read from this stream.</div>
  279. <dl><dt><span class="strong">Returns:</span></dt><dd>the number of read bytes</dd></dl>
  280. </li>
  281. </ul>
  282. <a name="getBytesRead()">
  283. <!-- -->
  284. </a>
  285. <ul class="blockListLast">
  286. <li class="blockList">
  287. <h4>getBytesRead</h4>
  288. <pre>public&nbsp;long&nbsp;<a href="../../../../../src-html/org/apache/commons/compress/compressors/CompressorInputStream.html#line.77">getBytesRead</a>()</pre>
  289. <div class="block">Returns the current number of bytes read from this stream.</div>
  290. <dl><dt><span class="strong">Returns:</span></dt><dd>the number of read bytes</dd><dt><span class="strong">Since:</span></dt>
  291. <dd>1.1</dd></dl>
  292. </li>
  293. </ul>
  294. </li>
  295. </ul>
  296. </li>
  297. </ul>
  298. </div>
  299. </div>
  300. <!-- ========= END OF CLASS DATA ========= -->
  301. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  302. <div class="bottomNav"><a name="navbar_bottom">
  303. <!-- -->
  304. </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
  305. <!-- -->
  306. </a>
  307. <ul class="navList" title="Navigation">
  308. <li><a href="../../../../../overview-summary.html">Overview</a></li>
  309. <li><a href="package-summary.html">Package</a></li>
  310. <li class="navBarCell1Rev">Class</li>
  311. <li><a href="class-use/CompressorInputStream.html">Use</a></li>
  312. <li><a href="package-tree.html">Tree</a></li>
  313. <li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
  314. <li><a href="../../../../../index-all.html">Index</a></li>
  315. <li><a href="../../../../../help-doc.html">Help</a></li>
  316. </ul>
  317. </div>
  318. <div class="subNav">
  319. <ul class="navList">
  320. <li><a href="../../../../../org/apache/commons/compress/compressors/CompressorException.html" title="class in org.apache.commons.compress.compressors"><span class="strong">Prev Class</span></a></li>
  321. <li><a href="../../../../../org/apache/commons/compress/compressors/CompressorOutputStream.html" title="class in org.apache.commons.compress.compressors"><span class="strong">Next Class</span></a></li>
  322. </ul>
  323. <ul class="navList">
  324. <li><a href="../../../../../index.html?org/apache/commons/compress/compressors/CompressorInputStream.html" target="_top">Frames</a></li>
  325. <li><a href="CompressorInputStream.html" target="_top">No Frames</a></li>
  326. </ul>
  327. <ul class="navList" id="allclasses_navbar_bottom">
  328. <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
  329. </ul>
  330. <div>
  331. <script type="text/javascript"><!--
  332. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  333. if(window==top) {
  334. allClassesLink.style.display = "block";
  335. }
  336. else {
  337. allClassesLink.style.display = "none";
  338. }
  339. //-->
  340. </script>
  341. </div>
  342. <div>
  343. <ul class="subNavList">
  344. <li>Summary:&nbsp;</li>
  345. <li>Nested&nbsp;|&nbsp;</li>
  346. <li>Field&nbsp;|&nbsp;</li>
  347. <li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
  348. <li><a href="#method_summary">Method</a></li>
  349. </ul>
  350. <ul class="subNavList">
  351. <li>Detail:&nbsp;</li>
  352. <li>Field&nbsp;|&nbsp;</li>
  353. <li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
  354. <li><a href="#method_detail">Method</a></li>
  355. </ul>
  356. </div>
  357. <a name="skip-navbar_bottom">
  358. <!-- -->
  359. </a></div>
  360. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  361. <p class="legalCopy"><small>Copyright &#169; 2016 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
  362. </body>
  363. </html>