CpioArchiveInputStream.html 39 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590
  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>CpioArchiveInputStream (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="CpioArchiveInputStream (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/CpioArchiveInputStream.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/cpio/CpioArchiveEntry.html" title="class in org.apache.commons.compress.archivers.cpio"><span class="strong">Prev Class</span></a></li>
  43. <li><a href="../../../../../../org/apache/commons/compress/archivers/cpio/CpioArchiveOutputStream.html" title="class in org.apache.commons.compress.archivers.cpio"><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/cpio/CpioArchiveInputStream.html" target="_top">Frames</a></li>
  47. <li><a href="CpioArchiveInputStream.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.cpio</div>
  86. <h2 title="Class CpioArchiveInputStream" class="title">Class CpioArchiveInputStream</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.cpio.CpioArchiveInputStream</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>, <a href="../../../../../../org/apache/commons/compress/archivers/cpio/CpioConstants.html" title="interface in org.apache.commons.compress.archivers.cpio">CpioConstants</a></dd>
  113. </dl>
  114. <hr>
  115. <br>
  116. <pre>public class <a href="../../../../../../src-html/org/apache/commons/compress/archivers/cpio/CpioArchiveInputStream.html#line.67">CpioArchiveInputStream</a>
  117. extends <a href="../../../../../../org/apache/commons/compress/archivers/ArchiveInputStream.html" title="class in org.apache.commons.compress.archivers">ArchiveInputStream</a>
  118. implements <a href="../../../../../../org/apache/commons/compress/archivers/cpio/CpioConstants.html" title="interface in org.apache.commons.compress.archivers.cpio">CpioConstants</a></pre>
  119. <div class="block">CPIOArchiveInputStream is a stream for reading cpio streams. All formats of
  120. cpio are supported (old ascii, old binary, new portable format and the new
  121. portable format with crc).
  122. <p>
  123. The stream can be read by extracting a cpio entry (containing all
  124. informations about a entry) and afterwards reading from the stream the file
  125. specified by the entry.
  126. </p>
  127. <pre>
  128. CPIOArchiveInputStream cpioIn = new CPIOArchiveInputStream(
  129. new FileInputStream(new File(&quot;test.cpio&quot;)));
  130. CPIOArchiveEntry cpioEntry;
  131. while ((cpioEntry = cpioIn.getNextEntry()) != null) {
  132. System.out.println(cpioEntry.getName());
  133. int tmp;
  134. StringBuilder buf = new StringBuilder();
  135. while ((tmp = cpIn.read()) != -1) {
  136. buf.append((char) tmp);
  137. }
  138. System.out.println(buf.toString());
  139. }
  140. cpioIn.close();
  141. </pre>
  142. <p>
  143. Note: This implementation should be compatible to cpio 2.5
  144. <p>This class uses mutable fields and is not considered to be threadsafe.
  145. <p>Based on code from the jRPM project (jrpm.sourceforge.net)</div>
  146. </li>
  147. </ul>
  148. </div>
  149. <div class="summary">
  150. <ul class="blockList">
  151. <li class="blockList">
  152. <!-- =========== FIELD SUMMARY =========== -->
  153. <ul class="blockList">
  154. <li class="blockList"><a name="field_summary">
  155. <!-- -->
  156. </a>
  157. <h3>Field Summary</h3>
  158. <ul class="blockList">
  159. <li class="blockList"><a name="fields_inherited_from_class_org.apache.commons.compress.archivers.cpio.CpioConstants">
  160. <!-- -->
  161. </a>
  162. <h3>Fields inherited from interface&nbsp;org.apache.commons.compress.archivers.cpio.<a href="../../../../../../org/apache/commons/compress/archivers/cpio/CpioConstants.html" title="interface in org.apache.commons.compress.archivers.cpio">CpioConstants</a></h3>
  163. <code><a href="../../../../../../org/apache/commons/compress/archivers/cpio/CpioConstants.html#BLOCK_SIZE">BLOCK_SIZE</a>, <a href="../../../../../../org/apache/commons/compress/archivers/cpio/CpioConstants.html#C_IRGRP">C_IRGRP</a>, <a href="../../../../../../org/apache/commons/compress/archivers/cpio/CpioConstants.html#C_IROTH">C_IROTH</a>, <a href="../../../../../../org/apache/commons/compress/archivers/cpio/CpioConstants.html#C_IRUSR">C_IRUSR</a>, <a href="../../../../../../org/apache/commons/compress/archivers/cpio/CpioConstants.html#C_ISBLK">C_ISBLK</a>, <a href="../../../../../../org/apache/commons/compress/archivers/cpio/CpioConstants.html#C_ISCHR">C_ISCHR</a>, <a href="../../../../../../org/apache/commons/compress/archivers/cpio/CpioConstants.html#C_ISDIR">C_ISDIR</a>, <a href="../../../../../../org/apache/commons/compress/archivers/cpio/CpioConstants.html#C_ISFIFO">C_ISFIFO</a>, <a href="../../../../../../org/apache/commons/compress/archivers/cpio/CpioConstants.html#C_ISGID">C_ISGID</a>, <a href="../../../../../../org/apache/commons/compress/archivers/cpio/CpioConstants.html#C_ISLNK">C_ISLNK</a>, <a href="../../../../../../org/apache/commons/compress/archivers/cpio/CpioConstants.html#C_ISNWK">C_ISNWK</a>, <a href="../../../../../../org/apache/commons/compress/archivers/cpio/CpioConstants.html#C_ISREG">C_ISREG</a>, <a href="../../../../../../org/apache/commons/compress/archivers/cpio/CpioConstants.html#C_ISSOCK">C_ISSOCK</a>, <a href="../../../../../../org/apache/commons/compress/archivers/cpio/CpioConstants.html#C_ISUID">C_ISUID</a>, <a href="../../../../../../org/apache/commons/compress/archivers/cpio/CpioConstants.html#C_ISVTX">C_ISVTX</a>, <a href="../../../../../../org/apache/commons/compress/archivers/cpio/CpioConstants.html#C_IWGRP">C_IWGRP</a>, <a href="../../../../../../org/apache/commons/compress/archivers/cpio/CpioConstants.html#C_IWOTH">C_IWOTH</a>, <a href="../../../../../../org/apache/commons/compress/archivers/cpio/CpioConstants.html#C_IWUSR">C_IWUSR</a>, <a href="../../../../../../org/apache/commons/compress/archivers/cpio/CpioConstants.html#C_IXGRP">C_IXGRP</a>, <a href="../../../../../../org/apache/commons/compress/archivers/cpio/CpioConstants.html#C_IXOTH">C_IXOTH</a>, <a href="../../../../../../org/apache/commons/compress/archivers/cpio/CpioConstants.html#C_IXUSR">C_IXUSR</a>, <a href="../../../../../../org/apache/commons/compress/archivers/cpio/CpioConstants.html#CPIO_TRAILER">CPIO_TRAILER</a>, <a href="../../../../../../org/apache/commons/compress/archivers/cpio/CpioConstants.html#FORMAT_NEW">FORMAT_NEW</a>, <a href="../../../../../../org/apache/commons/compress/archivers/cpio/CpioConstants.html#FORMAT_NEW_CRC">FORMAT_NEW_CRC</a>, <a href="../../../../../../org/apache/commons/compress/archivers/cpio/CpioConstants.html#FORMAT_NEW_MASK">FORMAT_NEW_MASK</a>, <a href="../../../../../../org/apache/commons/compress/archivers/cpio/CpioConstants.html#FORMAT_OLD_ASCII">FORMAT_OLD_ASCII</a>, <a href="../../../../../../org/apache/commons/compress/archivers/cpio/CpioConstants.html#FORMAT_OLD_BINARY">FORMAT_OLD_BINARY</a>, <a href="../../../../../../org/apache/commons/compress/archivers/cpio/CpioConstants.html#FORMAT_OLD_MASK">FORMAT_OLD_MASK</a>, <a href="../../../../../../org/apache/commons/compress/archivers/cpio/CpioConstants.html#MAGIC_NEW">MAGIC_NEW</a>, <a href="../../../../../../org/apache/commons/compress/archivers/cpio/CpioConstants.html#MAGIC_NEW_CRC">MAGIC_NEW_CRC</a>, <a href="../../../../../../org/apache/commons/compress/archivers/cpio/CpioConstants.html#MAGIC_OLD_ASCII">MAGIC_OLD_ASCII</a>, <a href="../../../../../../org/apache/commons/compress/archivers/cpio/CpioConstants.html#MAGIC_OLD_BINARY">MAGIC_OLD_BINARY</a>, <a href="../../../../../../org/apache/commons/compress/archivers/cpio/CpioConstants.html#S_IFMT">S_IFMT</a></code></li>
  164. </ul>
  165. </li>
  166. </ul>
  167. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  168. <ul class="blockList">
  169. <li class="blockList"><a name="constructor_summary">
  170. <!-- -->
  171. </a>
  172. <h3>Constructor Summary</h3>
  173. <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  174. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  175. <tr>
  176. <th class="colOne" scope="col">Constructor and Description</th>
  177. </tr>
  178. <tr class="altColor">
  179. <td class="colOne"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/cpio/CpioArchiveInputStream.html#CpioArchiveInputStream(java.io.InputStream)">CpioArchiveInputStream</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>
  180. <div class="block">Construct the cpio input stream with a blocksize of <a href="../../../../../../org/apache/commons/compress/archivers/cpio/CpioConstants.html#BLOCK_SIZE"><code>BLOCK_SIZE</code></a> and expecting ASCII file
  181. names.</div>
  182. </td>
  183. </tr>
  184. <tr class="rowColor">
  185. <td class="colOne"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/cpio/CpioArchiveInputStream.html#CpioArchiveInputStream(java.io.InputStream,%20int)">CpioArchiveInputStream</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,
  186. int&nbsp;blockSize)</code>
  187. <div class="block">Construct the cpio input stream with a blocksize of <a href="../../../../../../org/apache/commons/compress/archivers/cpio/CpioConstants.html#BLOCK_SIZE"><code>BLOCK_SIZE</code></a> expecting ASCII file
  188. names.</div>
  189. </td>
  190. </tr>
  191. <tr class="altColor">
  192. <td class="colOne"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/cpio/CpioArchiveInputStream.html#CpioArchiveInputStream(java.io.InputStream,%20int,%20java.lang.String)">CpioArchiveInputStream</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,
  193. int&nbsp;blockSize,
  194. <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>
  195. <div class="block">Construct the cpio input stream with a blocksize of <a href="../../../../../../org/apache/commons/compress/archivers/cpio/CpioConstants.html#BLOCK_SIZE"><code>BLOCK_SIZE</code></a>.</div>
  196. </td>
  197. </tr>
  198. <tr class="rowColor">
  199. <td class="colOne"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/cpio/CpioArchiveInputStream.html#CpioArchiveInputStream(java.io.InputStream,%20java.lang.String)">CpioArchiveInputStream</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,
  200. <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>
  201. <div class="block">Construct the cpio input stream with a blocksize of <a href="../../../../../../org/apache/commons/compress/archivers/cpio/CpioConstants.html#BLOCK_SIZE"><code>BLOCK_SIZE</code></a>.</div>
  202. </td>
  203. </tr>
  204. </table>
  205. </li>
  206. </ul>
  207. <!-- ========== METHOD SUMMARY =========== -->
  208. <ul class="blockList">
  209. <li class="blockList"><a name="method_summary">
  210. <!-- -->
  211. </a>
  212. <h3>Method Summary</h3>
  213. <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  214. <caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
  215. <tr>
  216. <th class="colFirst" scope="col">Modifier and Type</th>
  217. <th class="colLast" scope="col">Method and Description</th>
  218. </tr>
  219. <tr class="altColor">
  220. <td class="colFirst"><code>int</code></td>
  221. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/cpio/CpioArchiveInputStream.html#available()">available</a></strong>()</code>
  222. <div class="block">Returns 0 after EOF has reached for the current entry data, otherwise
  223. always return 1.</div>
  224. </td>
  225. </tr>
  226. <tr class="rowColor">
  227. <td class="colFirst"><code>void</code></td>
  228. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/cpio/CpioArchiveInputStream.html#close()">close</a></strong>()</code>
  229. <div class="block">Closes the CPIO input stream.</div>
  230. </td>
  231. </tr>
  232. <tr class="altColor">
  233. <td class="colFirst"><code><a href="../../../../../../org/apache/commons/compress/archivers/cpio/CpioArchiveEntry.html" title="class in org.apache.commons.compress.archivers.cpio">CpioArchiveEntry</a></code></td>
  234. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/cpio/CpioArchiveInputStream.html#getNextCPIOEntry()">getNextCPIOEntry</a></strong>()</code>
  235. <div class="block">Reads the next CPIO file entry and positions stream at the beginning of
  236. the entry data.</div>
  237. </td>
  238. </tr>
  239. <tr class="rowColor">
  240. <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>
  241. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/cpio/CpioArchiveInputStream.html#getNextEntry()">getNextEntry</a></strong>()</code>
  242. <div class="block">Returns the next Archive Entry in this Stream.</div>
  243. </td>
  244. </tr>
  245. <tr class="altColor">
  246. <td class="colFirst"><code>static boolean</code></td>
  247. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/cpio/CpioArchiveInputStream.html#matches(byte[],%20int)">matches</a></strong>(byte[]&nbsp;signature,
  248. int&nbsp;length)</code>
  249. <div class="block">Checks if the signature matches one of the following magic values:
  250. Strings:
  251. "070701" - MAGIC_NEW
  252. "070702" - MAGIC_NEW_CRC
  253. "070707" - MAGIC_OLD_ASCII
  254. Octal Binary value:
  255. 070707 - MAGIC_OLD_BINARY (held as a short) = 0x71C7 or 0xC771</div>
  256. </td>
  257. </tr>
  258. <tr class="rowColor">
  259. <td class="colFirst"><code>int</code></td>
  260. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/cpio/CpioArchiveInputStream.html#read(byte[],%20int,%20int)">read</a></strong>(byte[]&nbsp;b,
  261. int&nbsp;off,
  262. int&nbsp;len)</code>
  263. <div class="block">Reads from the current CPIO entry into an array of bytes.</div>
  264. </td>
  265. </tr>
  266. <tr class="altColor">
  267. <td class="colFirst"><code>long</code></td>
  268. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/cpio/CpioArchiveInputStream.html#skip(long)">skip</a></strong>(long&nbsp;n)</code>
  269. <div class="block">Skips specified number of bytes in the current CPIO entry.</div>
  270. </td>
  271. </tr>
  272. </table>
  273. <ul class="blockList">
  274. <li class="blockList"><a name="methods_inherited_from_class_org.apache.commons.compress.archivers.ArchiveInputStream">
  275. <!-- -->
  276. </a>
  277. <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>
  278. <code><a href="../../../../../../org/apache/commons/compress/archivers/ArchiveInputStream.html#canReadEntryData(org.apache.commons.compress.archivers.ArchiveEntry)">canReadEntryData</a>, <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>
  279. </ul>
  280. <ul class="blockList">
  281. <li class="blockList"><a name="methods_inherited_from_class_java.io.InputStream">
  282. <!-- -->
  283. </a>
  284. <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>
  285. <code><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>
  286. </ul>
  287. <ul class="blockList">
  288. <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
  289. <!-- -->
  290. </a>
  291. <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>
  292. <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>
  293. </ul>
  294. </li>
  295. </ul>
  296. </li>
  297. </ul>
  298. </div>
  299. <div class="details">
  300. <ul class="blockList">
  301. <li class="blockList">
  302. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  303. <ul class="blockList">
  304. <li class="blockList"><a name="constructor_detail">
  305. <!-- -->
  306. </a>
  307. <h3>Constructor Detail</h3>
  308. <a name="CpioArchiveInputStream(java.io.InputStream)">
  309. <!-- -->
  310. </a>
  311. <ul class="blockList">
  312. <li class="blockList">
  313. <h4>CpioArchiveInputStream</h4>
  314. <pre>public&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/cpio/CpioArchiveInputStream.html#line.107">CpioArchiveInputStream</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)</pre>
  315. <div class="block">Construct the cpio input stream with a blocksize of <a href="../../../../../../org/apache/commons/compress/archivers/cpio/CpioConstants.html#BLOCK_SIZE"><code>BLOCK_SIZE</code></a> and expecting ASCII file
  316. names.</div>
  317. <dl><dt><span class="strong">Parameters:</span></dt><dd><code>in</code> - The cpio stream</dd></dl>
  318. </li>
  319. </ul>
  320. <a name="CpioArchiveInputStream(java.io.InputStream, java.lang.String)">
  321. <!-- -->
  322. </a>
  323. <ul class="blockList">
  324. <li class="blockList">
  325. <h4>CpioArchiveInputStream</h4>
  326. <pre>public&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/cpio/CpioArchiveInputStream.html#line.122">CpioArchiveInputStream</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,
  327. <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>
  328. <div class="block">Construct the cpio input stream with a blocksize of <a href="../../../../../../org/apache/commons/compress/archivers/cpio/CpioConstants.html#BLOCK_SIZE"><code>BLOCK_SIZE</code></a>.</div>
  329. <dl><dt><span class="strong">Parameters:</span></dt><dd><code>in</code> - The cpio stream</dd><dd><code>encoding</code> - The encoding of file names to expect - use null for
  330. the platform's default.</dd><dt><span class="strong">Since:</span></dt>
  331. <dd>1.6</dd></dl>
  332. </li>
  333. </ul>
  334. <a name="CpioArchiveInputStream(java.io.InputStream, int)">
  335. <!-- -->
  336. </a>
  337. <ul class="blockList">
  338. <li class="blockList">
  339. <h4>CpioArchiveInputStream</h4>
  340. <pre>public&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/cpio/CpioArchiveInputStream.html#line.137">CpioArchiveInputStream</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,
  341. int&nbsp;blockSize)</pre>
  342. <div class="block">Construct the cpio input stream with a blocksize of <a href="../../../../../../org/apache/commons/compress/archivers/cpio/CpioConstants.html#BLOCK_SIZE"><code>BLOCK_SIZE</code></a> expecting ASCII file
  343. names.</div>
  344. <dl><dt><span class="strong">Parameters:</span></dt><dd><code>in</code> - The cpio stream</dd><dd><code>blockSize</code> - The block size of the archive.</dd><dt><span class="strong">Since:</span></dt>
  345. <dd>1.5</dd></dl>
  346. </li>
  347. </ul>
  348. <a name="CpioArchiveInputStream(java.io.InputStream, int, java.lang.String)">
  349. <!-- -->
  350. </a>
  351. <ul class="blockListLast">
  352. <li class="blockList">
  353. <h4>CpioArchiveInputStream</h4>
  354. <pre>public&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/cpio/CpioArchiveInputStream.html#line.153">CpioArchiveInputStream</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,
  355. int&nbsp;blockSize,
  356. <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>
  357. <div class="block">Construct the cpio input stream with a blocksize of <a href="../../../../../../org/apache/commons/compress/archivers/cpio/CpioConstants.html#BLOCK_SIZE"><code>BLOCK_SIZE</code></a>.</div>
  358. <dl><dt><span class="strong">Parameters:</span></dt><dd><code>in</code> - The cpio stream</dd><dd><code>blockSize</code> - The block size of the archive.</dd><dd><code>encoding</code> - The encoding of file names to expect - use null for
  359. the platform's default.</dd><dt><span class="strong">Since:</span></dt>
  360. <dd>1.6</dd></dl>
  361. </li>
  362. </ul>
  363. </li>
  364. </ul>
  365. <!-- ============ METHOD DETAIL ========== -->
  366. <ul class="blockList">
  367. <li class="blockList"><a name="method_detail">
  368. <!-- -->
  369. </a>
  370. <h3>Method Detail</h3>
  371. <a name="available()">
  372. <!-- -->
  373. </a>
  374. <ul class="blockList">
  375. <li class="blockList">
  376. <h4>available</h4>
  377. <pre>public&nbsp;int&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/cpio/CpioArchiveInputStream.html#line.173">available</a>()
  378. 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>
  379. <div class="block">Returns 0 after EOF has reached for the current entry data, otherwise
  380. always return 1.
  381. <p>
  382. Programs should not count on this method to return the actual number of
  383. bytes that could be read without blocking.</div>
  384. <dl>
  385. <dt><strong>Overrides:</strong></dt>
  386. <dd><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></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>
  387. <dt><span class="strong">Returns:</span></dt><dd>1 before EOF and 0 after EOF has reached for current entry.</dd>
  388. <dt><span class="strong">Throws:</span></dt>
  389. <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 or if a CPIO file error has
  390. occurred</dd></dl>
  391. </li>
  392. </ul>
  393. <a name="close()">
  394. <!-- -->
  395. </a>
  396. <ul class="blockList">
  397. <li class="blockList">
  398. <h4>close</h4>
  399. <pre>public&nbsp;void&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/cpio/CpioArchiveInputStream.html#line.188">close</a>()
  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. <div class="block">Closes the CPIO input stream.</div>
  402. <dl>
  403. <dt><strong>Specified by:</strong></dt>
  404. <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>
  405. <dt><strong>Specified by:</strong></dt>
  406. <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>
  407. <dt><strong>Overrides:</strong></dt>
  408. <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>
  409. <dt><span class="strong">Throws:</span></dt>
  410. <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>
  411. </li>
  412. </ul>
  413. <a name="getNextCPIOEntry()">
  414. <!-- -->
  415. </a>
  416. <ul class="blockList">
  417. <li class="blockList">
  418. <h4>getNextCPIOEntry</h4>
  419. <pre>public&nbsp;<a href="../../../../../../org/apache/commons/compress/archivers/cpio/CpioArchiveEntry.html" title="class in org.apache.commons.compress.archivers.cpio">CpioArchiveEntry</a>&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/cpio/CpioArchiveInputStream.html#line.232">getNextCPIOEntry</a>()
  420. 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>
  421. <div class="block">Reads the next CPIO file entry and positions stream at the beginning of
  422. the entry data.</div>
  423. <dl><dt><span class="strong">Returns:</span></dt><dd>the CPIOArchiveEntry just read</dd>
  424. <dt><span class="strong">Throws:</span></dt>
  425. <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 or if a CPIO file error has
  426. occurred</dd></dl>
  427. </li>
  428. </ul>
  429. <a name="read(byte[], int, int)">
  430. <!-- -->
  431. </a>
  432. <ul class="blockList">
  433. <li class="blockList">
  434. <h4>read</h4>
  435. <pre>public&nbsp;int&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/cpio/CpioArchiveInputStream.html#line.300">read</a>(byte[]&nbsp;b,
  436. int&nbsp;off,
  437. int&nbsp;len)
  438. 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>
  439. <div class="block">Reads from the current CPIO entry into an array of bytes. Blocks until
  440. some input is available.</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#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>
  444. <dt><span class="strong">Parameters:</span></dt><dd><code>b</code> - the buffer into which the data is read</dd><dd><code>off</code> - the start offset of the data</dd><dd><code>len</code> - the maximum number of bytes read</dd>
  445. <dt><span class="strong">Returns:</span></dt><dd>the actual number of bytes read, or -1 if the end of the entry is
  446. reached</dd>
  447. <dt><span class="strong">Throws:</span></dt>
  448. <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 or if a CPIO file error has
  449. occurred</dd></dl>
  450. </li>
  451. </ul>
  452. <a name="skip(long)">
  453. <!-- -->
  454. </a>
  455. <ul class="blockList">
  456. <li class="blockList">
  457. <h4>skip</h4>
  458. <pre>public&nbsp;long&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/cpio/CpioArchiveInputStream.html#line.476">skip</a>(long&nbsp;n)
  459. 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>
  460. <div class="block">Skips specified number of bytes in the current CPIO entry.</div>
  461. <dl>
  462. <dt><strong>Overrides:</strong></dt>
  463. <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>
  464. <dt><span class="strong">Parameters:</span></dt><dd><code>n</code> - the number of bytes to skip</dd>
  465. <dt><span class="strong">Returns:</span></dt><dd>the actual number of bytes skipped</dd>
  466. <dt><span class="strong">Throws:</span></dt>
  467. <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>
  468. <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 n &lt; 0</dd></dl>
  469. </li>
  470. </ul>
  471. <a name="getNextEntry()">
  472. <!-- -->
  473. </a>
  474. <ul class="blockList">
  475. <li class="blockList">
  476. <h4>getNextEntry</h4>
  477. <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/cpio/CpioArchiveInputStream.html#line.500">getNextEntry</a>()
  478. 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>
  479. <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>
  480. <div class="block">Returns the next Archive Entry in this Stream.</div>
  481. <dl>
  482. <dt><strong>Specified by:</strong></dt>
  483. <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>
  484. <dt><span class="strong">Returns:</span></dt><dd>the next entry,
  485. or <code>null</code> if there are no more entries</dd>
  486. <dt><span class="strong">Throws:</span></dt>
  487. <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>
  488. </li>
  489. </ul>
  490. <a name="matches(byte[], int)">
  491. <!-- -->
  492. </a>
  493. <ul class="blockListLast">
  494. <li class="blockList">
  495. <h4>matches</h4>
  496. <pre>public static&nbsp;boolean&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/cpio/CpioArchiveInputStream.html#line.536">matches</a>(byte[]&nbsp;signature,
  497. int&nbsp;length)</pre>
  498. <div class="block">Checks if the signature matches one of the following magic values:
  499. Strings:
  500. "070701" - MAGIC_NEW
  501. "070702" - MAGIC_NEW_CRC
  502. "070707" - MAGIC_OLD_ASCII
  503. Octal Binary value:
  504. 070707 - MAGIC_OLD_BINARY (held as a short) = 0x71C7 or 0xC771</div>
  505. <dl><dt><span class="strong">Parameters:</span></dt><dd><code>signature</code> - data to match</dd><dd><code>length</code> - length of data</dd>
  506. <dt><span class="strong">Returns:</span></dt><dd>whether the buffer seems to contain CPIO data</dd></dl>
  507. </li>
  508. </ul>
  509. </li>
  510. </ul>
  511. </li>
  512. </ul>
  513. </div>
  514. </div>
  515. <!-- ========= END OF CLASS DATA ========= -->
  516. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  517. <div class="bottomNav"><a name="navbar_bottom">
  518. <!-- -->
  519. </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
  520. <!-- -->
  521. </a>
  522. <ul class="navList" title="Navigation">
  523. <li><a href="../../../../../../overview-summary.html">Overview</a></li>
  524. <li><a href="package-summary.html">Package</a></li>
  525. <li class="navBarCell1Rev">Class</li>
  526. <li><a href="class-use/CpioArchiveInputStream.html">Use</a></li>
  527. <li><a href="package-tree.html">Tree</a></li>
  528. <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
  529. <li><a href="../../../../../../index-all.html">Index</a></li>
  530. <li><a href="../../../../../../help-doc.html">Help</a></li>
  531. </ul>
  532. </div>
  533. <div class="subNav">
  534. <ul class="navList">
  535. <li><a href="../../../../../../org/apache/commons/compress/archivers/cpio/CpioArchiveEntry.html" title="class in org.apache.commons.compress.archivers.cpio"><span class="strong">Prev Class</span></a></li>
  536. <li><a href="../../../../../../org/apache/commons/compress/archivers/cpio/CpioArchiveOutputStream.html" title="class in org.apache.commons.compress.archivers.cpio"><span class="strong">Next Class</span></a></li>
  537. </ul>
  538. <ul class="navList">
  539. <li><a href="../../../../../../index.html?org/apache/commons/compress/archivers/cpio/CpioArchiveInputStream.html" target="_top">Frames</a></li>
  540. <li><a href="CpioArchiveInputStream.html" target="_top">No Frames</a></li>
  541. </ul>
  542. <ul class="navList" id="allclasses_navbar_bottom">
  543. <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
  544. </ul>
  545. <div>
  546. <script type="text/javascript"><!--
  547. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  548. if(window==top) {
  549. allClassesLink.style.display = "block";
  550. }
  551. else {
  552. allClassesLink.style.display = "none";
  553. }
  554. //-->
  555. </script>
  556. </div>
  557. <div>
  558. <ul class="subNavList">
  559. <li>Summary:&nbsp;</li>
  560. <li>Nested&nbsp;|&nbsp;</li>
  561. <li>Field&nbsp;|&nbsp;</li>
  562. <li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
  563. <li><a href="#method_summary">Method</a></li>
  564. </ul>
  565. <ul class="subNavList">
  566. <li>Detail:&nbsp;</li>
  567. <li>Field&nbsp;|&nbsp;</li>
  568. <li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
  569. <li><a href="#method_detail">Method</a></li>
  570. </ul>
  571. </div>
  572. <a name="skip-navbar_bottom">
  573. <!-- -->
  574. </a></div>
  575. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  576. <p class="legalCopy"><small>Copyright &#169; 2016 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
  577. </body>
  578. </html>