ArchiveInputStream.html 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450
  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>ArchiveInputStream (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="ArchiveInputStream (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/ArchiveInputStream.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/archivers/ArchiveException.html" title="class in org.apache.commons.compress.archivers"><span class="strong">Prev Class</span></a></li>
  43. <li><a href="../../../../../org/apache/commons/compress/archivers/ArchiveOutputStream.html" title="class in org.apache.commons.compress.archivers"><span class="strong">Next Class</span></a></li>
  44. </ul>
  45. <ul class="navList">
  46. <li><a href="../../../../../index.html?org/apache/commons/compress/archivers/ArchiveInputStream.html" target="_top">Frames</a></li>
  47. <li><a href="ArchiveInputStream.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.archivers</div>
  86. <h2 title="Class ArchiveInputStream" class="title">Class ArchiveInputStream</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.archivers.ArchiveInputStream</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/archivers/ar/ArArchiveInputStream.html" title="class in org.apache.commons.compress.archivers.ar">ArArchiveInputStream</a>, <a href="../../../../../org/apache/commons/compress/archivers/arj/ArjArchiveInputStream.html" title="class in org.apache.commons.compress.archivers.arj">ArjArchiveInputStream</a>, <a href="../../../../../org/apache/commons/compress/archivers/cpio/CpioArchiveInputStream.html" title="class in org.apache.commons.compress.archivers.cpio">CpioArchiveInputStream</a>, <a href="../../../../../org/apache/commons/compress/archivers/dump/DumpArchiveInputStream.html" title="class in org.apache.commons.compress.archivers.dump">DumpArchiveInputStream</a>, <a href="../../../../../org/apache/commons/compress/archivers/tar/TarArchiveInputStream.html" title="class in org.apache.commons.compress.archivers.tar">TarArchiveInputStream</a>, <a href="../../../../../org/apache/commons/compress/archivers/zip/ZipArchiveInputStream.html" title="class in org.apache.commons.compress.archivers.zip">ZipArchiveInputStream</a></dd>
  112. </dl>
  113. <hr>
  114. <br>
  115. <pre>public abstract class <a href="../../../../../src-html/org/apache/commons/compress/archivers/ArchiveInputStream.html#line.40">ArchiveInputStream</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. <div class="block">Archive input streams <b>MUST</b> override the
  118. <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"><code>InputStream.read(byte[], int, int)</code></a> - or <a href="../../../../../org/apache/commons/compress/archivers/ArchiveInputStream.html#read()"><code>read()</code></a> -
  119. method so that reading from the stream generates EOF for the end of
  120. data in each entry as well as at the end of the file proper.
  121. <p>
  122. The <a href="../../../../../org/apache/commons/compress/archivers/ArchiveInputStream.html#getNextEntry()"><code>getNextEntry()</code></a> method is used to reset the input stream
  123. ready for reading the data from the next entry.
  124. <p>
  125. The input stream classes must also implement a method with the signature:
  126. <pre>
  127. public static boolean matches(byte[] signature, int length)
  128. </pre>
  129. which is used by the <a href="../../../../../org/apache/commons/compress/archivers/ArchiveStreamFactory.html" title="class in org.apache.commons.compress.archivers"><code>ArchiveStreamFactory</code></a> to autodetect
  130. the archive type from the first few bytes of a stream.</div>
  131. </li>
  132. </ul>
  133. </div>
  134. <div class="summary">
  135. <ul class="blockList">
  136. <li class="blockList">
  137. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  138. <ul class="blockList">
  139. <li class="blockList"><a name="constructor_summary">
  140. <!-- -->
  141. </a>
  142. <h3>Constructor Summary</h3>
  143. <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  144. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  145. <tr>
  146. <th class="colOne" scope="col">Constructor and Description</th>
  147. </tr>
  148. <tr class="altColor">
  149. <td class="colOne"><code><strong><a href="../../../../../org/apache/commons/compress/archivers/ArchiveInputStream.html#ArchiveInputStream()">ArchiveInputStream</a></strong>()</code>&nbsp;</td>
  150. </tr>
  151. </table>
  152. </li>
  153. </ul>
  154. <!-- ========== METHOD SUMMARY =========== -->
  155. <ul class="blockList">
  156. <li class="blockList"><a name="method_summary">
  157. <!-- -->
  158. </a>
  159. <h3>Method Summary</h3>
  160. <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  161. <caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
  162. <tr>
  163. <th class="colFirst" scope="col">Modifier and Type</th>
  164. <th class="colLast" scope="col">Method and Description</th>
  165. </tr>
  166. <tr class="altColor">
  167. <td class="colFirst"><code>boolean</code></td>
  168. <td class="colLast"><code><strong><a href="../../../../../org/apache/commons/compress/archivers/ArchiveInputStream.html#canReadEntryData(org.apache.commons.compress.archivers.ArchiveEntry)">canReadEntryData</a></strong>(<a href="../../../../../org/apache/commons/compress/archivers/ArchiveEntry.html" title="interface in org.apache.commons.compress.archivers">ArchiveEntry</a>&nbsp;archiveEntry)</code>
  169. <div class="block">Whether this stream is able to read the given entry.</div>
  170. </td>
  171. </tr>
  172. <tr class="rowColor">
  173. <td class="colFirst"><code>protected void</code></td>
  174. <td class="colLast"><code><strong><a href="../../../../../org/apache/commons/compress/archivers/ArchiveInputStream.html#count(int)">count</a></strong>(int&nbsp;read)</code>
  175. <div class="block">Increments the counter of already read bytes.</div>
  176. </td>
  177. </tr>
  178. <tr class="altColor">
  179. <td class="colFirst"><code>protected void</code></td>
  180. <td class="colLast"><code><strong><a href="../../../../../org/apache/commons/compress/archivers/ArchiveInputStream.html#count(long)">count</a></strong>(long&nbsp;read)</code>
  181. <div class="block">Increments the counter of already read bytes.</div>
  182. </td>
  183. </tr>
  184. <tr class="rowColor">
  185. <td class="colFirst"><code>long</code></td>
  186. <td class="colLast"><code><strong><a href="../../../../../org/apache/commons/compress/archivers/ArchiveInputStream.html#getBytesRead()">getBytesRead</a></strong>()</code>
  187. <div class="block">Returns the current number of bytes read from this stream.</div>
  188. </td>
  189. </tr>
  190. <tr class="altColor">
  191. <td class="colFirst"><code>int</code></td>
  192. <td class="colLast"><code><strong><a href="../../../../../org/apache/commons/compress/archivers/ArchiveInputStream.html#getCount()">getCount</a></strong>()</code>
  193. <div class="block"><strong>Deprecated.</strong>&nbsp;
  194. <div class="block"><i>this method may yield wrong results for large
  195. archives, use #getBytesRead instead</i></div>
  196. </div>
  197. </td>
  198. </tr>
  199. <tr class="rowColor">
  200. <td class="colFirst"><code>abstract <a href="../../../../../org/apache/commons/compress/archivers/ArchiveEntry.html" title="interface in org.apache.commons.compress.archivers">ArchiveEntry</a></code></td>
  201. <td class="colLast"><code><strong><a href="../../../../../org/apache/commons/compress/archivers/ArchiveInputStream.html#getNextEntry()">getNextEntry</a></strong>()</code>
  202. <div class="block">Returns the next Archive Entry in this Stream.</div>
  203. </td>
  204. </tr>
  205. <tr class="altColor">
  206. <td class="colFirst"><code>protected void</code></td>
  207. <td class="colLast"><code><strong><a href="../../../../../org/apache/commons/compress/archivers/ArchiveInputStream.html#pushedBackBytes(long)">pushedBackBytes</a></strong>(long&nbsp;pushedBack)</code>
  208. <div class="block">Decrements the counter of already read bytes.</div>
  209. </td>
  210. </tr>
  211. <tr class="rowColor">
  212. <td class="colFirst"><code>int</code></td>
  213. <td class="colLast"><code><strong><a href="../../../../../org/apache/commons/compress/archivers/ArchiveInputStream.html#read()">read</a></strong>()</code>
  214. <div class="block">Reads a byte of data.</div>
  215. </td>
  216. </tr>
  217. </table>
  218. <ul class="blockList">
  219. <li class="blockList"><a name="methods_inherited_from_class_java.io.InputStream">
  220. <!-- -->
  221. </a>
  222. <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>
  223. <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(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>
  224. </ul>
  225. <ul class="blockList">
  226. <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
  227. <!-- -->
  228. </a>
  229. <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>
  230. <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>
  231. </ul>
  232. </li>
  233. </ul>
  234. </li>
  235. </ul>
  236. </div>
  237. <div class="details">
  238. <ul class="blockList">
  239. <li class="blockList">
  240. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  241. <ul class="blockList">
  242. <li class="blockList"><a name="constructor_detail">
  243. <!-- -->
  244. </a>
  245. <h3>Constructor Detail</h3>
  246. <a name="ArchiveInputStream()">
  247. <!-- -->
  248. </a>
  249. <ul class="blockListLast">
  250. <li class="blockList">
  251. <h4>ArchiveInputStream</h4>
  252. <pre>public&nbsp;<a href="../../../../../src-html/org/apache/commons/compress/archivers/ArchiveInputStream.html#line.40">ArchiveInputStream</a>()</pre>
  253. </li>
  254. </ul>
  255. </li>
  256. </ul>
  257. <!-- ============ METHOD DETAIL ========== -->
  258. <ul class="blockList">
  259. <li class="blockList"><a name="method_detail">
  260. <!-- -->
  261. </a>
  262. <h3>Method Detail</h3>
  263. <a name="getNextEntry()">
  264. <!-- -->
  265. </a>
  266. <ul class="blockList">
  267. <li class="blockList">
  268. <h4>getNextEntry</h4>
  269. <pre>public abstract&nbsp;<a href="../../../../../org/apache/commons/compress/archivers/ArchiveEntry.html" title="interface in org.apache.commons.compress.archivers">ArchiveEntry</a>&nbsp;<a href="../../../../../src-html/org/apache/commons/compress/archivers/ArchiveInputStream.html#line.55">getNextEntry</a>()
  270. 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>
  271. <div class="block">Returns the next Archive Entry in this Stream.</div>
  272. <dl><dt><span class="strong">Returns:</span></dt><dd>the next entry,
  273. or <code>null</code> if there are no more entries</dd>
  274. <dt><span class="strong">Throws:</span></dt>
  275. <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 next entry could not be read</dd></dl>
  276. </li>
  277. </ul>
  278. <a name="read()">
  279. <!-- -->
  280. </a>
  281. <ul class="blockList">
  282. <li class="blockList">
  283. <h4>read</h4>
  284. <pre>public&nbsp;int&nbsp;<a href="../../../../../src-html/org/apache/commons/compress/archivers/ArchiveInputStream.html#line.80">read</a>()
  285. 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>
  286. <div class="block">Reads a byte of data. This method will block until enough input is
  287. available.
  288. Simply calls the <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"><code>InputStream.read(byte[], int, int)</code></a> method.
  289. MUST be overridden if the <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"><code>InputStream.read(byte[], int, int)</code></a> method
  290. is not overridden; may be overridden otherwise.</div>
  291. <dl>
  292. <dt><strong>Specified by:</strong></dt>
  293. <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>
  294. <dt><span class="strong">Returns:</span></dt><dd>the byte read, or -1 if end of input is reached</dd>
  295. <dt><span class="strong">Throws:</span></dt>
  296. <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 has occurred</dd></dl>
  297. </li>
  298. </ul>
  299. <a name="count(int)">
  300. <!-- -->
  301. </a>
  302. <ul class="blockList">
  303. <li class="blockList">
  304. <h4>count</h4>
  305. <pre>protected&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/commons/compress/archivers/ArchiveInputStream.html#line.91">count</a>(int&nbsp;read)</pre>
  306. <div class="block">Increments the counter of already read bytes.
  307. Doesn't increment if the EOF has been hit (read == -1)</div>
  308. <dl><dt><span class="strong">Parameters:</span></dt><dd><code>read</code> - the number of bytes read</dd></dl>
  309. </li>
  310. </ul>
  311. <a name="count(long)">
  312. <!-- -->
  313. </a>
  314. <ul class="blockList">
  315. <li class="blockList">
  316. <h4>count</h4>
  317. <pre>protected&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/commons/compress/archivers/ArchiveInputStream.html#line.102">count</a>(long&nbsp;read)</pre>
  318. <div class="block">Increments the counter of already read bytes.
  319. Doesn't increment if the EOF has been hit (read == -1)</div>
  320. <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>
  321. <dd>1.1</dd></dl>
  322. </li>
  323. </ul>
  324. <a name="pushedBackBytes(long)">
  325. <!-- -->
  326. </a>
  327. <ul class="blockList">
  328. <li class="blockList">
  329. <h4>pushedBackBytes</h4>
  330. <pre>protected&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/commons/compress/archivers/ArchiveInputStream.html#line.114">pushedBackBytes</a>(long&nbsp;pushedBack)</pre>
  331. <div class="block">Decrements the counter of already read bytes.</div>
  332. <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>
  333. <dd>1.1</dd></dl>
  334. </li>
  335. </ul>
  336. <a name="getCount()">
  337. <!-- -->
  338. </a>
  339. <ul class="blockList">
  340. <li class="blockList">
  341. <h4>getCount</h4>
  342. <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>
  343. public&nbsp;int&nbsp;<a href="../../../../../src-html/org/apache/commons/compress/archivers/ArchiveInputStream.html#line.125">getCount</a>()</pre>
  344. <div class="block"><span class="strong">Deprecated.</span>&nbsp;<i>this method may yield wrong results for large
  345. archives, use #getBytesRead instead</i></div>
  346. <div class="block">Returns the current number of bytes read from this stream.</div>
  347. <dl><dt><span class="strong">Returns:</span></dt><dd>the number of read bytes</dd></dl>
  348. </li>
  349. </ul>
  350. <a name="getBytesRead()">
  351. <!-- -->
  352. </a>
  353. <ul class="blockList">
  354. <li class="blockList">
  355. <h4>getBytesRead</h4>
  356. <pre>public&nbsp;long&nbsp;<a href="../../../../../src-html/org/apache/commons/compress/archivers/ArchiveInputStream.html#line.134">getBytesRead</a>()</pre>
  357. <div class="block">Returns the current number of bytes read from this stream.</div>
  358. <dl><dt><span class="strong">Returns:</span></dt><dd>the number of read bytes</dd><dt><span class="strong">Since:</span></dt>
  359. <dd>1.1</dd></dl>
  360. </li>
  361. </ul>
  362. <a name="canReadEntryData(org.apache.commons.compress.archivers.ArchiveEntry)">
  363. <!-- -->
  364. </a>
  365. <ul class="blockListLast">
  366. <li class="blockList">
  367. <h4>canReadEntryData</h4>
  368. <pre>public&nbsp;boolean&nbsp;<a href="../../../../../src-html/org/apache/commons/compress/archivers/ArchiveInputStream.html#line.151">canReadEntryData</a>(<a href="../../../../../org/apache/commons/compress/archivers/ArchiveEntry.html" title="interface in org.apache.commons.compress.archivers">ArchiveEntry</a>&nbsp;archiveEntry)</pre>
  369. <div class="block">Whether this stream is able to read the given entry.
  370. <p>
  371. Some archive formats support variants or details that are not supported (yet).
  372. </p></div>
  373. <dl><dt><span class="strong">Parameters:</span></dt><dd><code>archiveEntry</code> - the entry to test</dd>
  374. <dt><span class="strong">Returns:</span></dt><dd>This implementation always returns true.</dd><dt><span class="strong">Since:</span></dt>
  375. <dd>1.1</dd></dl>
  376. </li>
  377. </ul>
  378. </li>
  379. </ul>
  380. </li>
  381. </ul>
  382. </div>
  383. </div>
  384. <!-- ========= END OF CLASS DATA ========= -->
  385. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  386. <div class="bottomNav"><a name="navbar_bottom">
  387. <!-- -->
  388. </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
  389. <!-- -->
  390. </a>
  391. <ul class="navList" title="Navigation">
  392. <li><a href="../../../../../overview-summary.html">Overview</a></li>
  393. <li><a href="package-summary.html">Package</a></li>
  394. <li class="navBarCell1Rev">Class</li>
  395. <li><a href="class-use/ArchiveInputStream.html">Use</a></li>
  396. <li><a href="package-tree.html">Tree</a></li>
  397. <li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
  398. <li><a href="../../../../../index-all.html">Index</a></li>
  399. <li><a href="../../../../../help-doc.html">Help</a></li>
  400. </ul>
  401. </div>
  402. <div class="subNav">
  403. <ul class="navList">
  404. <li><a href="../../../../../org/apache/commons/compress/archivers/ArchiveException.html" title="class in org.apache.commons.compress.archivers"><span class="strong">Prev Class</span></a></li>
  405. <li><a href="../../../../../org/apache/commons/compress/archivers/ArchiveOutputStream.html" title="class in org.apache.commons.compress.archivers"><span class="strong">Next Class</span></a></li>
  406. </ul>
  407. <ul class="navList">
  408. <li><a href="../../../../../index.html?org/apache/commons/compress/archivers/ArchiveInputStream.html" target="_top">Frames</a></li>
  409. <li><a href="ArchiveInputStream.html" target="_top">No Frames</a></li>
  410. </ul>
  411. <ul class="navList" id="allclasses_navbar_bottom">
  412. <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
  413. </ul>
  414. <div>
  415. <script type="text/javascript"><!--
  416. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  417. if(window==top) {
  418. allClassesLink.style.display = "block";
  419. }
  420. else {
  421. allClassesLink.style.display = "none";
  422. }
  423. //-->
  424. </script>
  425. </div>
  426. <div>
  427. <ul class="subNavList">
  428. <li>Summary:&nbsp;</li>
  429. <li>Nested&nbsp;|&nbsp;</li>
  430. <li>Field&nbsp;|&nbsp;</li>
  431. <li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
  432. <li><a href="#method_summary">Method</a></li>
  433. </ul>
  434. <ul class="subNavList">
  435. <li>Detail:&nbsp;</li>
  436. <li>Field&nbsp;|&nbsp;</li>
  437. <li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
  438. <li><a href="#method_detail">Method</a></li>
  439. </ul>
  440. </div>
  441. <a name="skip-navbar_bottom">
  442. <!-- -->
  443. </a></div>
  444. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  445. <p class="legalCopy"><small>Copyright &#169; 2016 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
  446. </body>
  447. </html>