SevenZOutputFile.html 31 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <!-- NewPage -->
  3. <html lang="de">
  4. <head>
  5. <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
  6. <title>SevenZOutputFile (Apache Commons Compress 1.13 API)</title>
  7. <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
  8. </head>
  9. <body>
  10. <script type="text/javascript"><!--
  11. try {
  12. if (location.href.indexOf('is-external=true') == -1) {
  13. parent.document.title="SevenZOutputFile (Apache Commons Compress 1.13 API)";
  14. }
  15. }
  16. catch(err) {
  17. }
  18. //-->
  19. </script>
  20. <noscript>
  21. <div>JavaScript is disabled on your browser.</div>
  22. </noscript>
  23. <!-- ========= START OF TOP NAVBAR ======= -->
  24. <div class="topNav"><a name="navbar_top">
  25. <!-- -->
  26. </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
  27. <!-- -->
  28. </a>
  29. <ul class="navList" title="Navigation">
  30. <li><a href="../../../../../../overview-summary.html">Overview</a></li>
  31. <li><a href="package-summary.html">Package</a></li>
  32. <li class="navBarCell1Rev">Class</li>
  33. <li><a href="class-use/SevenZOutputFile.html">Use</a></li>
  34. <li><a href="package-tree.html">Tree</a></li>
  35. <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
  36. <li><a href="../../../../../../index-all.html">Index</a></li>
  37. <li><a href="../../../../../../help-doc.html">Help</a></li>
  38. </ul>
  39. </div>
  40. <div class="subNav">
  41. <ul class="navList">
  42. <li><a href="../../../../../../org/apache/commons/compress/archivers/sevenz/SevenZMethodConfiguration.html" title="class in org.apache.commons.compress.archivers.sevenz"><span class="strong">Prev Class</span></a></li>
  43. <li>Next Class</li>
  44. </ul>
  45. <ul class="navList">
  46. <li><a href="../../../../../../index.html?org/apache/commons/compress/archivers/sevenz/SevenZOutputFile.html" target="_top">Frames</a></li>
  47. <li><a href="SevenZOutputFile.html" target="_top">No Frames</a></li>
  48. </ul>
  49. <ul class="navList" id="allclasses_navbar_top">
  50. <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
  51. </ul>
  52. <div>
  53. <script type="text/javascript"><!--
  54. allClassesLink = document.getElementById("allclasses_navbar_top");
  55. if(window==top) {
  56. allClassesLink.style.display = "block";
  57. }
  58. else {
  59. allClassesLink.style.display = "none";
  60. }
  61. //-->
  62. </script>
  63. </div>
  64. <div>
  65. <ul class="subNavList">
  66. <li>Summary:&nbsp;</li>
  67. <li>Nested&nbsp;|&nbsp;</li>
  68. <li>Field&nbsp;|&nbsp;</li>
  69. <li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
  70. <li><a href="#method_summary">Method</a></li>
  71. </ul>
  72. <ul class="subNavList">
  73. <li>Detail:&nbsp;</li>
  74. <li>Field&nbsp;|&nbsp;</li>
  75. <li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
  76. <li><a href="#method_detail">Method</a></li>
  77. </ul>
  78. </div>
  79. <a name="skip-navbar_top">
  80. <!-- -->
  81. </a></div>
  82. <!-- ========= END OF TOP NAVBAR ========= -->
  83. <!-- ======== START OF CLASS DATA ======== -->
  84. <div class="header">
  85. <div class="subTitle">org.apache.commons.compress.archivers.sevenz</div>
  86. <h2 title="Class SevenZOutputFile" class="title">Class SevenZOutputFile</h2>
  87. </div>
  88. <div class="contentContainer">
  89. <ul class="inheritance">
  90. <li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
  91. <li>
  92. <ul class="inheritance">
  93. <li>org.apache.commons.compress.archivers.sevenz.SevenZOutputFile</li>
  94. </ul>
  95. </li>
  96. </ul>
  97. <div class="description">
  98. <ul class="blockList">
  99. <li class="blockList">
  100. <dl>
  101. <dt>All Implemented Interfaces:</dt>
  102. <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>
  103. </dl>
  104. <hr>
  105. <br>
  106. <pre>public class <a href="../../../../../../src-html/org/apache/commons/compress/archivers/sevenz/SevenZOutputFile.html#line.50">SevenZOutputFile</a>
  107. 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>
  108. 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>
  109. <div class="block">Writes a 7z file.</div>
  110. <dl><dt><span class="strong">Since:</span></dt>
  111. <dd>1.6</dd></dl>
  112. </li>
  113. </ul>
  114. </div>
  115. <div class="summary">
  116. <ul class="blockList">
  117. <li class="blockList">
  118. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  119. <ul class="blockList">
  120. <li class="blockList"><a name="constructor_summary">
  121. <!-- -->
  122. </a>
  123. <h3>Constructor Summary</h3>
  124. <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  125. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  126. <tr>
  127. <th class="colOne" scope="col">Constructor and Description</th>
  128. </tr>
  129. <tr class="altColor">
  130. <td class="colOne"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/sevenz/SevenZOutputFile.html#SevenZOutputFile(java.io.File)">SevenZOutputFile</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>&nbsp;filename)</code>
  131. <div class="block">Opens file to write a 7z archive to.</div>
  132. </td>
  133. </tr>
  134. <tr class="rowColor">
  135. <td class="colOne"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/sevenz/SevenZOutputFile.html#SevenZOutputFile(java.nio.channels.SeekableByteChannel)">SevenZOutputFile</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>&nbsp;channel)</code>
  136. <div class="block">Prepares channel to write a 7z archive to.</div>
  137. </td>
  138. </tr>
  139. </table>
  140. </li>
  141. </ul>
  142. <!-- ========== METHOD SUMMARY =========== -->
  143. <ul class="blockList">
  144. <li class="blockList"><a name="method_summary">
  145. <!-- -->
  146. </a>
  147. <h3>Method Summary</h3>
  148. <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  149. <caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
  150. <tr>
  151. <th class="colFirst" scope="col">Modifier and Type</th>
  152. <th class="colLast" scope="col">Method and Description</th>
  153. </tr>
  154. <tr class="altColor">
  155. <td class="colFirst"><code>void</code></td>
  156. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/sevenz/SevenZOutputFile.html#close()">close</a></strong>()</code>
  157. <div class="block">Closes the archive, calling <a href="../../../../../../org/apache/commons/compress/archivers/sevenz/SevenZOutputFile.html#finish()"><code>finish()</code></a> if necessary.</div>
  158. </td>
  159. </tr>
  160. <tr class="rowColor">
  161. <td class="colFirst"><code>void</code></td>
  162. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/sevenz/SevenZOutputFile.html#closeArchiveEntry()">closeArchiveEntry</a></strong>()</code>
  163. <div class="block">Closes the archive entry.</div>
  164. </td>
  165. </tr>
  166. <tr class="altColor">
  167. <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>
  168. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/sevenz/SevenZOutputFile.html#createArchiveEntry(java.io.File,%20java.lang.String)">createArchiveEntry</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>&nbsp;inputFile,
  169. <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;entryName)</code>
  170. <div class="block">Create an archive entry using the inputFile and entryName provided.</div>
  171. </td>
  172. </tr>
  173. <tr class="rowColor">
  174. <td class="colFirst"><code>void</code></td>
  175. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/sevenz/SevenZOutputFile.html#finish()">finish</a></strong>()</code>
  176. <div class="block">Finishes the addition of entries to this archive, without closing it.</div>
  177. </td>
  178. </tr>
  179. <tr class="altColor">
  180. <td class="colFirst"><code>void</code></td>
  181. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/sevenz/SevenZOutputFile.html#putArchiveEntry(org.apache.commons.compress.archivers.ArchiveEntry)">putArchiveEntry</a></strong>(<a href="../../../../../../org/apache/commons/compress/archivers/ArchiveEntry.html" title="interface in org.apache.commons.compress.archivers">ArchiveEntry</a>&nbsp;archiveEntry)</code>
  182. <div class="block">Records an archive entry to add.</div>
  183. </td>
  184. </tr>
  185. <tr class="rowColor">
  186. <td class="colFirst"><code>void</code></td>
  187. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/sevenz/SevenZOutputFile.html#setContentCompression(org.apache.commons.compress.archivers.sevenz.SevenZMethod)">setContentCompression</a></strong>(<a href="../../../../../../org/apache/commons/compress/archivers/sevenz/SevenZMethod.html" title="enum in org.apache.commons.compress.archivers.sevenz">SevenZMethod</a>&nbsp;method)</code>
  188. <div class="block">Sets the default compression method to use for entry contents - the
  189. default is LZMA2.</div>
  190. </td>
  191. </tr>
  192. <tr class="altColor">
  193. <td class="colFirst"><code>void</code></td>
  194. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/sevenz/SevenZOutputFile.html#setContentMethods(java.lang.Iterable)">setContentMethods</a></strong>(<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>&lt;? extends <a href="../../../../../../org/apache/commons/compress/archivers/sevenz/SevenZMethodConfiguration.html" title="class in org.apache.commons.compress.archivers.sevenz">SevenZMethodConfiguration</a>&gt;&nbsp;methods)</code>
  195. <div class="block">Sets the default (compression) methods to use for entry contents - the
  196. default is LZMA2.</div>
  197. </td>
  198. </tr>
  199. <tr class="rowColor">
  200. <td class="colFirst"><code>void</code></td>
  201. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/sevenz/SevenZOutputFile.html#write(byte[])">write</a></strong>(byte[]&nbsp;b)</code>
  202. <div class="block">Writes a byte array to the current archive entry.</div>
  203. </td>
  204. </tr>
  205. <tr class="altColor">
  206. <td class="colFirst"><code>void</code></td>
  207. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/sevenz/SevenZOutputFile.html#write(byte[],%20int,%20int)">write</a></strong>(byte[]&nbsp;b,
  208. int&nbsp;off,
  209. int&nbsp;len)</code>
  210. <div class="block">Writes part of a byte array to the current archive entry.</div>
  211. </td>
  212. </tr>
  213. <tr class="rowColor">
  214. <td class="colFirst"><code>void</code></td>
  215. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/sevenz/SevenZOutputFile.html#write(int)">write</a></strong>(int&nbsp;b)</code>
  216. <div class="block">Writes a byte to the current archive entry.</div>
  217. </td>
  218. </tr>
  219. </table>
  220. <ul class="blockList">
  221. <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
  222. <!-- -->
  223. </a>
  224. <h3>Methods inherited from class&nbsp;java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
  225. <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>
  226. </ul>
  227. </li>
  228. </ul>
  229. </li>
  230. </ul>
  231. </div>
  232. <div class="details">
  233. <ul class="blockList">
  234. <li class="blockList">
  235. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  236. <ul class="blockList">
  237. <li class="blockList"><a name="constructor_detail">
  238. <!-- -->
  239. </a>
  240. <h3>Constructor Detail</h3>
  241. <a name="SevenZOutputFile(java.io.File)">
  242. <!-- -->
  243. </a>
  244. <ul class="blockList">
  245. <li class="blockList">
  246. <h4>SevenZOutputFile</h4>
  247. <pre>public&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/sevenz/SevenZOutputFile.html#line.70">SevenZOutputFile</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>&nbsp;filename)
  248. 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>
  249. <div class="block">Opens file to write a 7z archive to.</div>
  250. <dl><dt><span class="strong">Parameters:</span></dt><dd><code>filename</code> - the file to write to</dd>
  251. <dt><span class="strong">Throws:</span></dt>
  252. <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 opening the file fails</dd></dl>
  253. </li>
  254. </ul>
  255. <a name="SevenZOutputFile(java.nio.channels.SeekableByteChannel)">
  256. <!-- -->
  257. </a>
  258. <ul class="blockListLast">
  259. <li class="blockList">
  260. <h4>SevenZOutputFile</h4>
  261. <pre>public&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/sevenz/SevenZOutputFile.html#line.87">SevenZOutputFile</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>&nbsp;channel)
  262. 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>
  263. <div class="block">Prepares channel to write a 7z archive to.
  264. <p><a href="../../../../../../org/apache/commons/compress/utils/SeekableInMemoryByteChannel.html" title="class in org.apache.commons.compress.utils"><code>SeekableInMemoryByteChannel</code></a>
  265. allows you to write to an in-memory archive.</p></div>
  266. <dl><dt><span class="strong">Parameters:</span></dt><dd><code>channel</code> - the channel to write to</dd>
  267. <dt><span class="strong">Throws:</span></dt>
  268. <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 channel cannot be positioned properly</dd><dt><span class="strong">Since:</span></dt>
  269. <dd>1.13</dd></dl>
  270. </li>
  271. </ul>
  272. </li>
  273. </ul>
  274. <!-- ============ METHOD DETAIL ========== -->
  275. <ul class="blockList">
  276. <li class="blockList"><a name="method_detail">
  277. <!-- -->
  278. </a>
  279. <h3>Method Detail</h3>
  280. <a name="setContentCompression(org.apache.commons.compress.archivers.sevenz.SevenZMethod)">
  281. <!-- -->
  282. </a>
  283. <ul class="blockList">
  284. <li class="blockList">
  285. <h4>setContentCompression</h4>
  286. <pre>public&nbsp;void&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/sevenz/SevenZOutputFile.html#line.104">setContentCompression</a>(<a href="../../../../../../org/apache/commons/compress/archivers/sevenz/SevenZMethod.html" title="enum in org.apache.commons.compress.archivers.sevenz">SevenZMethod</a>&nbsp;method)</pre>
  287. <div class="block">Sets the default compression method to use for entry contents - the
  288. default is LZMA2.
  289. <p>Currently only <a href="../../../../../../org/apache/commons/compress/archivers/sevenz/SevenZMethod.html#COPY"><code>SevenZMethod.COPY</code></a>, <a href="../../../../../../org/apache/commons/compress/archivers/sevenz/SevenZMethod.html#LZMA2"><code>SevenZMethod.LZMA2</code></a>, <a href="../../../../../../org/apache/commons/compress/archivers/sevenz/SevenZMethod.html#BZIP2"><code>SevenZMethod.BZIP2</code></a> and <a href="../../../../../../org/apache/commons/compress/archivers/sevenz/SevenZMethod.html#DEFLATE"><code>SevenZMethod.DEFLATE</code></a> are supported.</p>
  290. <p>This is a short form for passing a single-element iterable
  291. to <a href="../../../../../../org/apache/commons/compress/archivers/sevenz/SevenZOutputFile.html#setContentMethods(java.lang.Iterable)"><code>setContentMethods(java.lang.Iterable&lt;? extends org.apache.commons.compress.archivers.sevenz.SevenZMethodConfiguration&gt;)</code></a>.</p></div>
  292. <dl><dt><span class="strong">Parameters:</span></dt><dd><code>method</code> - the default compression method</dd></dl>
  293. </li>
  294. </ul>
  295. <a name="setContentMethods(java.lang.Iterable)">
  296. <!-- -->
  297. </a>
  298. <ul class="blockList">
  299. <li class="blockList">
  300. <h4>setContentMethods</h4>
  301. <pre>public&nbsp;void&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/sevenz/SevenZOutputFile.html#line.122">setContentMethods</a>(<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>&lt;? extends <a href="../../../../../../org/apache/commons/compress/archivers/sevenz/SevenZMethodConfiguration.html" title="class in org.apache.commons.compress.archivers.sevenz">SevenZMethodConfiguration</a>&gt;&nbsp;methods)</pre>
  302. <div class="block">Sets the default (compression) methods to use for entry contents - the
  303. default is LZMA2.
  304. <p>Currently only <a href="../../../../../../org/apache/commons/compress/archivers/sevenz/SevenZMethod.html#COPY"><code>SevenZMethod.COPY</code></a>, <a href="../../../../../../org/apache/commons/compress/archivers/sevenz/SevenZMethod.html#LZMA2"><code>SevenZMethod.LZMA2</code></a>, <a href="../../../../../../org/apache/commons/compress/archivers/sevenz/SevenZMethod.html#BZIP2"><code>SevenZMethod.BZIP2</code></a> and <a href="../../../../../../org/apache/commons/compress/archivers/sevenz/SevenZMethod.html#DEFLATE"><code>SevenZMethod.DEFLATE</code></a> are supported.</p>
  305. <p>The methods will be consulted in iteration order to create
  306. the final output.</p></div>
  307. <dl><dt><span class="strong">Parameters:</span></dt><dd><code>methods</code> - the default (compression) methods</dd><dt><span class="strong">Since:</span></dt>
  308. <dd>1.8</dd></dl>
  309. </li>
  310. </ul>
  311. <a name="close()">
  312. <!-- -->
  313. </a>
  314. <ul class="blockList">
  315. <li class="blockList">
  316. <h4>close</h4>
  317. <pre>public&nbsp;void&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/sevenz/SevenZOutputFile.html#line.132">close</a>()
  318. 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>
  319. <div class="block">Closes the archive, calling <a href="../../../../../../org/apache/commons/compress/archivers/sevenz/SevenZOutputFile.html#finish()"><code>finish()</code></a> if necessary.</div>
  320. <dl>
  321. <dt><strong>Specified by:</strong></dt>
  322. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Closeable.html?is-external=true#close()" title="class or interface in java.io">close</a></code>&nbsp;in interface&nbsp;<code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</a></code></dd>
  323. <dt><strong>Specified by:</strong></dt>
  324. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/AutoCloseable.html?is-external=true#close()" title="class or interface in java.lang">close</a></code>&nbsp;in interface&nbsp;<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></code></dd>
  325. <dt><span class="strong">Throws:</span></dt>
  326. <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>
  327. </li>
  328. </ul>
  329. <a name="createArchiveEntry(java.io.File, java.lang.String)">
  330. <!-- -->
  331. </a>
  332. <ul class="blockList">
  333. <li class="blockList">
  334. <h4>createArchiveEntry</h4>
  335. <pre>public&nbsp;<a href="../../../../../../org/apache/commons/compress/archivers/sevenz/SevenZArchiveEntry.html" title="class in org.apache.commons.compress.archivers.sevenz">SevenZArchiveEntry</a>&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/sevenz/SevenZOutputFile.html#line.148">createArchiveEntry</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>&nbsp;inputFile,
  336. <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;entryName)
  337. 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>
  338. <div class="block">Create an archive entry using the inputFile and entryName provided.</div>
  339. <dl><dt><span class="strong">Parameters:</span></dt><dd><code>inputFile</code> - file to create an entry from</dd><dd><code>entryName</code> - the name to use</dd>
  340. <dt><span class="strong">Returns:</span></dt><dd>the ArchiveEntry set up with details from the file</dd>
  341. <dt><span class="strong">Throws:</span></dt>
  342. <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>
  343. </li>
  344. </ul>
  345. <a name="putArchiveEntry(org.apache.commons.compress.archivers.ArchiveEntry)">
  346. <!-- -->
  347. </a>
  348. <ul class="blockList">
  349. <li class="blockList">
  350. <h4>putArchiveEntry</h4>
  351. <pre>public&nbsp;void&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/sevenz/SevenZOutputFile.html#line.166">putArchiveEntry</a>(<a href="../../../../../../org/apache/commons/compress/archivers/ArchiveEntry.html" title="interface in org.apache.commons.compress.archivers">ArchiveEntry</a>&nbsp;archiveEntry)
  352. 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>
  353. <div class="block">Records an archive entry to add.
  354. The caller must then write the content to the archive and call
  355. <a href="../../../../../../org/apache/commons/compress/archivers/sevenz/SevenZOutputFile.html#closeArchiveEntry()"><code>closeArchiveEntry()</code></a> to complete the process.</div>
  356. <dl><dt><span class="strong">Parameters:</span></dt><dd><code>archiveEntry</code> - describes the entry</dd>
  357. <dt><span class="strong">Throws:</span></dt>
  358. <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>
  359. </li>
  360. </ul>
  361. <a name="closeArchiveEntry()">
  362. <!-- -->
  363. </a>
  364. <ul class="blockList">
  365. <li class="blockList">
  366. <h4>closeArchiveEntry</h4>
  367. <pre>public&nbsp;void&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/sevenz/SevenZOutputFile.html#line.175">closeArchiveEntry</a>()
  368. 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>
  369. <div class="block">Closes the archive entry.</div>
  370. <dl><dt><span class="strong">Throws:</span></dt>
  371. <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>
  372. </li>
  373. </ul>
  374. <a name="write(int)">
  375. <!-- -->
  376. </a>
  377. <ul class="blockList">
  378. <li class="blockList">
  379. <h4>write</h4>
  380. <pre>public&nbsp;void&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/sevenz/SevenZOutputFile.html#line.215">write</a>(int&nbsp;b)
  381. 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>
  382. <div class="block">Writes a byte to the current archive entry.</div>
  383. <dl><dt><span class="strong">Parameters:</span></dt><dd><code>b</code> - The byte to be written.</dd>
  384. <dt><span class="strong">Throws:</span></dt>
  385. <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>
  386. </li>
  387. </ul>
  388. <a name="write(byte[])">
  389. <!-- -->
  390. </a>
  391. <ul class="blockList">
  392. <li class="blockList">
  393. <h4>write</h4>
  394. <pre>public&nbsp;void&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/sevenz/SevenZOutputFile.html#line.224">write</a>(byte[]&nbsp;b)
  395. 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>
  396. <div class="block">Writes a byte array to the current archive entry.</div>
  397. <dl><dt><span class="strong">Parameters:</span></dt><dd><code>b</code> - The byte array to be written.</dd>
  398. <dt><span class="strong">Throws:</span></dt>
  399. <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>
  400. </li>
  401. </ul>
  402. <a name="write(byte[], int, int)">
  403. <!-- -->
  404. </a>
  405. <ul class="blockList">
  406. <li class="blockList">
  407. <h4>write</h4>
  408. <pre>public&nbsp;void&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/sevenz/SevenZOutputFile.html#line.235">write</a>(byte[]&nbsp;b,
  409. int&nbsp;off,
  410. int&nbsp;len)
  411. 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>
  412. <div class="block">Writes part of a byte array to the current archive entry.</div>
  413. <dl><dt><span class="strong">Parameters:</span></dt><dd><code>b</code> - The byte array to be written.</dd><dd><code>off</code> - offset into the array to start writing from</dd><dd><code>len</code> - number of bytes to write</dd>
  414. <dt><span class="strong">Throws:</span></dt>
  415. <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>
  416. </li>
  417. </ul>
  418. <a name="finish()">
  419. <!-- -->
  420. </a>
  421. <ul class="blockListLast">
  422. <li class="blockList">
  423. <h4>finish</h4>
  424. <pre>public&nbsp;void&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/sevenz/SevenZOutputFile.html#line.246">finish</a>()
  425. 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>
  426. <div class="block">Finishes the addition of entries to this archive, without closing it.</div>
  427. <dl><dt><span class="strong">Throws:</span></dt>
  428. <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 archive is already closed.</dd></dl>
  429. </li>
  430. </ul>
  431. </li>
  432. </ul>
  433. </li>
  434. </ul>
  435. </div>
  436. </div>
  437. <!-- ========= END OF CLASS DATA ========= -->
  438. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  439. <div class="bottomNav"><a name="navbar_bottom">
  440. <!-- -->
  441. </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
  442. <!-- -->
  443. </a>
  444. <ul class="navList" title="Navigation">
  445. <li><a href="../../../../../../overview-summary.html">Overview</a></li>
  446. <li><a href="package-summary.html">Package</a></li>
  447. <li class="navBarCell1Rev">Class</li>
  448. <li><a href="class-use/SevenZOutputFile.html">Use</a></li>
  449. <li><a href="package-tree.html">Tree</a></li>
  450. <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
  451. <li><a href="../../../../../../index-all.html">Index</a></li>
  452. <li><a href="../../../../../../help-doc.html">Help</a></li>
  453. </ul>
  454. </div>
  455. <div class="subNav">
  456. <ul class="navList">
  457. <li><a href="../../../../../../org/apache/commons/compress/archivers/sevenz/SevenZMethodConfiguration.html" title="class in org.apache.commons.compress.archivers.sevenz"><span class="strong">Prev Class</span></a></li>
  458. <li>Next Class</li>
  459. </ul>
  460. <ul class="navList">
  461. <li><a href="../../../../../../index.html?org/apache/commons/compress/archivers/sevenz/SevenZOutputFile.html" target="_top">Frames</a></li>
  462. <li><a href="SevenZOutputFile.html" target="_top">No Frames</a></li>
  463. </ul>
  464. <ul class="navList" id="allclasses_navbar_bottom">
  465. <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
  466. </ul>
  467. <div>
  468. <script type="text/javascript"><!--
  469. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  470. if(window==top) {
  471. allClassesLink.style.display = "block";
  472. }
  473. else {
  474. allClassesLink.style.display = "none";
  475. }
  476. //-->
  477. </script>
  478. </div>
  479. <div>
  480. <ul class="subNavList">
  481. <li>Summary:&nbsp;</li>
  482. <li>Nested&nbsp;|&nbsp;</li>
  483. <li>Field&nbsp;|&nbsp;</li>
  484. <li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
  485. <li><a href="#method_summary">Method</a></li>
  486. </ul>
  487. <ul class="subNavList">
  488. <li>Detail:&nbsp;</li>
  489. <li>Field&nbsp;|&nbsp;</li>
  490. <li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
  491. <li><a href="#method_detail">Method</a></li>
  492. </ul>
  493. </div>
  494. <a name="skip-navbar_bottom">
  495. <!-- -->
  496. </a></div>
  497. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  498. <p class="legalCopy"><small>Copyright &#169; 2016 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
  499. </body>
  500. </html>