123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572 |
- <!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>SevenZFile (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="SevenZFile (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/SevenZFile.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/sevenz/SevenZArchiveEntry.html" title="class in org.apache.commons.compress.archivers.sevenz"><span class="strong">Prev Class</span></a></li>
- <li><a href="../../../../../../org/apache/commons/compress/archivers/sevenz/SevenZMethod.html" title="enum in org.apache.commons.compress.archivers.sevenz"><span class="strong">Next Class</span></a></li>
- </ul>
- <ul class="navList">
- <li><a href="../../../../../../index.html?org/apache/commons/compress/archivers/sevenz/SevenZFile.html" target="_top">Frames</a></li>
- <li><a href="SevenZFile.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.sevenz</div>
- <h2 title="Class SevenZFile" class="title">Class SevenZFile</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>org.apache.commons.compress.archivers.sevenz.SevenZFile</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/sevenz/SevenZFile.html#line.73">SevenZFile</a>
- extends <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>
- implements <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></pre>
- <div class="block">Reads a 7z file, using SeekableByteChannel under
- the covers.
- <p>
- The 7z file format is a flexible container
- that can contain many compression and
- encryption types, but at the moment only
- only Copy, LZMA, LZMA2, BZIP2, Deflate and AES-256 + SHA-256
- are supported.
- <p>
- The format is very Windows/Intel specific,
- so it uses little-endian byte order,
- doesn't store user/group or permission bits,
- and represents times using NTFS timestamps
- (100 nanosecond units since 1 January 1601).
- Hence the official tools recommend against
- using it for backup purposes on *nix, and
- recommend .tar.7z or .tar.lzma or .tar.xz
- instead.
- <p>
- Both the header and file contents may be
- compressed and/or encrypted. With both
- encrypted, neither file names nor file
- contents can be read, but the use of
- encryption isn't plausibly deniable.</div>
- <dl><dt><span class="strong">Since:</span></dt>
- <dd>1.6</dd>
- <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">
- <!-- ======== 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/sevenz/SevenZFile.html#SevenZFile(java.io.File)">SevenZFile</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> filename)</code>
- <div class="block">Reads a file as unencrypted 7z archive</div>
- </td>
- </tr>
- <tr class="rowColor">
- <td class="colOne"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/sevenz/SevenZFile.html#SevenZFile(java.io.File,%20byte[])">SevenZFile</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> filename,
- byte[] password)</code>
- <div class="block">Reads a file as 7z archive</div>
- </td>
- </tr>
- <tr class="altColor">
- <td class="colOne"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/sevenz/SevenZFile.html#SevenZFile(java.nio.channels.SeekableByteChannel)">SevenZFile</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/nio/channels/SeekableByteChannel.html?is-external=true" title="class or interface in java.nio.channels">SeekableByteChannel</a> channel)</code>
- <div class="block">Reads a SeekableByteChannel as 7z archive
- <a href="../../../../../../org/apache/commons/compress/utils/SeekableInMemoryByteChannel.html" title="class in org.apache.commons.compress.utils"><code>SeekableInMemoryByteChannel</code></a>
- allows you to read from an in-memory archive.</div>
- </td>
- </tr>
- <tr class="rowColor">
- <td class="colOne"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/sevenz/SevenZFile.html#SevenZFile(java.nio.channels.SeekableByteChannel,%20byte[])">SevenZFile</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/nio/channels/SeekableByteChannel.html?is-external=true" title="class or interface in java.nio.channels">SeekableByteChannel</a> channel,
- byte[] password)</code>
- <div class="block">Reads a SeekableByteChannel as 7z archive
- <a href="../../../../../../org/apache/commons/compress/utils/SeekableInMemoryByteChannel.html" title="class in org.apache.commons.compress.utils"><code>SeekableInMemoryByteChannel</code></a>
- allows you to read from an in-memory archive.</div>
- </td>
- </tr>
- <tr class="altColor">
- <td class="colOne"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/sevenz/SevenZFile.html#SevenZFile(java.nio.channels.SeekableByteChannel,%20java.lang.String,%20byte[])">SevenZFile</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/nio/channels/SeekableByteChannel.html?is-external=true" title="class or interface in java.nio.channels">SeekableByteChannel</a> channel,
- <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> filename,
- byte[] password)</code>
- <div class="block">Reads a SeekableByteChannel as 7z archive
- <a href="../../../../../../org/apache/commons/compress/utils/SeekableInMemoryByteChannel.html" title="class in org.apache.commons.compress.utils"><code>SeekableInMemoryByteChannel</code></a>
- allows you to read from an in-memory archive.</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/sevenz/SevenZFile.html#close()">close</a></strong>()</code>
- <div class="block">Closes the archive.</div>
- </td>
- </tr>
- <tr class="rowColor">
- <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><<a href="../../../../../../org/apache/commons/compress/archivers/sevenz/SevenZArchiveEntry.html" title="class in org.apache.commons.compress.archivers.sevenz">SevenZArchiveEntry</a>></code></td>
- <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/sevenz/SevenZFile.html#getEntries()">getEntries</a></strong>()</code>
- <div class="block">Returns meta-data of all archive entries.</div>
- </td>
- </tr>
- <tr class="altColor">
- <td class="colFirst"><code><a href="../../../../../../org/apache/commons/compress/archivers/sevenz/SevenZArchiveEntry.html" title="class in org.apache.commons.compress.archivers.sevenz">SevenZArchiveEntry</a></code></td>
- <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/sevenz/SevenZFile.html#getNextEntry()">getNextEntry</a></strong>()</code>
- <div class="block">Returns the next Archive Entry in this archive.</div>
- </td>
- </tr>
- <tr class="rowColor">
- <td class="colFirst"><code>static boolean</code></td>
- <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/sevenz/SevenZFile.html#matches(byte[],%20int)">matches</a></strong>(byte[] signature,
- int length)</code>
- <div class="block">Checks if the signature matches what is expected for a 7z file.</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/sevenz/SevenZFile.html#read()">read</a></strong>()</code>
- <div class="block">Reads a byte of data.</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/sevenz/SevenZFile.html#read(byte[])">read</a></strong>(byte[] b)</code>
- <div class="block">Reads data into an array of bytes.</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/sevenz/SevenZFile.html#read(byte[],%20int,%20int)">read</a></strong>(byte[] b,
- int off,
- int len)</code>
- <div class="block">Reads data into an array of bytes.</div>
- </td>
- </tr>
- <tr class="rowColor">
- <td class="colFirst"><code><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></code></td>
- <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/sevenz/SevenZFile.html#toString()">toString</a></strong>()</code> </td>
- </tr>
- </table>
- <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#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="SevenZFile(java.io.File, byte[])">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>SevenZFile</h4>
- <pre>public <a href="../../../../../../src-html/org/apache/commons/compress/archivers/sevenz/SevenZFile.html#line.100">SevenZFile</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> filename,
- byte[] password)
- 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 a file as 7z archive</div>
- <dl><dt><span class="strong">Parameters:</span></dt><dd><code>filename</code> - the file to read</dd><dd><code>password</code> - optional password if the archive is encrypted -
- the byte array is supposed to be the UTF16-LE encoded
- representation of the password.</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 reading the archive fails</dd></dl>
- </li>
- </ul>
- <a name="SevenZFile(java.nio.channels.SeekableByteChannel)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>SevenZFile</h4>
- <pre>public <a href="../../../../../../src-html/org/apache/commons/compress/archivers/sevenz/SevenZFile.html#line.116">SevenZFile</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/nio/channels/SeekableByteChannel.html?is-external=true" title="class or interface in java.nio.channels">SeekableByteChannel</a> channel)
- 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 a SeekableByteChannel as 7z archive
- <p><a href="../../../../../../org/apache/commons/compress/utils/SeekableInMemoryByteChannel.html" title="class in org.apache.commons.compress.utils"><code>SeekableInMemoryByteChannel</code></a>
- allows you to read from an in-memory archive.</p></div>
- <dl><dt><span class="strong">Parameters:</span></dt><dd><code>channel</code> - the channel to 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 reading the archive fails</dd><dt><span class="strong">Since:</span></dt>
- <dd>1.13</dd></dl>
- </li>
- </ul>
- <a name="SevenZFile(java.nio.channels.SeekableByteChannel, byte[])">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>SevenZFile</h4>
- <pre>public <a href="../../../../../../src-html/org/apache/commons/compress/archivers/sevenz/SevenZFile.html#line.134">SevenZFile</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/nio/channels/SeekableByteChannel.html?is-external=true" title="class or interface in java.nio.channels">SeekableByteChannel</a> channel,
- byte[] password)
- 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 a SeekableByteChannel as 7z archive
- <p><a href="../../../../../../org/apache/commons/compress/utils/SeekableInMemoryByteChannel.html" title="class in org.apache.commons.compress.utils"><code>SeekableInMemoryByteChannel</code></a>
- allows you to read from an in-memory archive.</p></div>
- <dl><dt><span class="strong">Parameters:</span></dt><dd><code>channel</code> - the channel to read</dd><dd><code>password</code> - optional password if the archive is encrypted -
- the byte array is supposed to be the UTF16-LE encoded
- representation of the password.</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 reading the archive fails</dd><dt><span class="strong">Since:</span></dt>
- <dd>1.13</dd></dl>
- </li>
- </ul>
- <a name="SevenZFile(java.nio.channels.SeekableByteChannel, java.lang.String, byte[])">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>SevenZFile</h4>
- <pre>public <a href="../../../../../../src-html/org/apache/commons/compress/archivers/sevenz/SevenZFile.html#line.154">SevenZFile</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/nio/channels/SeekableByteChannel.html?is-external=true" title="class or interface in java.nio.channels">SeekableByteChannel</a> channel,
- <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> filename,
- byte[] password)
- 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 a SeekableByteChannel as 7z archive
- <p><a href="../../../../../../org/apache/commons/compress/utils/SeekableInMemoryByteChannel.html" title="class in org.apache.commons.compress.utils"><code>SeekableInMemoryByteChannel</code></a>
- allows you to read from an in-memory archive.</p></div>
- <dl><dt><span class="strong">Parameters:</span></dt><dd><code>channel</code> - the channel to read</dd><dd><code>filename</code> - name of the archive - only used for error reporting</dd><dd><code>password</code> - optional password if the archive is encrypted -
- the byte array is supposed to be the UTF16-LE encoded
- representation of the password.</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 reading the archive fails</dd><dt><span class="strong">Since:</span></dt>
- <dd>1.13</dd></dl>
- </li>
- </ul>
- <a name="SevenZFile(java.io.File)">
- <!-- -->
- </a>
- <ul class="blockListLast">
- <li class="blockList">
- <h4>SevenZFile</h4>
- <pre>public <a href="../../../../../../src-html/org/apache/commons/compress/archivers/sevenz/SevenZFile.html#line.186">SevenZFile</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> filename)
- 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 a file as unencrypted 7z archive</div>
- <dl><dt><span class="strong">Parameters:</span></dt><dd><code>filename</code> - the file to 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 reading the archive fails</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="close()">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>close</h4>
- <pre>public void <a href="../../../../../../src-html/org/apache/commons/compress/archivers/sevenz/SevenZFile.html#line.195">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 archive.</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><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 closing the file fails</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/sevenz/SevenZArchiveEntry.html" title="class in org.apache.commons.compress.archivers.sevenz">SevenZArchiveEntry</a> <a href="../../../../../../src-html/org/apache/commons/compress/archivers/sevenz/SevenZFile.html#line.216">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">Returns the next Archive Entry in this archive.</div>
- <dl><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="getEntries()">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getEntries</h4>
- <pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><<a href="../../../../../../org/apache/commons/compress/archivers/sevenz/SevenZArchiveEntry.html" title="class in org.apache.commons.compress.archivers.sevenz">SevenZArchiveEntry</a>> <a href="../../../../../../src-html/org/apache/commons/compress/archivers/sevenz/SevenZFile.html#line.239">getEntries</a>()</pre>
- <div class="block">Returns meta-data of all archive entries.
- <p>This method only provides meta-data, the entries can not be
- used to read the contents, you still need to process all
- entries in order using <a href="../../../../../../org/apache/commons/compress/archivers/sevenz/SevenZFile.html#getNextEntry()"><code>getNextEntry()</code></a> for that.</p>
- <p>The content methods are only available for entries that have
- already been reached via <a href="../../../../../../org/apache/commons/compress/archivers/sevenz/SevenZFile.html#getNextEntry()"><code>getNextEntry()</code></a>.</p></div>
- <dl><dt><span class="strong">Returns:</span></dt><dd>meta-data of all archive entries.</dd><dt><span class="strong">Since:</span></dt>
- <dd>1.11</dd></dl>
- </li>
- </ul>
- <a name="read()">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>read</h4>
- <pre>public int <a href="../../../../../../src-html/org/apache/commons/compress/archivers/sevenz/SevenZFile.html#line.953">read</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 a byte of data.</div>
- <dl><dt><span class="strong">Returns:</span></dt><dd>the byte read, or -1 if end of input 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</dd></dl>
- </li>
- </ul>
- <a name="read(byte[])">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>read</h4>
- <pre>public int <a href="../../../../../../src-html/org/apache/commons/compress/archivers/sevenz/SevenZFile.html#line.985">read</a>(byte[] b)
- 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 data into an array of bytes.</div>
- <dl><dt><span class="strong">Parameters:</span></dt><dd><code>b</code> - the array to write data to</dd>
- <dt><span class="strong">Returns:</span></dt><dd>the number of bytes read, or -1 if end of input 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</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/sevenz/SevenZFile.html#line.999">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 data into an array of bytes.</div>
- <dl><dt><span class="strong">Parameters:</span></dt><dd><code>b</code> - the array to write data to</dd><dd><code>off</code> - offset into the buffer to start filling at</dd><dd><code>len</code> - of bytes to read</dd>
- <dt><span class="strong">Returns:</span></dt><dd>the number of bytes read, or -1 if end of input 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</dd></dl>
- </li>
- </ul>
- <a name="matches(byte[], int)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>matches</h4>
- <pre>public static boolean <a href="../../../../../../src-html/org/apache/commons/compress/archivers/sevenz/SevenZFile.html#line.1033">matches</a>(byte[] signature,
- int length)</pre>
- <div class="block">Checks if the signature matches what is expected for a 7z file.</div>
- <dl><dt><span class="strong">Parameters:</span></dt><dd><code>signature</code> - the bytes to check</dd><dd><code>length</code> - the number of bytes to check</dd>
- <dt><span class="strong">Returns:</span></dt><dd>true, if this is the signature of a 7z archive.</dd><dt><span class="strong">Since:</span></dt>
- <dd>1.8</dd></dl>
- </li>
- </ul>
- <a name="toString()">
- <!-- -->
- </a>
- <ul class="blockListLast">
- <li class="blockList">
- <h4>toString</h4>
- <pre>public <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> <a href="../../../../../../src-html/org/apache/commons/compress/archivers/sevenz/SevenZFile.html#line.1066">toString</a>()</pre>
- <dl>
- <dt><strong>Overrides:</strong></dt>
- <dd><code><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></code> in class <code><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></code></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/SevenZFile.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/sevenz/SevenZArchiveEntry.html" title="class in org.apache.commons.compress.archivers.sevenz"><span class="strong">Prev Class</span></a></li>
- <li><a href="../../../../../../org/apache/commons/compress/archivers/sevenz/SevenZMethod.html" title="enum in org.apache.commons.compress.archivers.sevenz"><span class="strong">Next Class</span></a></li>
- </ul>
- <ul class="navList">
- <li><a href="../../../../../../index.html?org/apache/commons/compress/archivers/sevenz/SevenZFile.html" target="_top">Frames</a></li>
- <li><a href="SevenZFile.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>
|