ZipArchiveInputStream.html 35 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547
  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>ZipArchiveInputStream (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="ZipArchiveInputStream (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/ZipArchiveInputStream.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/zip/ZipArchiveEntryRequestSupplier.html" title="interface in org.apache.commons.compress.archivers.zip"><span class="strong">Prev Class</span></a></li>
  43. <li><a href="../../../../../../org/apache/commons/compress/archivers/zip/ZipArchiveOutputStream.html" title="class in org.apache.commons.compress.archivers.zip"><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/zip/ZipArchiveInputStream.html" target="_top">Frames</a></li>
  47. <li><a href="ZipArchiveInputStream.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.zip</div>
  86. <h2 title="Class ZipArchiveInputStream" class="title">Class ZipArchiveInputStream</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/archivers/ArchiveInputStream.html" title="class in org.apache.commons.compress.archivers">org.apache.commons.compress.archivers.ArchiveInputStream</a></li>
  97. <li>
  98. <ul class="inheritance">
  99. <li>org.apache.commons.compress.archivers.zip.ZipArchiveInputStream</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. <dl>
  115. <dt>Direct Known Subclasses:</dt>
  116. <dd><a href="../../../../../../org/apache/commons/compress/archivers/jar/JarArchiveInputStream.html" title="class in org.apache.commons.compress.archivers.jar">JarArchiveInputStream</a></dd>
  117. </dl>
  118. <hr>
  119. <br>
  120. <pre>public class <a href="../../../../../../src-html/org/apache/commons/compress/archivers/zip/ZipArchiveInputStream.html#line.77">ZipArchiveInputStream</a>
  121. extends <a href="../../../../../../org/apache/commons/compress/archivers/ArchiveInputStream.html" title="class in org.apache.commons.compress.archivers">ArchiveInputStream</a></pre>
  122. <div class="block">Implements an input stream that can read Zip archives.
  123. <p>As of Apache Commons Compress it transparently supports Zip64
  124. extensions and thus individual entries and archives larger than 4
  125. GB or with more than 65536 entries.</p>
  126. <p>The <a href="../../../../../../org/apache/commons/compress/archivers/zip/ZipFile.html" title="class in org.apache.commons.compress.archivers.zip"><code>ZipFile</code></a> class is preferred when reading from files
  127. as <a href="../../../../../../org/apache/commons/compress/archivers/zip/ZipArchiveInputStream.html" title="class in org.apache.commons.compress.archivers.zip"><code>ZipArchiveInputStream</code></a> is limited by not being able to
  128. read the central directory header before returning entries. In
  129. particular <a href="../../../../../../org/apache/commons/compress/archivers/zip/ZipArchiveInputStream.html" title="class in org.apache.commons.compress.archivers.zip"><code>ZipArchiveInputStream</code></a></p>
  130. <ul>
  131. <li>may return entries that are not part of the central directory
  132. at all and shouldn't be considered part of the archive.</li>
  133. <li>may return several entries with the same name.</li>
  134. <li>will not return internal or external attributes.</li>
  135. <li>may return incomplete extra field data.</li>
  136. <li>may return unknown sizes and CRC values for entries until the
  137. next entry has been reached if the archive uses the data
  138. descriptor feature.</li>
  139. </ul></div>
  140. <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../org/apache/commons/compress/archivers/zip/ZipFile.html" title="class in org.apache.commons.compress.archivers.zip"><code>ZipFile</code></a></dd><dt><span class="strong">This class is not thread-safe</span></dt>
  141. <dd></dd></dl>
  142. </li>
  143. </ul>
  144. </div>
  145. <div class="summary">
  146. <ul class="blockList">
  147. <li class="blockList">
  148. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  149. <ul class="blockList">
  150. <li class="blockList"><a name="constructor_summary">
  151. <!-- -->
  152. </a>
  153. <h3>Constructor Summary</h3>
  154. <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  155. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  156. <tr>
  157. <th class="colOne" scope="col">Constructor and Description</th>
  158. </tr>
  159. <tr class="altColor">
  160. <td class="colOne"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/zip/ZipArchiveInputStream.html#ZipArchiveInputStream(java.io.InputStream)">ZipArchiveInputStream</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;inputStream)</code>
  161. <div class="block">Create an instance using UTF-8 encoding</div>
  162. </td>
  163. </tr>
  164. <tr class="rowColor">
  165. <td class="colOne"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/zip/ZipArchiveInputStream.html#ZipArchiveInputStream(java.io.InputStream,%20java.lang.String)">ZipArchiveInputStream</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;inputStream,
  166. <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;encoding)</code>
  167. <div class="block">Create an instance using the specified encoding</div>
  168. </td>
  169. </tr>
  170. <tr class="altColor">
  171. <td class="colOne"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/zip/ZipArchiveInputStream.html#ZipArchiveInputStream(java.io.InputStream,%20java.lang.String,%20boolean)">ZipArchiveInputStream</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;inputStream,
  172. <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;encoding,
  173. boolean&nbsp;useUnicodeExtraFields)</code>
  174. <div class="block">Create an instance using the specified encoding</div>
  175. </td>
  176. </tr>
  177. <tr class="rowColor">
  178. <td class="colOne"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/zip/ZipArchiveInputStream.html#ZipArchiveInputStream(java.io.InputStream,%20java.lang.String,%20boolean,%20boolean)">ZipArchiveInputStream</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;inputStream,
  179. <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;encoding,
  180. boolean&nbsp;useUnicodeExtraFields,
  181. boolean&nbsp;allowStoredEntriesWithDataDescriptor)</code>
  182. <div class="block">Create an instance using the specified encoding</div>
  183. </td>
  184. </tr>
  185. </table>
  186. </li>
  187. </ul>
  188. <!-- ========== METHOD SUMMARY =========== -->
  189. <ul class="blockList">
  190. <li class="blockList"><a name="method_summary">
  191. <!-- -->
  192. </a>
  193. <h3>Method Summary</h3>
  194. <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  195. <caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
  196. <tr>
  197. <th class="colFirst" scope="col">Modifier and Type</th>
  198. <th class="colLast" scope="col">Method and Description</th>
  199. </tr>
  200. <tr class="altColor">
  201. <td class="colFirst"><code>boolean</code></td>
  202. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/zip/ZipArchiveInputStream.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;ae)</code>
  203. <div class="block">Whether this class is able to read the given entry.</div>
  204. </td>
  205. </tr>
  206. <tr class="rowColor">
  207. <td class="colFirst"><code>void</code></td>
  208. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/zip/ZipArchiveInputStream.html#close()">close</a></strong>()</code>&nbsp;</td>
  209. </tr>
  210. <tr class="altColor">
  211. <td class="colFirst"><code><a href="../../../../../../org/apache/commons/compress/archivers/ArchiveEntry.html" title="interface in org.apache.commons.compress.archivers">ArchiveEntry</a></code></td>
  212. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/zip/ZipArchiveInputStream.html#getNextEntry()">getNextEntry</a></strong>()</code>
  213. <div class="block">Returns the next Archive Entry in this Stream.</div>
  214. </td>
  215. </tr>
  216. <tr class="rowColor">
  217. <td class="colFirst"><code><a href="../../../../../../org/apache/commons/compress/archivers/zip/ZipArchiveEntry.html" title="class in org.apache.commons.compress.archivers.zip">ZipArchiveEntry</a></code></td>
  218. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/zip/ZipArchiveInputStream.html#getNextZipEntry()">getNextZipEntry</a></strong>()</code>&nbsp;</td>
  219. </tr>
  220. <tr class="altColor">
  221. <td class="colFirst"><code>static boolean</code></td>
  222. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/zip/ZipArchiveInputStream.html#matches(byte[],%20int)">matches</a></strong>(byte[]&nbsp;signature,
  223. int&nbsp;length)</code>
  224. <div class="block">Checks if the signature matches what is expected for a zip file.</div>
  225. </td>
  226. </tr>
  227. <tr class="rowColor">
  228. <td class="colFirst"><code>int</code></td>
  229. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/zip/ZipArchiveInputStream.html#read(byte[],%20int,%20int)">read</a></strong>(byte[]&nbsp;buffer,
  230. int&nbsp;offset,
  231. int&nbsp;length)</code>&nbsp;</td>
  232. </tr>
  233. <tr class="altColor">
  234. <td class="colFirst"><code>long</code></td>
  235. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/zip/ZipArchiveInputStream.html#skip(long)">skip</a></strong>(long&nbsp;value)</code>
  236. <div class="block">Skips over and discards value bytes of data from this input
  237. stream.</div>
  238. </td>
  239. </tr>
  240. </table>
  241. <ul class="blockList">
  242. <li class="blockList"><a name="methods_inherited_from_class_org.apache.commons.compress.archivers.ArchiveInputStream">
  243. <!-- -->
  244. </a>
  245. <h3>Methods inherited from class&nbsp;org.apache.commons.compress.archivers.<a href="../../../../../../org/apache/commons/compress/archivers/ArchiveInputStream.html" title="class in org.apache.commons.compress.archivers">ArchiveInputStream</a></h3>
  246. <code><a href="../../../../../../org/apache/commons/compress/archivers/ArchiveInputStream.html#count(int)">count</a>, <a href="../../../../../../org/apache/commons/compress/archivers/ArchiveInputStream.html#count(long)">count</a>, <a href="../../../../../../org/apache/commons/compress/archivers/ArchiveInputStream.html#getBytesRead()">getBytesRead</a>, <a href="../../../../../../org/apache/commons/compress/archivers/ArchiveInputStream.html#getCount()">getCount</a>, <a href="../../../../../../org/apache/commons/compress/archivers/ArchiveInputStream.html#pushedBackBytes(long)">pushedBackBytes</a>, <a href="../../../../../../org/apache/commons/compress/archivers/ArchiveInputStream.html#read()">read</a></code></li>
  247. </ul>
  248. <ul class="blockList">
  249. <li class="blockList"><a name="methods_inherited_from_class_java.io.InputStream">
  250. <!-- -->
  251. </a>
  252. <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>
  253. <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></code></li>
  254. </ul>
  255. <ul class="blockList">
  256. <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
  257. <!-- -->
  258. </a>
  259. <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>
  260. <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>
  261. </ul>
  262. </li>
  263. </ul>
  264. </li>
  265. </ul>
  266. </div>
  267. <div class="details">
  268. <ul class="blockList">
  269. <li class="blockList">
  270. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  271. <ul class="blockList">
  272. <li class="blockList"><a name="constructor_detail">
  273. <!-- -->
  274. </a>
  275. <h3>Constructor Detail</h3>
  276. <a name="ZipArchiveInputStream(java.io.InputStream)">
  277. <!-- -->
  278. </a>
  279. <ul class="blockList">
  280. <li class="blockList">
  281. <h4>ZipArchiveInputStream</h4>
  282. <pre>public&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/zip/ZipArchiveInputStream.html#line.167">ZipArchiveInputStream</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;inputStream)</pre>
  283. <div class="block">Create an instance using UTF-8 encoding</div>
  284. <dl><dt><span class="strong">Parameters:</span></dt><dd><code>inputStream</code> - the stream to wrap</dd></dl>
  285. </li>
  286. </ul>
  287. <a name="ZipArchiveInputStream(java.io.InputStream, java.lang.String)">
  288. <!-- -->
  289. </a>
  290. <ul class="blockList">
  291. <li class="blockList">
  292. <h4>ZipArchiveInputStream</h4>
  293. <pre>public&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/zip/ZipArchiveInputStream.html#line.178">ZipArchiveInputStream</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;inputStream,
  294. <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;encoding)</pre>
  295. <div class="block">Create an instance using the specified encoding</div>
  296. <dl><dt><span class="strong">Parameters:</span></dt><dd><code>inputStream</code> - the stream to wrap</dd><dd><code>encoding</code> - the encoding to use for file names, use null
  297. for the platform's default encoding</dd><dt><span class="strong">Since:</span></dt>
  298. <dd>1.5</dd></dl>
  299. </li>
  300. </ul>
  301. <a name="ZipArchiveInputStream(java.io.InputStream, java.lang.String, boolean)">
  302. <!-- -->
  303. </a>
  304. <ul class="blockList">
  305. <li class="blockList">
  306. <h4>ZipArchiveInputStream</h4>
  307. <pre>public&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/zip/ZipArchiveInputStream.html#line.190">ZipArchiveInputStream</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;inputStream,
  308. <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;encoding,
  309. boolean&nbsp;useUnicodeExtraFields)</pre>
  310. <div class="block">Create an instance using the specified encoding</div>
  311. <dl><dt><span class="strong">Parameters:</span></dt><dd><code>inputStream</code> - the stream to wrap</dd><dd><code>encoding</code> - the encoding to use for file names, use null
  312. for the platform's default encoding</dd><dd><code>useUnicodeExtraFields</code> - whether to use InfoZIP Unicode
  313. Extra Fields (if present) to set the file names.</dd></dl>
  314. </li>
  315. </ul>
  316. <a name="ZipArchiveInputStream(java.io.InputStream, java.lang.String, boolean, boolean)">
  317. <!-- -->
  318. </a>
  319. <ul class="blockListLast">
  320. <li class="blockList">
  321. <h4>ZipArchiveInputStream</h4>
  322. <pre>public&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/zip/ZipArchiveInputStream.html#line.205">ZipArchiveInputStream</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;inputStream,
  323. <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;encoding,
  324. boolean&nbsp;useUnicodeExtraFields,
  325. boolean&nbsp;allowStoredEntriesWithDataDescriptor)</pre>
  326. <div class="block">Create an instance using the specified encoding</div>
  327. <dl><dt><span class="strong">Parameters:</span></dt><dd><code>inputStream</code> - the stream to wrap</dd><dd><code>encoding</code> - the encoding to use for file names, use null
  328. for the platform's default encoding</dd><dd><code>useUnicodeExtraFields</code> - whether to use InfoZIP Unicode
  329. Extra Fields (if present) to set the file names.</dd><dd><code>allowStoredEntriesWithDataDescriptor</code> - whether the stream
  330. will try to read STORED entries that use a data descriptor</dd><dt><span class="strong">Since:</span></dt>
  331. <dd>1.1</dd></dl>
  332. </li>
  333. </ul>
  334. </li>
  335. </ul>
  336. <!-- ============ METHOD DETAIL ========== -->
  337. <ul class="blockList">
  338. <li class="blockList"><a name="method_detail">
  339. <!-- -->
  340. </a>
  341. <h3>Method Detail</h3>
  342. <a name="getNextZipEntry()">
  343. <!-- -->
  344. </a>
  345. <ul class="blockList">
  346. <li class="blockList">
  347. <h4>getNextZipEntry</h4>
  348. <pre>public&nbsp;<a href="../../../../../../org/apache/commons/compress/archivers/zip/ZipArchiveEntry.html" title="class in org.apache.commons.compress.archivers.zip">ZipArchiveEntry</a>&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/zip/ZipArchiveInputStream.html#line.219">getNextZipEntry</a>()
  349. 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>
  350. <dl><dt><span class="strong">Throws:</span></dt>
  351. <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>
  352. </li>
  353. </ul>
  354. <a name="getNextEntry()">
  355. <!-- -->
  356. </a>
  357. <ul class="blockList">
  358. <li class="blockList">
  359. <h4>getNextEntry</h4>
  360. <pre>public&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/zip/ZipArchiveInputStream.html#line.372">getNextEntry</a>()
  361. 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>
  362. <div class="block"><strong>Description copied from class:&nbsp;<code><a href="../../../../../../org/apache/commons/compress/archivers/ArchiveInputStream.html#getNextEntry()">ArchiveInputStream</a></code></strong></div>
  363. <div class="block">Returns the next Archive Entry in this Stream.</div>
  364. <dl>
  365. <dt><strong>Specified by:</strong></dt>
  366. <dd><code><a href="../../../../../../org/apache/commons/compress/archivers/ArchiveInputStream.html#getNextEntry()">getNextEntry</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../org/apache/commons/compress/archivers/ArchiveInputStream.html" title="class in org.apache.commons.compress.archivers">ArchiveInputStream</a></code></dd>
  367. <dt><span class="strong">Returns:</span></dt><dd>the next entry,
  368. or <code>null</code> if there are no more entries</dd>
  369. <dt><span class="strong">Throws:</span></dt>
  370. <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>
  371. </li>
  372. </ul>
  373. <a name="canReadEntryData(org.apache.commons.compress.archivers.ArchiveEntry)">
  374. <!-- -->
  375. </a>
  376. <ul class="blockList">
  377. <li class="blockList">
  378. <h4>canReadEntryData</h4>
  379. <pre>public&nbsp;boolean&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/zip/ZipArchiveInputStream.html#line.384">canReadEntryData</a>(<a href="../../../../../../org/apache/commons/compress/archivers/ArchiveEntry.html" title="interface in org.apache.commons.compress.archivers">ArchiveEntry</a>&nbsp;ae)</pre>
  380. <div class="block">Whether this class is able to read the given entry.
  381. <p>May return false if it is set up to use encryption or a
  382. compression method that hasn't been implemented yet.</p></div>
  383. <dl>
  384. <dt><strong>Overrides:</strong></dt>
  385. <dd><code><a href="../../../../../../org/apache/commons/compress/archivers/ArchiveInputStream.html#canReadEntryData(org.apache.commons.compress.archivers.ArchiveEntry)">canReadEntryData</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../org/apache/commons/compress/archivers/ArchiveInputStream.html" title="class in org.apache.commons.compress.archivers">ArchiveInputStream</a></code></dd>
  386. <dt><span class="strong">Parameters:</span></dt><dd><code>ae</code> - the entry to test</dd>
  387. <dt><span class="strong">Returns:</span></dt><dd>This implementation always returns true.</dd><dt><span class="strong">Since:</span></dt>
  388. <dd>1.1</dd></dl>
  389. </li>
  390. </ul>
  391. <a name="read(byte[], int, int)">
  392. <!-- -->
  393. </a>
  394. <ul class="blockList">
  395. <li class="blockList">
  396. <h4>read</h4>
  397. <pre>public&nbsp;int&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/zip/ZipArchiveInputStream.html#line.395">read</a>(byte[]&nbsp;buffer,
  398. int&nbsp;offset,
  399. int&nbsp;length)
  400. 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>
  401. <dl>
  402. <dt><strong>Overrides:</strong></dt>
  403. <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>
  404. <dt><span class="strong">Throws:</span></dt>
  405. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd></dl>
  406. </li>
  407. </ul>
  408. <a name="close()">
  409. <!-- -->
  410. </a>
  411. <ul class="blockList">
  412. <li class="blockList">
  413. <h4>close</h4>
  414. <pre>public&nbsp;void&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/zip/ZipArchiveInputStream.html#line.521">close</a>()
  415. 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>
  416. <dl>
  417. <dt><strong>Specified by:</strong></dt>
  418. <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>
  419. <dt><strong>Specified by:</strong></dt>
  420. <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>
  421. <dt><strong>Overrides:</strong></dt>
  422. <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>
  423. <dt><span class="strong">Throws:</span></dt>
  424. <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>
  425. </li>
  426. </ul>
  427. <a name="skip(long)">
  428. <!-- -->
  429. </a>
  430. <ul class="blockList">
  431. <li class="blockList">
  432. <h4>skip</h4>
  433. <pre>public&nbsp;long&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/zip/ZipArchiveInputStream.html#line.548">skip</a>(long&nbsp;value)
  434. 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>
  435. <div class="block">Skips over and discards value bytes of data from this input
  436. stream.
  437. <p>This implementation may end up skipping over some smaller
  438. number of bytes, possibly 0, if and only if it reaches the end
  439. of the underlying stream.</p>
  440. <p>The actual number of bytes skipped is returned.</p></div>
  441. <dl>
  442. <dt><strong>Overrides:</strong></dt>
  443. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true#skip(long)" title="class or interface in java.io">skip</a></code>&nbsp;in class&nbsp;<code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a></code></dd>
  444. <dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - the number of bytes to be skipped.</dd>
  445. <dt><span class="strong">Returns:</span></dt><dd>the actual number of bytes skipped.</dd>
  446. <dt><span class="strong">Throws:</span></dt>
  447. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - - if an I/O error occurs.</dd>
  448. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - - if value is negative.</dd></dl>
  449. </li>
  450. </ul>
  451. <a name="matches(byte[], int)">
  452. <!-- -->
  453. </a>
  454. <ul class="blockListLast">
  455. <li class="blockList">
  456. <h4>matches</h4>
  457. <pre>public static&nbsp;boolean&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/zip/ZipArchiveInputStream.html#line.573">matches</a>(byte[]&nbsp;signature,
  458. int&nbsp;length)</pre>
  459. <div class="block">Checks if the signature matches what is expected for a zip file.
  460. Does not currently handle self-extracting zips which may have arbitrary
  461. leading content.</div>
  462. <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>
  463. <dt><span class="strong">Returns:</span></dt><dd>true, if this stream is a zip archive stream, false otherwise</dd></dl>
  464. </li>
  465. </ul>
  466. </li>
  467. </ul>
  468. </li>
  469. </ul>
  470. </div>
  471. </div>
  472. <!-- ========= END OF CLASS DATA ========= -->
  473. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  474. <div class="bottomNav"><a name="navbar_bottom">
  475. <!-- -->
  476. </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
  477. <!-- -->
  478. </a>
  479. <ul class="navList" title="Navigation">
  480. <li><a href="../../../../../../overview-summary.html">Overview</a></li>
  481. <li><a href="package-summary.html">Package</a></li>
  482. <li class="navBarCell1Rev">Class</li>
  483. <li><a href="class-use/ZipArchiveInputStream.html">Use</a></li>
  484. <li><a href="package-tree.html">Tree</a></li>
  485. <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
  486. <li><a href="../../../../../../index-all.html">Index</a></li>
  487. <li><a href="../../../../../../help-doc.html">Help</a></li>
  488. </ul>
  489. </div>
  490. <div class="subNav">
  491. <ul class="navList">
  492. <li><a href="../../../../../../org/apache/commons/compress/archivers/zip/ZipArchiveEntryRequestSupplier.html" title="interface in org.apache.commons.compress.archivers.zip"><span class="strong">Prev Class</span></a></li>
  493. <li><a href="../../../../../../org/apache/commons/compress/archivers/zip/ZipArchiveOutputStream.html" title="class in org.apache.commons.compress.archivers.zip"><span class="strong">Next Class</span></a></li>
  494. </ul>
  495. <ul class="navList">
  496. <li><a href="../../../../../../index.html?org/apache/commons/compress/archivers/zip/ZipArchiveInputStream.html" target="_top">Frames</a></li>
  497. <li><a href="ZipArchiveInputStream.html" target="_top">No Frames</a></li>
  498. </ul>
  499. <ul class="navList" id="allclasses_navbar_bottom">
  500. <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
  501. </ul>
  502. <div>
  503. <script type="text/javascript"><!--
  504. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  505. if(window==top) {
  506. allClassesLink.style.display = "block";
  507. }
  508. else {
  509. allClassesLink.style.display = "none";
  510. }
  511. //-->
  512. </script>
  513. </div>
  514. <div>
  515. <ul class="subNavList">
  516. <li>Summary:&nbsp;</li>
  517. <li>Nested&nbsp;|&nbsp;</li>
  518. <li>Field&nbsp;|&nbsp;</li>
  519. <li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
  520. <li><a href="#method_summary">Method</a></li>
  521. </ul>
  522. <ul class="subNavList">
  523. <li>Detail:&nbsp;</li>
  524. <li>Field&nbsp;|&nbsp;</li>
  525. <li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
  526. <li><a href="#method_detail">Method</a></li>
  527. </ul>
  528. </div>
  529. <a name="skip-navbar_bottom">
  530. <!-- -->
  531. </a></div>
  532. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  533. <p class="legalCopy"><small>Copyright &#169; 2016 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
  534. </body>
  535. </html>