BZip2CompressorInputStream.html 32 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564
  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>BZip2CompressorInputStream (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="BZip2CompressorInputStream (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/BZip2CompressorInputStream.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>Prev Class</li>
  43. <li><a href="../../../../../../org/apache/commons/compress/compressors/bzip2/BZip2CompressorOutputStream.html" title="class in org.apache.commons.compress.compressors.bzip2"><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/bzip2/BZip2CompressorInputStream.html" target="_top">Frames</a></li>
  47. <li><a href="BZip2CompressorInputStream.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><a href="#field_summary">Field</a>&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><a href="#field_detail">Field</a>&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.bzip2</div>
  86. <h2 title="Class BZip2CompressorInputStream" class="title">Class BZip2CompressorInputStream</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><a href="../../../../../../org/apache/commons/compress/compressors/CompressorInputStream.html" title="class in org.apache.commons.compress.compressors">org.apache.commons.compress.compressors.CompressorInputStream</a></li>
  97. <li>
  98. <ul class="inheritance">
  99. <li>org.apache.commons.compress.compressors.bzip2.BZip2CompressorInputStream</li>
  100. </ul>
  101. </li>
  102. </ul>
  103. </li>
  104. </ul>
  105. </li>
  106. </ul>
  107. <div class="description">
  108. <ul class="blockList">
  109. <li class="blockList">
  110. <dl>
  111. <dt>All Implemented Interfaces:</dt>
  112. <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>
  113. </dl>
  114. <hr>
  115. <br>
  116. <pre>public class <a href="../../../../../../src-html/org/apache/commons/compress/compressors/bzip2/BZip2CompressorInputStream.html#line.37">BZip2CompressorInputStream</a>
  117. extends <a href="../../../../../../org/apache/commons/compress/compressors/CompressorInputStream.html" title="class in org.apache.commons.compress.compressors">CompressorInputStream</a></pre>
  118. <div class="block">An input stream that decompresses from the BZip2 format to be read as any other stream.</div>
  119. <dl><dt><span class="strong">This class is not thread-safe</span></dt>
  120. <dd></dd></dl>
  121. </li>
  122. </ul>
  123. </div>
  124. <div class="summary">
  125. <ul class="blockList">
  126. <li class="blockList">
  127. <!-- =========== FIELD SUMMARY =========== -->
  128. <ul class="blockList">
  129. <li class="blockList"><a name="field_summary">
  130. <!-- -->
  131. </a>
  132. <h3>Field Summary</h3>
  133. <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
  134. <caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
  135. <tr>
  136. <th class="colFirst" scope="col">Modifier and Type</th>
  137. <th class="colLast" scope="col">Field and Description</th>
  138. </tr>
  139. <tr class="altColor">
  140. <td class="colFirst"><code>static int</code></td>
  141. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/compressors/bzip2/BZip2CompressorInputStream.html#BASEBLOCKSIZE">BASEBLOCKSIZE</a></strong></code>&nbsp;</td>
  142. </tr>
  143. <tr class="rowColor">
  144. <td class="colFirst"><code>static int</code></td>
  145. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/compressors/bzip2/BZip2CompressorInputStream.html#G_SIZE">G_SIZE</a></strong></code>&nbsp;</td>
  146. </tr>
  147. <tr class="altColor">
  148. <td class="colFirst"><code>static int</code></td>
  149. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/compressors/bzip2/BZip2CompressorInputStream.html#MAX_ALPHA_SIZE">MAX_ALPHA_SIZE</a></strong></code>&nbsp;</td>
  150. </tr>
  151. <tr class="rowColor">
  152. <td class="colFirst"><code>static int</code></td>
  153. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/compressors/bzip2/BZip2CompressorInputStream.html#MAX_CODE_LEN">MAX_CODE_LEN</a></strong></code>&nbsp;</td>
  154. </tr>
  155. <tr class="altColor">
  156. <td class="colFirst"><code>static int</code></td>
  157. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/compressors/bzip2/BZip2CompressorInputStream.html#MAX_SELECTORS">MAX_SELECTORS</a></strong></code>&nbsp;</td>
  158. </tr>
  159. <tr class="rowColor">
  160. <td class="colFirst"><code>static int</code></td>
  161. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/compressors/bzip2/BZip2CompressorInputStream.html#N_GROUPS">N_GROUPS</a></strong></code>&nbsp;</td>
  162. </tr>
  163. <tr class="altColor">
  164. <td class="colFirst"><code>static int</code></td>
  165. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/compressors/bzip2/BZip2CompressorInputStream.html#N_ITERS">N_ITERS</a></strong></code>&nbsp;</td>
  166. </tr>
  167. <tr class="rowColor">
  168. <td class="colFirst"><code>static int</code></td>
  169. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/compressors/bzip2/BZip2CompressorInputStream.html#NUM_OVERSHOOT_BYTES">NUM_OVERSHOOT_BYTES</a></strong></code>&nbsp;</td>
  170. </tr>
  171. <tr class="altColor">
  172. <td class="colFirst"><code>static int</code></td>
  173. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/compressors/bzip2/BZip2CompressorInputStream.html#RUNA">RUNA</a></strong></code>&nbsp;</td>
  174. </tr>
  175. <tr class="rowColor">
  176. <td class="colFirst"><code>static int</code></td>
  177. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/compressors/bzip2/BZip2CompressorInputStream.html#RUNB">RUNB</a></strong></code>&nbsp;</td>
  178. </tr>
  179. </table>
  180. </li>
  181. </ul>
  182. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  183. <ul class="blockList">
  184. <li class="blockList"><a name="constructor_summary">
  185. <!-- -->
  186. </a>
  187. <h3>Constructor Summary</h3>
  188. <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  189. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  190. <tr>
  191. <th class="colOne" scope="col">Constructor and Description</th>
  192. </tr>
  193. <tr class="altColor">
  194. <td class="colOne"><code><strong><a href="../../../../../../org/apache/commons/compress/compressors/bzip2/BZip2CompressorInputStream.html#BZip2CompressorInputStream(java.io.InputStream)">BZip2CompressorInputStream</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)</code>
  195. <div class="block">Constructs a new BZip2CompressorInputStream which decompresses bytes
  196. read from the specified stream.</div>
  197. </td>
  198. </tr>
  199. <tr class="rowColor">
  200. <td class="colOne"><code><strong><a href="../../../../../../org/apache/commons/compress/compressors/bzip2/BZip2CompressorInputStream.html#BZip2CompressorInputStream(java.io.InputStream,%20boolean)">BZip2CompressorInputStream</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,
  201. boolean&nbsp;decompressConcatenated)</code>
  202. <div class="block">Constructs a new BZip2CompressorInputStream which decompresses bytes
  203. read from the specified stream.</div>
  204. </td>
  205. </tr>
  206. </table>
  207. </li>
  208. </ul>
  209. <!-- ========== METHOD SUMMARY =========== -->
  210. <ul class="blockList">
  211. <li class="blockList"><a name="method_summary">
  212. <!-- -->
  213. </a>
  214. <h3>Method Summary</h3>
  215. <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  216. <caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
  217. <tr>
  218. <th class="colFirst" scope="col">Modifier and Type</th>
  219. <th class="colLast" scope="col">Method and Description</th>
  220. </tr>
  221. <tr class="altColor">
  222. <td class="colFirst"><code>void</code></td>
  223. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/compressors/bzip2/BZip2CompressorInputStream.html#close()">close</a></strong>()</code>&nbsp;</td>
  224. </tr>
  225. <tr class="rowColor">
  226. <td class="colFirst"><code>static boolean</code></td>
  227. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/compressors/bzip2/BZip2CompressorInputStream.html#matches(byte[],%20int)">matches</a></strong>(byte[]&nbsp;signature,
  228. int&nbsp;length)</code>
  229. <div class="block">Checks if the signature matches what is expected for a bzip2 file.</div>
  230. </td>
  231. </tr>
  232. <tr class="altColor">
  233. <td class="colFirst"><code>int</code></td>
  234. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/compressors/bzip2/BZip2CompressorInputStream.html#read()">read</a></strong>()</code>&nbsp;</td>
  235. </tr>
  236. <tr class="rowColor">
  237. <td class="colFirst"><code>int</code></td>
  238. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/compressors/bzip2/BZip2CompressorInputStream.html#read(byte[],%20int,%20int)">read</a></strong>(byte[]&nbsp;dest,
  239. int&nbsp;offs,
  240. int&nbsp;len)</code>&nbsp;</td>
  241. </tr>
  242. </table>
  243. <ul class="blockList">
  244. <li class="blockList"><a name="methods_inherited_from_class_org.apache.commons.compress.compressors.CompressorInputStream">
  245. <!-- -->
  246. </a>
  247. <h3>Methods inherited from class&nbsp;org.apache.commons.compress.compressors.<a href="../../../../../../org/apache/commons/compress/compressors/CompressorInputStream.html" title="class in org.apache.commons.compress.compressors">CompressorInputStream</a></h3>
  248. <code><a href="../../../../../../org/apache/commons/compress/compressors/CompressorInputStream.html#count(int)">count</a>, <a href="../../../../../../org/apache/commons/compress/compressors/CompressorInputStream.html#count(long)">count</a>, <a href="../../../../../../org/apache/commons/compress/compressors/CompressorInputStream.html#getBytesRead()">getBytesRead</a>, <a href="../../../../../../org/apache/commons/compress/compressors/CompressorInputStream.html#getCount()">getCount</a>, <a href="../../../../../../org/apache/commons/compress/compressors/CompressorInputStream.html#pushedBackBytes(long)">pushedBackBytes</a></code></li>
  249. </ul>
  250. <ul class="blockList">
  251. <li class="blockList"><a name="methods_inherited_from_class_java.io.InputStream">
  252. <!-- -->
  253. </a>
  254. <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>
  255. <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>
  256. </ul>
  257. <ul class="blockList">
  258. <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
  259. <!-- -->
  260. </a>
  261. <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>
  262. <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>
  263. </ul>
  264. </li>
  265. </ul>
  266. </li>
  267. </ul>
  268. </div>
  269. <div class="details">
  270. <ul class="blockList">
  271. <li class="blockList">
  272. <!-- ============ FIELD DETAIL =========== -->
  273. <ul class="blockList">
  274. <li class="blockList"><a name="field_detail">
  275. <!-- -->
  276. </a>
  277. <h3>Field Detail</h3>
  278. <a name="BASEBLOCKSIZE">
  279. <!-- -->
  280. </a>
  281. <ul class="blockList">
  282. <li class="blockList">
  283. <h4>BASEBLOCKSIZE</h4>
  284. <pre>public static final&nbsp;int <a href="../../../../../../src-html/org/apache/commons/compress/compressors/bzip2/BZip2Constants.html#line.27">BASEBLOCKSIZE</a></pre>
  285. <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../constant-values.html#org.apache.commons.compress.compressors.bzip2.BZip2CompressorInputStream.BASEBLOCKSIZE">Constant Field Values</a></dd></dl>
  286. </li>
  287. </ul>
  288. <a name="MAX_ALPHA_SIZE">
  289. <!-- -->
  290. </a>
  291. <ul class="blockList">
  292. <li class="blockList">
  293. <h4>MAX_ALPHA_SIZE</h4>
  294. <pre>public static final&nbsp;int <a href="../../../../../../src-html/org/apache/commons/compress/compressors/bzip2/BZip2Constants.html#line.28">MAX_ALPHA_SIZE</a></pre>
  295. <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../constant-values.html#org.apache.commons.compress.compressors.bzip2.BZip2CompressorInputStream.MAX_ALPHA_SIZE">Constant Field Values</a></dd></dl>
  296. </li>
  297. </ul>
  298. <a name="MAX_CODE_LEN">
  299. <!-- -->
  300. </a>
  301. <ul class="blockList">
  302. <li class="blockList">
  303. <h4>MAX_CODE_LEN</h4>
  304. <pre>public static final&nbsp;int <a href="../../../../../../src-html/org/apache/commons/compress/compressors/bzip2/BZip2Constants.html#line.29">MAX_CODE_LEN</a></pre>
  305. <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../constant-values.html#org.apache.commons.compress.compressors.bzip2.BZip2CompressorInputStream.MAX_CODE_LEN">Constant Field Values</a></dd></dl>
  306. </li>
  307. </ul>
  308. <a name="RUNA">
  309. <!-- -->
  310. </a>
  311. <ul class="blockList">
  312. <li class="blockList">
  313. <h4>RUNA</h4>
  314. <pre>public static final&nbsp;int <a href="../../../../../../src-html/org/apache/commons/compress/compressors/bzip2/BZip2Constants.html#line.30">RUNA</a></pre>
  315. <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../constant-values.html#org.apache.commons.compress.compressors.bzip2.BZip2CompressorInputStream.RUNA">Constant Field Values</a></dd></dl>
  316. </li>
  317. </ul>
  318. <a name="RUNB">
  319. <!-- -->
  320. </a>
  321. <ul class="blockList">
  322. <li class="blockList">
  323. <h4>RUNB</h4>
  324. <pre>public static final&nbsp;int <a href="../../../../../../src-html/org/apache/commons/compress/compressors/bzip2/BZip2Constants.html#line.31">RUNB</a></pre>
  325. <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../constant-values.html#org.apache.commons.compress.compressors.bzip2.BZip2CompressorInputStream.RUNB">Constant Field Values</a></dd></dl>
  326. </li>
  327. </ul>
  328. <a name="N_GROUPS">
  329. <!-- -->
  330. </a>
  331. <ul class="blockList">
  332. <li class="blockList">
  333. <h4>N_GROUPS</h4>
  334. <pre>public static final&nbsp;int <a href="../../../../../../src-html/org/apache/commons/compress/compressors/bzip2/BZip2Constants.html#line.32">N_GROUPS</a></pre>
  335. <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../constant-values.html#org.apache.commons.compress.compressors.bzip2.BZip2CompressorInputStream.N_GROUPS">Constant Field Values</a></dd></dl>
  336. </li>
  337. </ul>
  338. <a name="G_SIZE">
  339. <!-- -->
  340. </a>
  341. <ul class="blockList">
  342. <li class="blockList">
  343. <h4>G_SIZE</h4>
  344. <pre>public static final&nbsp;int <a href="../../../../../../src-html/org/apache/commons/compress/compressors/bzip2/BZip2Constants.html#line.33">G_SIZE</a></pre>
  345. <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../constant-values.html#org.apache.commons.compress.compressors.bzip2.BZip2CompressorInputStream.G_SIZE">Constant Field Values</a></dd></dl>
  346. </li>
  347. </ul>
  348. <a name="N_ITERS">
  349. <!-- -->
  350. </a>
  351. <ul class="blockList">
  352. <li class="blockList">
  353. <h4>N_ITERS</h4>
  354. <pre>public static final&nbsp;int <a href="../../../../../../src-html/org/apache/commons/compress/compressors/bzip2/BZip2Constants.html#line.34">N_ITERS</a></pre>
  355. <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../constant-values.html#org.apache.commons.compress.compressors.bzip2.BZip2CompressorInputStream.N_ITERS">Constant Field Values</a></dd></dl>
  356. </li>
  357. </ul>
  358. <a name="MAX_SELECTORS">
  359. <!-- -->
  360. </a>
  361. <ul class="blockList">
  362. <li class="blockList">
  363. <h4>MAX_SELECTORS</h4>
  364. <pre>public static final&nbsp;int <a href="../../../../../../src-html/org/apache/commons/compress/compressors/bzip2/BZip2Constants.html#line.35">MAX_SELECTORS</a></pre>
  365. <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../constant-values.html#org.apache.commons.compress.compressors.bzip2.BZip2CompressorInputStream.MAX_SELECTORS">Constant Field Values</a></dd></dl>
  366. </li>
  367. </ul>
  368. <a name="NUM_OVERSHOOT_BYTES">
  369. <!-- -->
  370. </a>
  371. <ul class="blockListLast">
  372. <li class="blockList">
  373. <h4>NUM_OVERSHOOT_BYTES</h4>
  374. <pre>public static final&nbsp;int <a href="../../../../../../src-html/org/apache/commons/compress/compressors/bzip2/BZip2Constants.html#line.36">NUM_OVERSHOOT_BYTES</a></pre>
  375. <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../constant-values.html#org.apache.commons.compress.compressors.bzip2.BZip2CompressorInputStream.NUM_OVERSHOOT_BYTES">Constant Field Values</a></dd></dl>
  376. </li>
  377. </ul>
  378. </li>
  379. </ul>
  380. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  381. <ul class="blockList">
  382. <li class="blockList"><a name="constructor_detail">
  383. <!-- -->
  384. </a>
  385. <h3>Constructor Detail</h3>
  386. <a name="BZip2CompressorInputStream(java.io.InputStream)">
  387. <!-- -->
  388. </a>
  389. <ul class="blockList">
  390. <li class="blockList">
  391. <h4>BZip2CompressorInputStream</h4>
  392. <pre>public&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/compressors/bzip2/BZip2CompressorInputStream.html#line.109">BZip2CompressorInputStream</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)
  393. 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>
  394. <div class="block">Constructs a new BZip2CompressorInputStream which decompresses bytes
  395. read from the specified stream. This doesn't suppprt decompressing
  396. concatenated .bz2 files.</div>
  397. <dl><dt><span class="strong">Parameters:</span></dt><dd><code>in</code> - the InputStream from which this object should be created</dd>
  398. <dt><span class="strong">Throws:</span></dt>
  399. <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 the stream content is malformed or an I/O error occurs.</dd>
  400. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - if <code>in == null</code></dd></dl>
  401. </li>
  402. </ul>
  403. <a name="BZip2CompressorInputStream(java.io.InputStream, boolean)">
  404. <!-- -->
  405. </a>
  406. <ul class="blockListLast">
  407. <li class="blockList">
  408. <h4>BZip2CompressorInputStream</h4>
  409. <pre>public&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/compressors/bzip2/BZip2CompressorInputStream.html#line.127">BZip2CompressorInputStream</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,
  410. boolean&nbsp;decompressConcatenated)
  411. 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>
  412. <div class="block">Constructs a new BZip2CompressorInputStream which decompresses bytes
  413. read from the specified stream.</div>
  414. <dl><dt><span class="strong">Parameters:</span></dt><dd><code>in</code> - the InputStream from which this object should be created</dd><dd><code>decompressConcatenated</code> - if true, decompress until the end of the input;
  415. if false, stop after the first .bz2 stream and
  416. leave the input position to point to the next
  417. byte after the .bz2 stream</dd>
  418. <dt><span class="strong">Throws:</span></dt>
  419. <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 <code>in == null</code>, the stream content is malformed, or an I/O error occurs.</dd></dl>
  420. </li>
  421. </ul>
  422. </li>
  423. </ul>
  424. <!-- ============ METHOD DETAIL ========== -->
  425. <ul class="blockList">
  426. <li class="blockList"><a name="method_detail">
  427. <!-- -->
  428. </a>
  429. <h3>Method Detail</h3>
  430. <a name="read()">
  431. <!-- -->
  432. </a>
  433. <ul class="blockList">
  434. <li class="blockList">
  435. <h4>read</h4>
  436. <pre>public&nbsp;int&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/compressors/bzip2/BZip2CompressorInputStream.html#line.136">read</a>()
  437. 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>
  438. <dl>
  439. <dt><strong>Specified by:</strong></dt>
  440. <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>
  441. <dt><span class="strong">Throws:</span></dt>
  442. <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>
  443. </li>
  444. </ul>
  445. <a name="read(byte[], int, int)">
  446. <!-- -->
  447. </a>
  448. <ul class="blockList">
  449. <li class="blockList">
  450. <h4>read</h4>
  451. <pre>public&nbsp;int&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/compressors/bzip2/BZip2CompressorInputStream.html#line.151">read</a>(byte[]&nbsp;dest,
  452. int&nbsp;offs,
  453. int&nbsp;len)
  454. 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>
  455. <dl>
  456. <dt><strong>Overrides:</strong></dt>
  457. <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>
  458. <dt><span class="strong">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></dd></dl>
  460. </li>
  461. </ul>
  462. <a name="close()">
  463. <!-- -->
  464. </a>
  465. <ul class="blockList">
  466. <li class="blockList">
  467. <h4>close</h4>
  468. <pre>public&nbsp;void&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/compressors/bzip2/BZip2CompressorInputStream.html#line.352">close</a>()
  469. 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>
  470. <dl>
  471. <dt><strong>Specified by:</strong></dt>
  472. <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>
  473. <dt><strong>Specified by:</strong></dt>
  474. <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>
  475. <dt><strong>Overrides:</strong></dt>
  476. <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>
  477. <dt><span class="strong">Throws:</span></dt>
  478. <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>
  479. </li>
  480. </ul>
  481. <a name="matches(byte[], int)">
  482. <!-- -->
  483. </a>
  484. <ul class="blockListLast">
  485. <li class="blockList">
  486. <h4>matches</h4>
  487. <pre>public static&nbsp;boolean&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/compressors/bzip2/BZip2CompressorInputStream.html#line.990">matches</a>(byte[]&nbsp;signature,
  488. int&nbsp;length)</pre>
  489. <div class="block">Checks if the signature matches what is expected for a bzip2 file.</div>
  490. <dl><dt><span class="strong">Parameters:</span></dt><dd><code>signature</code> - the bytes to check</dd><dd><code>length</code> - the number of bytes to check</dd>
  491. <dt><span class="strong">Returns:</span></dt><dd>true, if this stream is a bzip2 compressed stream, false otherwise</dd><dt><span class="strong">Since:</span></dt>
  492. <dd>1.1</dd></dl>
  493. </li>
  494. </ul>
  495. </li>
  496. </ul>
  497. </li>
  498. </ul>
  499. </div>
  500. </div>
  501. <!-- ========= END OF CLASS DATA ========= -->
  502. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  503. <div class="bottomNav"><a name="navbar_bottom">
  504. <!-- -->
  505. </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
  506. <!-- -->
  507. </a>
  508. <ul class="navList" title="Navigation">
  509. <li><a href="../../../../../../overview-summary.html">Overview</a></li>
  510. <li><a href="package-summary.html">Package</a></li>
  511. <li class="navBarCell1Rev">Class</li>
  512. <li><a href="class-use/BZip2CompressorInputStream.html">Use</a></li>
  513. <li><a href="package-tree.html">Tree</a></li>
  514. <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
  515. <li><a href="../../../../../../index-all.html">Index</a></li>
  516. <li><a href="../../../../../../help-doc.html">Help</a></li>
  517. </ul>
  518. </div>
  519. <div class="subNav">
  520. <ul class="navList">
  521. <li>Prev Class</li>
  522. <li><a href="../../../../../../org/apache/commons/compress/compressors/bzip2/BZip2CompressorOutputStream.html" title="class in org.apache.commons.compress.compressors.bzip2"><span class="strong">Next Class</span></a></li>
  523. </ul>
  524. <ul class="navList">
  525. <li><a href="../../../../../../index.html?org/apache/commons/compress/compressors/bzip2/BZip2CompressorInputStream.html" target="_top">Frames</a></li>
  526. <li><a href="BZip2CompressorInputStream.html" target="_top">No Frames</a></li>
  527. </ul>
  528. <ul class="navList" id="allclasses_navbar_bottom">
  529. <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
  530. </ul>
  531. <div>
  532. <script type="text/javascript"><!--
  533. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  534. if(window==top) {
  535. allClassesLink.style.display = "block";
  536. }
  537. else {
  538. allClassesLink.style.display = "none";
  539. }
  540. //-->
  541. </script>
  542. </div>
  543. <div>
  544. <ul class="subNavList">
  545. <li>Summary:&nbsp;</li>
  546. <li>Nested&nbsp;|&nbsp;</li>
  547. <li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
  548. <li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
  549. <li><a href="#method_summary">Method</a></li>
  550. </ul>
  551. <ul class="subNavList">
  552. <li>Detail:&nbsp;</li>
  553. <li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li>
  554. <li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
  555. <li><a href="#method_detail">Method</a></li>
  556. </ul>
  557. </div>
  558. <a name="skip-navbar_bottom">
  559. <!-- -->
  560. </a></div>
  561. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  562. <p class="legalCopy"><small>Copyright &#169; 2016 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
  563. </body>
  564. </html>