123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590 |
- <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
- <!-- NewPage -->
- <html lang="de">
- <head>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
- <title>CpioArchiveInputStream (Apache Commons Compress 1.13 API)</title>
- <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
- </head>
- <body>
- <script type="text/javascript"><!--
- try {
- if (location.href.indexOf('is-external=true') == -1) {
- parent.document.title="CpioArchiveInputStream (Apache Commons Compress 1.13 API)";
- }
- }
- catch(err) {
- }
- //-->
- </script>
- <noscript>
- <div>JavaScript is disabled on your browser.</div>
- </noscript>
- <!-- ========= START OF TOP NAVBAR ======= -->
- <div class="topNav"><a name="navbar_top">
- <!-- -->
- </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
- <!-- -->
- </a>
- <ul class="navList" title="Navigation">
- <li><a href="../../../../../../overview-summary.html">Overview</a></li>
- <li><a href="package-summary.html">Package</a></li>
- <li class="navBarCell1Rev">Class</li>
- <li><a href="class-use/CpioArchiveInputStream.html">Use</a></li>
- <li><a href="package-tree.html">Tree</a></li>
- <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
- <li><a href="../../../../../../index-all.html">Index</a></li>
- <li><a href="../../../../../../help-doc.html">Help</a></li>
- </ul>
- </div>
- <div class="subNav">
- <ul class="navList">
- <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>
- <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>
- </ul>
- <ul class="navList">
- <li><a href="../../../../../../index.html?org/apache/commons/compress/archivers/cpio/CpioArchiveInputStream.html" target="_top">Frames</a></li>
- <li><a href="CpioArchiveInputStream.html" target="_top">No Frames</a></li>
- </ul>
- <ul class="navList" id="allclasses_navbar_top">
- <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
- </ul>
- <div>
- <script type="text/javascript"><!--
- allClassesLink = document.getElementById("allclasses_navbar_top");
- if(window==top) {
- allClassesLink.style.display = "block";
- }
- else {
- allClassesLink.style.display = "none";
- }
- //-->
- </script>
- </div>
- <div>
- <ul class="subNavList">
- <li>Summary: </li>
- <li>Nested | </li>
- <li>Field | </li>
- <li><a href="#constructor_summary">Constr</a> | </li>
- <li><a href="#method_summary">Method</a></li>
- </ul>
- <ul class="subNavList">
- <li>Detail: </li>
- <li>Field | </li>
- <li><a href="#constructor_detail">Constr</a> | </li>
- <li><a href="#method_detail">Method</a></li>
- </ul>
- </div>
- <a name="skip-navbar_top">
- <!-- -->
- </a></div>
- <!-- ========= END OF TOP NAVBAR ========= -->
- <!-- ======== START OF CLASS DATA ======== -->
- <div class="header">
- <div class="subTitle">org.apache.commons.compress.archivers.cpio</div>
- <h2 title="Class CpioArchiveInputStream" class="title">Class CpioArchiveInputStream</h2>
- </div>
- <div class="contentContainer">
- <ul class="inheritance">
- <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>
- <li>
- <ul class="inheritance">
- <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>
- <li>
- <ul class="inheritance">
- <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>
- <li>
- <ul class="inheritance">
- <li>org.apache.commons.compress.archivers.cpio.CpioArchiveInputStream</li>
- </ul>
- </li>
- </ul>
- </li>
- </ul>
- </li>
- </ul>
- <div class="description">
- <ul class="blockList">
- <li class="blockList">
- <dl>
- <dt>All Implemented Interfaces:</dt>
- <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>
- </dl>
- <hr>
- <br>
- <pre>public class <a href="../../../../../../src-html/org/apache/commons/compress/archivers/cpio/CpioArchiveInputStream.html#line.67">CpioArchiveInputStream</a>
- extends <a href="../../../../../../org/apache/commons/compress/archivers/ArchiveInputStream.html" title="class in org.apache.commons.compress.archivers">ArchiveInputStream</a>
- implements <a href="../../../../../../org/apache/commons/compress/archivers/cpio/CpioConstants.html" title="interface in org.apache.commons.compress.archivers.cpio">CpioConstants</a></pre>
- <div class="block">CPIOArchiveInputStream is a stream for reading cpio streams. All formats of
- cpio are supported (old ascii, old binary, new portable format and the new
- portable format with crc).
- <p>
- The stream can be read by extracting a cpio entry (containing all
- informations about a entry) and afterwards reading from the stream the file
- specified by the entry.
- </p>
- <pre>
- CPIOArchiveInputStream cpioIn = new CPIOArchiveInputStream(
- new FileInputStream(new File("test.cpio")));
- CPIOArchiveEntry cpioEntry;
- while ((cpioEntry = cpioIn.getNextEntry()) != null) {
- System.out.println(cpioEntry.getName());
- int tmp;
- StringBuilder buf = new StringBuilder();
- while ((tmp = cpIn.read()) != -1) {
- buf.append((char) tmp);
- }
- System.out.println(buf.toString());
- }
- cpioIn.close();
- </pre>
- <p>
- Note: This implementation should be compatible to cpio 2.5
-
- <p>This class uses mutable fields and is not considered to be threadsafe.
-
- <p>Based on code from the jRPM project (jrpm.sourceforge.net)</div>
- </li>
- </ul>
- </div>
- <div class="summary">
- <ul class="blockList">
- <li class="blockList">
- <!-- =========== FIELD SUMMARY =========== -->
- <ul class="blockList">
- <li class="blockList"><a name="field_summary">
- <!-- -->
- </a>
- <h3>Field Summary</h3>
- <ul class="blockList">
- <li class="blockList"><a name="fields_inherited_from_class_org.apache.commons.compress.archivers.cpio.CpioConstants">
- <!-- -->
- </a>
- <h3>Fields inherited from interface 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>
- <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>
- </ul>
- </li>
- </ul>
- <!-- ======== CONSTRUCTOR SUMMARY ======== -->
- <ul class="blockList">
- <li class="blockList"><a name="constructor_summary">
- <!-- -->
- </a>
- <h3>Constructor Summary</h3>
- <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
- <caption><span>Constructors</span><span class="tabEnd"> </span></caption>
- <tr>
- <th class="colOne" scope="col">Constructor and Description</th>
- </tr>
- <tr class="altColor">
- <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> in)</code>
- <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
- names.</div>
- </td>
- </tr>
- <tr class="rowColor">
- <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> in,
- int blockSize)</code>
- <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
- names.</div>
- </td>
- </tr>
- <tr class="altColor">
- <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> in,
- int blockSize,
- <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> encoding)</code>
- <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>
- </td>
- </tr>
- <tr class="rowColor">
- <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> in,
- <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> encoding)</code>
- <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>
- </td>
- </tr>
- </table>
- </li>
- </ul>
- <!-- ========== METHOD SUMMARY =========== -->
- <ul class="blockList">
- <li class="blockList"><a name="method_summary">
- <!-- -->
- </a>
- <h3>Method Summary</h3>
- <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
- <caption><span>Methods</span><span class="tabEnd"> </span></caption>
- <tr>
- <th class="colFirst" scope="col">Modifier and Type</th>
- <th class="colLast" scope="col">Method and Description</th>
- </tr>
- <tr class="altColor">
- <td class="colFirst"><code>int</code></td>
- <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/cpio/CpioArchiveInputStream.html#available()">available</a></strong>()</code>
- <div class="block">Returns 0 after EOF has reached for the current entry data, otherwise
- always return 1.</div>
- </td>
- </tr>
- <tr class="rowColor">
- <td class="colFirst"><code>void</code></td>
- <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/cpio/CpioArchiveInputStream.html#close()">close</a></strong>()</code>
- <div class="block">Closes the CPIO input stream.</div>
- </td>
- </tr>
- <tr class="altColor">
- <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>
- <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/cpio/CpioArchiveInputStream.html#getNextCPIOEntry()">getNextCPIOEntry</a></strong>()</code>
- <div class="block">Reads the next CPIO file entry and positions stream at the beginning of
- the entry data.</div>
- </td>
- </tr>
- <tr class="rowColor">
- <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>
- <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/cpio/CpioArchiveInputStream.html#getNextEntry()">getNextEntry</a></strong>()</code>
- <div class="block">Returns the next Archive Entry in this Stream.</div>
- </td>
- </tr>
- <tr class="altColor">
- <td class="colFirst"><code>static boolean</code></td>
- <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/cpio/CpioArchiveInputStream.html#matches(byte[],%20int)">matches</a></strong>(byte[] signature,
- int length)</code>
- <div class="block">Checks if the signature matches one of the following magic values:
-
- Strings:
- "070701" - MAGIC_NEW
- "070702" - MAGIC_NEW_CRC
- "070707" - MAGIC_OLD_ASCII
-
- Octal Binary value:
-
- 070707 - MAGIC_OLD_BINARY (held as a short) = 0x71C7 or 0xC771</div>
- </td>
- </tr>
- <tr class="rowColor">
- <td class="colFirst"><code>int</code></td>
- <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/cpio/CpioArchiveInputStream.html#read(byte[],%20int,%20int)">read</a></strong>(byte[] b,
- int off,
- int len)</code>
- <div class="block">Reads from the current CPIO entry into an array of bytes.</div>
- </td>
- </tr>
- <tr class="altColor">
- <td class="colFirst"><code>long</code></td>
- <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/cpio/CpioArchiveInputStream.html#skip(long)">skip</a></strong>(long n)</code>
- <div class="block">Skips specified number of bytes in the current CPIO entry.</div>
- </td>
- </tr>
- </table>
- <ul class="blockList">
- <li class="blockList"><a name="methods_inherited_from_class_org.apache.commons.compress.archivers.ArchiveInputStream">
- <!-- -->
- </a>
- <h3>Methods inherited from class 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>
- <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>
- </ul>
- <ul class="blockList">
- <li class="blockList"><a name="methods_inherited_from_class_java.io.InputStream">
- <!-- -->
- </a>
- <h3>Methods inherited from class 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>
- <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>
- </ul>
- <ul class="blockList">
- <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
- <!-- -->
- </a>
- <h3>Methods inherited from class 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>
- <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>
- </ul>
- </li>
- </ul>
- </li>
- </ul>
- </div>
- <div class="details">
- <ul class="blockList">
- <li class="blockList">
- <!-- ========= CONSTRUCTOR DETAIL ======== -->
- <ul class="blockList">
- <li class="blockList"><a name="constructor_detail">
- <!-- -->
- </a>
- <h3>Constructor Detail</h3>
- <a name="CpioArchiveInputStream(java.io.InputStream)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>CpioArchiveInputStream</h4>
- <pre>public <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> in)</pre>
- <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
- names.</div>
- <dl><dt><span class="strong">Parameters:</span></dt><dd><code>in</code> - The cpio stream</dd></dl>
- </li>
- </ul>
- <a name="CpioArchiveInputStream(java.io.InputStream, java.lang.String)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>CpioArchiveInputStream</h4>
- <pre>public <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> in,
- <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> encoding)</pre>
- <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>
- <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
- the platform's default.</dd><dt><span class="strong">Since:</span></dt>
- <dd>1.6</dd></dl>
- </li>
- </ul>
- <a name="CpioArchiveInputStream(java.io.InputStream, int)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>CpioArchiveInputStream</h4>
- <pre>public <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> in,
- int blockSize)</pre>
- <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
- names.</div>
- <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>
- <dd>1.5</dd></dl>
- </li>
- </ul>
- <a name="CpioArchiveInputStream(java.io.InputStream, int, java.lang.String)">
- <!-- -->
- </a>
- <ul class="blockListLast">
- <li class="blockList">
- <h4>CpioArchiveInputStream</h4>
- <pre>public <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> in,
- int blockSize,
- <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> encoding)</pre>
- <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>
- <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
- the platform's default.</dd><dt><span class="strong">Since:</span></dt>
- <dd>1.6</dd></dl>
- </li>
- </ul>
- </li>
- </ul>
- <!-- ============ METHOD DETAIL ========== -->
- <ul class="blockList">
- <li class="blockList"><a name="method_detail">
- <!-- -->
- </a>
- <h3>Method Detail</h3>
- <a name="available()">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>available</h4>
- <pre>public int <a href="../../../../../../src-html/org/apache/commons/compress/archivers/cpio/CpioArchiveInputStream.html#line.173">available</a>()
- 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>
- <div class="block">Returns 0 after EOF has reached for the current entry data, otherwise
- always return 1.
- <p>
- Programs should not count on this method to return the actual number of
- bytes that could be read without blocking.</div>
- <dl>
- <dt><strong>Overrides:</strong></dt>
- <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> in class <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>
- <dt><span class="strong">Returns:</span></dt><dd>1 before EOF and 0 after EOF has reached for current entry.</dd>
- <dt><span class="strong">Throws:</span></dt>
- <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
- occurred</dd></dl>
- </li>
- </ul>
- <a name="close()">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>close</h4>
- <pre>public void <a href="../../../../../../src-html/org/apache/commons/compress/archivers/cpio/CpioArchiveInputStream.html#line.188">close</a>()
- 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>
- <div class="block">Closes the CPIO input stream.</div>
- <dl>
- <dt><strong>Specified by:</strong></dt>
- <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> in interface <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>
- <dt><strong>Specified by:</strong></dt>
- <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> in interface <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>
- <dt><strong>Overrides:</strong></dt>
- <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> in class <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>
- <dt><span class="strong">Throws:</span></dt>
- <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>
- </li>
- </ul>
- <a name="getNextCPIOEntry()">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getNextCPIOEntry</h4>
- <pre>public <a href="../../../../../../org/apache/commons/compress/archivers/cpio/CpioArchiveEntry.html" title="class in org.apache.commons.compress.archivers.cpio">CpioArchiveEntry</a> <a href="../../../../../../src-html/org/apache/commons/compress/archivers/cpio/CpioArchiveInputStream.html#line.232">getNextCPIOEntry</a>()
- 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>
- <div class="block">Reads the next CPIO file entry and positions stream at the beginning of
- the entry data.</div>
- <dl><dt><span class="strong">Returns:</span></dt><dd>the CPIOArchiveEntry just read</dd>
- <dt><span class="strong">Throws:</span></dt>
- <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
- occurred</dd></dl>
- </li>
- </ul>
- <a name="read(byte[], int, int)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>read</h4>
- <pre>public int <a href="../../../../../../src-html/org/apache/commons/compress/archivers/cpio/CpioArchiveInputStream.html#line.300">read</a>(byte[] b,
- int off,
- int len)
- 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>
- <div class="block">Reads from the current CPIO entry into an array of bytes. Blocks until
- some input is available.</div>
- <dl>
- <dt><strong>Overrides:</strong></dt>
- <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> in class <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>
- <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>
- <dt><span class="strong">Returns:</span></dt><dd>the actual number of bytes read, or -1 if the end of the entry is
- reached</dd>
- <dt><span class="strong">Throws:</span></dt>
- <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
- occurred</dd></dl>
- </li>
- </ul>
- <a name="skip(long)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>skip</h4>
- <pre>public long <a href="../../../../../../src-html/org/apache/commons/compress/archivers/cpio/CpioArchiveInputStream.html#line.476">skip</a>(long n)
- 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>
- <div class="block">Skips specified number of bytes in the current CPIO entry.</div>
- <dl>
- <dt><strong>Overrides:</strong></dt>
- <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> in class <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>
- <dt><span class="strong">Parameters:</span></dt><dd><code>n</code> - the number of bytes to skip</dd>
- <dt><span class="strong">Returns:</span></dt><dd>the actual number of bytes skipped</dd>
- <dt><span class="strong">Throws:</span></dt>
- <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>
- <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 < 0</dd></dl>
- </li>
- </ul>
- <a name="getNextEntry()">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getNextEntry</h4>
- <pre>public <a href="../../../../../../org/apache/commons/compress/archivers/ArchiveEntry.html" title="interface in org.apache.commons.compress.archivers">ArchiveEntry</a> <a href="../../../../../../src-html/org/apache/commons/compress/archivers/cpio/CpioArchiveInputStream.html#line.500">getNextEntry</a>()
- 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>
- <div class="block"><strong>Description copied from class: <code><a href="../../../../../../org/apache/commons/compress/archivers/ArchiveInputStream.html#getNextEntry()">ArchiveInputStream</a></code></strong></div>
- <div class="block">Returns the next Archive Entry in this Stream.</div>
- <dl>
- <dt><strong>Specified by:</strong></dt>
- <dd><code><a href="../../../../../../org/apache/commons/compress/archivers/ArchiveInputStream.html#getNextEntry()">getNextEntry</a></code> in class <code><a href="../../../../../../org/apache/commons/compress/archivers/ArchiveInputStream.html" title="class in org.apache.commons.compress.archivers">ArchiveInputStream</a></code></dd>
- <dt><span class="strong">Returns:</span></dt><dd>the next entry,
- or <code>null</code> if there are no more entries</dd>
- <dt><span class="strong">Throws:</span></dt>
- <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>
- </li>
- </ul>
- <a name="matches(byte[], int)">
- <!-- -->
- </a>
- <ul class="blockListLast">
- <li class="blockList">
- <h4>matches</h4>
- <pre>public static boolean <a href="../../../../../../src-html/org/apache/commons/compress/archivers/cpio/CpioArchiveInputStream.html#line.536">matches</a>(byte[] signature,
- int length)</pre>
- <div class="block">Checks if the signature matches one of the following magic values:
-
- Strings:
- "070701" - MAGIC_NEW
- "070702" - MAGIC_NEW_CRC
- "070707" - MAGIC_OLD_ASCII
-
- Octal Binary value:
-
- 070707 - MAGIC_OLD_BINARY (held as a short) = 0x71C7 or 0xC771</div>
- <dl><dt><span class="strong">Parameters:</span></dt><dd><code>signature</code> - data to match</dd><dd><code>length</code> - length of data</dd>
- <dt><span class="strong">Returns:</span></dt><dd>whether the buffer seems to contain CPIO data</dd></dl>
- </li>
- </ul>
- </li>
- </ul>
- </li>
- </ul>
- </div>
- </div>
- <!-- ========= END OF CLASS DATA ========= -->
- <!-- ======= START OF BOTTOM NAVBAR ====== -->
- <div class="bottomNav"><a name="navbar_bottom">
- <!-- -->
- </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
- <!-- -->
- </a>
- <ul class="navList" title="Navigation">
- <li><a href="../../../../../../overview-summary.html">Overview</a></li>
- <li><a href="package-summary.html">Package</a></li>
- <li class="navBarCell1Rev">Class</li>
- <li><a href="class-use/CpioArchiveInputStream.html">Use</a></li>
- <li><a href="package-tree.html">Tree</a></li>
- <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
- <li><a href="../../../../../../index-all.html">Index</a></li>
- <li><a href="../../../../../../help-doc.html">Help</a></li>
- </ul>
- </div>
- <div class="subNav">
- <ul class="navList">
- <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>
- <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>
- </ul>
- <ul class="navList">
- <li><a href="../../../../../../index.html?org/apache/commons/compress/archivers/cpio/CpioArchiveInputStream.html" target="_top">Frames</a></li>
- <li><a href="CpioArchiveInputStream.html" target="_top">No Frames</a></li>
- </ul>
- <ul class="navList" id="allclasses_navbar_bottom">
- <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
- </ul>
- <div>
- <script type="text/javascript"><!--
- allClassesLink = document.getElementById("allclasses_navbar_bottom");
- if(window==top) {
- allClassesLink.style.display = "block";
- }
- else {
- allClassesLink.style.display = "none";
- }
- //-->
- </script>
- </div>
- <div>
- <ul class="subNavList">
- <li>Summary: </li>
- <li>Nested | </li>
- <li>Field | </li>
- <li><a href="#constructor_summary">Constr</a> | </li>
- <li><a href="#method_summary">Method</a></li>
- </ul>
- <ul class="subNavList">
- <li>Detail: </li>
- <li>Field | </li>
- <li><a href="#constructor_detail">Constr</a> | </li>
- <li><a href="#method_detail">Method</a></li>
- </ul>
- </div>
- <a name="skip-navbar_bottom">
- <!-- -->
- </a></div>
- <!-- ======== END OF BOTTOM NAVBAR ======= -->
- <p class="legalCopy"><small>Copyright © 2016 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
- </body>
- </html>
|