123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541 |
- <!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>DumpArchiveInputStream (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="DumpArchiveInputStream (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/DumpArchiveInputStream.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/dump/DumpArchiveException.html" title="class in org.apache.commons.compress.archivers.dump"><span class="strong">Prev Class</span></a></li>
- <li><a href="../../../../../../org/apache/commons/compress/archivers/dump/DumpArchiveSummary.html" title="class in org.apache.commons.compress.archivers.dump"><span class="strong">Next Class</span></a></li>
- </ul>
- <ul class="navList">
- <li><a href="../../../../../../index.html?org/apache/commons/compress/archivers/dump/DumpArchiveInputStream.html" target="_top">Frames</a></li>
- <li><a href="DumpArchiveInputStream.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><a href="#field_summary">Field</a> | </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><a href="#field_detail">Field</a> | </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.dump</div>
- <h2 title="Class DumpArchiveInputStream" class="title">Class DumpArchiveInputStream</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.dump.DumpArchiveInputStream</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></dd>
- </dl>
- <hr>
- <br>
- <pre>public class <a href="../../../../../../src-html/org/apache/commons/compress/archivers/dump/DumpArchiveInputStream.html#line.51">DumpArchiveInputStream</a>
- extends <a href="../../../../../../org/apache/commons/compress/archivers/ArchiveInputStream.html" title="class in org.apache.commons.compress.archivers">ArchiveInputStream</a></pre>
- <div class="block">The DumpArchiveInputStream reads a UNIX dump archive as an InputStream.
- Methods are provided to position at each successive entry in
- the archive, and the read each entry as a normal input stream
- using read().
- There doesn't seem to exist a hint on the encoding of string values
- in any piece documentation. Given the main purpose of dump/restore
- is backing up a system it seems very likely the format uses the
- current default encoding of the system.</div>
- <dl><dt><span class="strong">This class is not thread-safe</span></dt>
- <dd></dd></dl>
- </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>
- <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
- <caption><span>Fields</span><span class="tabEnd"> </span></caption>
- <tr>
- <th class="colFirst" scope="col">Modifier and Type</th>
- <th class="colLast" scope="col">Field and Description</th>
- </tr>
- <tr class="altColor">
- <td class="colFirst"><code>protected org.apache.commons.compress.archivers.dump.TapeInputStream</code></td>
- <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/dump/DumpArchiveInputStream.html#raw">raw</a></strong></code> </td>
- </tr>
- </table>
- </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/dump/DumpArchiveInputStream.html#DumpArchiveInputStream(java.io.InputStream)">DumpArchiveInputStream</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> is)</code>
- <div class="block">Constructor using the platform's default encoding for file
- names.</div>
- </td>
- </tr>
- <tr class="rowColor">
- <td class="colOne"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/dump/DumpArchiveInputStream.html#DumpArchiveInputStream(java.io.InputStream,%20java.lang.String)">DumpArchiveInputStream</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> is,
- <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">Constructor.</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>void</code></td>
- <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/dump/DumpArchiveInputStream.html#close()">close</a></strong>()</code>
- <div class="block">Closes the stream for this entry.</div>
- </td>
- </tr>
- <tr class="rowColor">
- <td class="colFirst"><code>long</code></td>
- <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/dump/DumpArchiveInputStream.html#getBytesRead()">getBytesRead</a></strong>()</code>
- <div class="block">Returns the current number of bytes read from this stream.</div>
- </td>
- </tr>
- <tr class="altColor">
- <td class="colFirst"><code>int</code></td>
- <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/dump/DumpArchiveInputStream.html#getCount()">getCount</a></strong>()</code>
- <div class="block"><strong>Deprecated.</strong> </div>
- </td>
- </tr>
- <tr class="rowColor">
- <td class="colFirst"><code><a href="../../../../../../org/apache/commons/compress/archivers/dump/DumpArchiveEntry.html" title="class in org.apache.commons.compress.archivers.dump">DumpArchiveEntry</a></code></td>
- <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/dump/DumpArchiveInputStream.html#getNextDumpEntry()">getNextDumpEntry</a></strong>()</code>
- <div class="block">Read the next entry.</div>
- </td>
- </tr>
- <tr class="altColor">
- <td class="colFirst"><code><a href="../../../../../../org/apache/commons/compress/archivers/dump/DumpArchiveEntry.html" title="class in org.apache.commons.compress.archivers.dump">DumpArchiveEntry</a></code></td>
- <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/dump/DumpArchiveInputStream.html#getNextEntry()">getNextEntry</a></strong>()</code>
- <div class="block">Returns the next Archive Entry in this Stream.</div>
- </td>
- </tr>
- <tr class="rowColor">
- <td class="colFirst"><code><a href="../../../../../../org/apache/commons/compress/archivers/dump/DumpArchiveSummary.html" title="class in org.apache.commons.compress.archivers.dump">DumpArchiveSummary</a></code></td>
- <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/dump/DumpArchiveInputStream.html#getSummary()">getSummary</a></strong>()</code>
- <div class="block">Return the archive summary information.</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/dump/DumpArchiveInputStream.html#matches(byte[],%20int)">matches</a></strong>(byte[] buffer,
- int length)</code>
- <div class="block">Look at the first few bytes of the file to decide if it's a dump
- archive.</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/dump/DumpArchiveInputStream.html#read(byte[],%20int,%20int)">read</a></strong>(byte[] buf,
- int off,
- int len)</code>
- <div class="block">Reads bytes from the current dump archive 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#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#available()" title="class or interface in java.io">available</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true#mark(int)" title="class or interface in java.io">mark</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true#markSupported()" title="class or interface in java.io">markSupported</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true#read(byte[])" title="class or interface in java.io">read</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true#reset()" title="class or interface in java.io">reset</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true#skip(long)" title="class or interface in java.io">skip</a></code></li>
- </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">
- <!-- ============ FIELD DETAIL =========== -->
- <ul class="blockList">
- <li class="blockList"><a name="field_detail">
- <!-- -->
- </a>
- <h3>Field Detail</h3>
- <a name="raw">
- <!-- -->
- </a>
- <ul class="blockListLast">
- <li class="blockList">
- <h4>raw</h4>
- <pre>protected org.apache.commons.compress.archivers.dump.TapeInputStream <a href="../../../../../../src-html/org/apache/commons/compress/archivers/dump/DumpArchiveInputStream.html#line.63">raw</a></pre>
- </li>
- </ul>
- </li>
- </ul>
- <!-- ========= CONSTRUCTOR DETAIL ======== -->
- <ul class="blockList">
- <li class="blockList"><a name="constructor_detail">
- <!-- -->
- </a>
- <h3>Constructor Detail</h3>
- <a name="DumpArchiveInputStream(java.io.InputStream)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>DumpArchiveInputStream</h4>
- <pre>public <a href="../../../../../../src-html/org/apache/commons/compress/archivers/dump/DumpArchiveInputStream.html#line.89">DumpArchiveInputStream</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> is)
- throws <a href="../../../../../../org/apache/commons/compress/archivers/ArchiveException.html" title="class in org.apache.commons.compress.archivers">ArchiveException</a></pre>
- <div class="block">Constructor using the platform's default encoding for file
- names.</div>
- <dl><dt><span class="strong">Parameters:</span></dt><dd><code>is</code> - stream to read from</dd>
- <dt><span class="strong">Throws:</span></dt>
- <dd><code><a href="../../../../../../org/apache/commons/compress/archivers/ArchiveException.html" title="class in org.apache.commons.compress.archivers">ArchiveException</a></code> - on error</dd></dl>
- </li>
- </ul>
- <a name="DumpArchiveInputStream(java.io.InputStream, java.lang.String)">
- <!-- -->
- </a>
- <ul class="blockListLast">
- <li class="blockList">
- <h4>DumpArchiveInputStream</h4>
- <pre>public <a href="../../../../../../src-html/org/apache/commons/compress/archivers/dump/DumpArchiveInputStream.html#line.102">DumpArchiveInputStream</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> is,
- <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)
- throws <a href="../../../../../../org/apache/commons/compress/archivers/ArchiveException.html" title="class in org.apache.commons.compress.archivers">ArchiveException</a></pre>
- <div class="block">Constructor.</div>
- <dl><dt><span class="strong">Parameters:</span></dt><dd><code>is</code> - stream to read from</dd><dd><code>encoding</code> - the encoding to use for file names, use null
- for the platform's default encoding</dd>
- <dt><span class="strong">Throws:</span></dt>
- <dd><code><a href="../../../../../../org/apache/commons/compress/archivers/ArchiveException.html" title="class in org.apache.commons.compress.archivers">ArchiveException</a></code> - on error</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="getCount()">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getCount</h4>
- <pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
- public int <a href="../../../../../../src-html/org/apache/commons/compress/archivers/dump/DumpArchiveInputStream.html#line.154">getCount</a>()</pre>
- <div class="block"><span class="strong">Deprecated.</span> </div>
- <div class="block"><strong>Description copied from class: <code><a href="../../../../../../org/apache/commons/compress/archivers/ArchiveInputStream.html#getCount()">ArchiveInputStream</a></code></strong></div>
- <div class="block">Returns the current number of bytes read from this stream.</div>
- <dl>
- <dt><strong>Overrides:</strong></dt>
- <dd><code><a href="../../../../../../org/apache/commons/compress/archivers/ArchiveInputStream.html#getCount()">getCount</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 number of read bytes</dd></dl>
- </li>
- </ul>
- <a name="getBytesRead()">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getBytesRead</h4>
- <pre>public long <a href="../../../../../../src-html/org/apache/commons/compress/archivers/dump/DumpArchiveInputStream.html#line.159">getBytesRead</a>()</pre>
- <div class="block"><strong>Description copied from class: <code><a href="../../../../../../org/apache/commons/compress/archivers/ArchiveInputStream.html#getBytesRead()">ArchiveInputStream</a></code></strong></div>
- <div class="block">Returns the current number of bytes read from this stream.</div>
- <dl>
- <dt><strong>Overrides:</strong></dt>
- <dd><code><a href="../../../../../../org/apache/commons/compress/archivers/ArchiveInputStream.html#getBytesRead()">getBytesRead</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 number of read bytes</dd></dl>
- </li>
- </ul>
- <a name="getSummary()">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getSummary</h4>
- <pre>public <a href="../../../../../../org/apache/commons/compress/archivers/dump/DumpArchiveSummary.html" title="class in org.apache.commons.compress.archivers.dump">DumpArchiveSummary</a> <a href="../../../../../../src-html/org/apache/commons/compress/archivers/dump/DumpArchiveInputStream.html#line.167">getSummary</a>()</pre>
- <div class="block">Return the archive summary information.</div>
- <dl><dt><span class="strong">Returns:</span></dt><dd>the summary</dd></dl>
- </li>
- </ul>
- <a name="getNextDumpEntry()">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getNextDumpEntry</h4>
- <pre>public <a href="../../../../../../org/apache/commons/compress/archivers/dump/DumpArchiveEntry.html" title="class in org.apache.commons.compress.archivers.dump">DumpArchiveEntry</a> <a href="../../../../../../src-html/org/apache/commons/compress/archivers/dump/DumpArchiveInputStream.html#line.224">getNextDumpEntry</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">Read the next entry.</div>
- <dl><dt><span class="strong">Returns:</span></dt><dd>the next 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> - on error</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/dump/DumpArchiveEntry.html" title="class in org.apache.commons.compress.archivers.dump">DumpArchiveEntry</a> <a href="../../../../../../src-html/org/apache/commons/compress/archivers/dump/DumpArchiveInputStream.html#line.229">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="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/dump/DumpArchiveInputStream.html#line.467">read</a>(byte[] buf,
- 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 bytes from the current dump archive entry.
- This method is aware of the boundaries of the current
- entry in the archive and will deal with them as if they
- were this stream's start and EOF.</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>buf</code> - The buffer into which to place bytes read.</dd><dd><code>off</code> - The offset at which to place bytes read.</dd><dd><code>len</code> - The number of bytes to read.</dd>
- <dt><span class="strong">Returns:</span></dt><dd>The number of bytes read, or -1 at EOF.</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> - on error</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/dump/DumpArchiveInputStream.html#line.530">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 stream for this entry.</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></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/dump/DumpArchiveInputStream.html#line.545">matches</a>(byte[] buffer,
- int length)</pre>
- <div class="block">Look at the first few bytes of the file to decide if it's a dump
- archive. With 32 bytes we can look at the magic value, with a full
- 1k we can verify the checksum.</div>
- <dl><dt><span class="strong">Parameters:</span></dt><dd><code>buffer</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 dump 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/DumpArchiveInputStream.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/dump/DumpArchiveException.html" title="class in org.apache.commons.compress.archivers.dump"><span class="strong">Prev Class</span></a></li>
- <li><a href="../../../../../../org/apache/commons/compress/archivers/dump/DumpArchiveSummary.html" title="class in org.apache.commons.compress.archivers.dump"><span class="strong">Next Class</span></a></li>
- </ul>
- <ul class="navList">
- <li><a href="../../../../../../index.html?org/apache/commons/compress/archivers/dump/DumpArchiveInputStream.html" target="_top">Frames</a></li>
- <li><a href="DumpArchiveInputStream.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><a href="#field_summary">Field</a> | </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><a href="#field_detail">Field</a> | </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>
|