SevenZMethodConfiguration.html 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322
  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>SevenZMethodConfiguration (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="SevenZMethodConfiguration (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/SevenZMethodConfiguration.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/SevenZMethod.html" title="enum in org.apache.commons.compress.archivers.sevenz"><span class="strong">Prev Class</span></a></li>
  43. <li><a href="../../../../../../org/apache/commons/compress/archivers/sevenz/SevenZOutputFile.html" title="class in org.apache.commons.compress.archivers.sevenz"><span class="strong">Next Class</span></a></li>
  44. </ul>
  45. <ul class="navList">
  46. <li><a href="../../../../../../index.html?org/apache/commons/compress/archivers/sevenz/SevenZMethodConfiguration.html" target="_top">Frames</a></li>
  47. <li><a href="SevenZMethodConfiguration.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 SevenZMethodConfiguration" class="title">Class SevenZMethodConfiguration</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.SevenZMethodConfiguration</li>
  94. </ul>
  95. </li>
  96. </ul>
  97. <div class="description">
  98. <ul class="blockList">
  99. <li class="blockList">
  100. <hr>
  101. <br>
  102. <pre>public class <a href="../../../../../../src-html/org/apache/commons/compress/archivers/sevenz/SevenZMethodConfiguration.html#line.38">SevenZMethodConfiguration</a>
  103. 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></pre>
  104. <div class="block">Combines a SevenZMethod with configuration options for the method.
  105. <p>The exact type and interpretation of options depends on the
  106. method being configured. Currently supported are:</p>
  107. <table summary="Options">
  108. <tr><th>Method</th><th>Option Type</th><th>Description</th></tr>
  109. <tr><td>BZIP2</td><td>Number</td><td>Block Size - an number between 1 and 9</td></tr>
  110. <tr><td>DEFLATE</td><td>Number</td><td>Compression Level - an number between 1 and 9</td></tr>
  111. <tr><td>LZMA2</td><td>Number</td><td>Dictionary Size - a number between 4096 and 768 MiB (768 &lt;&lt; 20)</td></tr>
  112. <tr><td>LZMA2</td><td>org.tukaani.xz.LZMA2Options</td><td>Whole set of LZMA2 options.</td></tr>
  113. <tr><td>DELTA_FILTER</td><td>Number</td><td>Delta Distance - a number between 1 and 256</td></tr>
  114. </table></div>
  115. <dl><dt><span class="strong">Since:</span></dt>
  116. <dd>1.8</dd>
  117. <dt><span class="strong">This class is immutable</span></dt>
  118. <dd></dd></dl>
  119. </li>
  120. </ul>
  121. </div>
  122. <div class="summary">
  123. <ul class="blockList">
  124. <li class="blockList">
  125. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  126. <ul class="blockList">
  127. <li class="blockList"><a name="constructor_summary">
  128. <!-- -->
  129. </a>
  130. <h3>Constructor Summary</h3>
  131. <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  132. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  133. <tr>
  134. <th class="colOne" scope="col">Constructor and Description</th>
  135. </tr>
  136. <tr class="altColor">
  137. <td class="colOne"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/sevenz/SevenZMethodConfiguration.html#SevenZMethodConfiguration(org.apache.commons.compress.archivers.sevenz.SevenZMethod)">SevenZMethodConfiguration</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>
  138. <div class="block">Doesn't configure any additional options.</div>
  139. </td>
  140. </tr>
  141. <tr class="rowColor">
  142. <td class="colOne"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/sevenz/SevenZMethodConfiguration.html#SevenZMethodConfiguration(org.apache.commons.compress.archivers.sevenz.SevenZMethod,%20java.lang.Object)">SevenZMethodConfiguration</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,
  143. <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>&nbsp;options)</code>
  144. <div class="block">Specifies and method plus configuration options.</div>
  145. </td>
  146. </tr>
  147. </table>
  148. </li>
  149. </ul>
  150. <!-- ========== METHOD SUMMARY =========== -->
  151. <ul class="blockList">
  152. <li class="blockList"><a name="method_summary">
  153. <!-- -->
  154. </a>
  155. <h3>Method Summary</h3>
  156. <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  157. <caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
  158. <tr>
  159. <th class="colFirst" scope="col">Modifier and Type</th>
  160. <th class="colLast" scope="col">Method and Description</th>
  161. </tr>
  162. <tr class="altColor">
  163. <td class="colFirst"><code><a href="../../../../../../org/apache/commons/compress/archivers/sevenz/SevenZMethod.html" title="enum in org.apache.commons.compress.archivers.sevenz">SevenZMethod</a></code></td>
  164. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/sevenz/SevenZMethodConfiguration.html#getMethod()">getMethod</a></strong>()</code>
  165. <div class="block">The specified method.</div>
  166. </td>
  167. </tr>
  168. <tr class="rowColor">
  169. <td class="colFirst"><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></td>
  170. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/sevenz/SevenZMethodConfiguration.html#getOptions()">getOptions</a></strong>()</code>
  171. <div class="block">The specified options.</div>
  172. </td>
  173. </tr>
  174. </table>
  175. <ul class="blockList">
  176. <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
  177. <!-- -->
  178. </a>
  179. <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>
  180. <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>
  181. </ul>
  182. </li>
  183. </ul>
  184. </li>
  185. </ul>
  186. </div>
  187. <div class="details">
  188. <ul class="blockList">
  189. <li class="blockList">
  190. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  191. <ul class="blockList">
  192. <li class="blockList"><a name="constructor_detail">
  193. <!-- -->
  194. </a>
  195. <h3>Constructor Detail</h3>
  196. <a name="SevenZMethodConfiguration(org.apache.commons.compress.archivers.sevenz.SevenZMethod)">
  197. <!-- -->
  198. </a>
  199. <ul class="blockList">
  200. <li class="blockList">
  201. <h4>SevenZMethodConfiguration</h4>
  202. <pre>public&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/sevenz/SevenZMethodConfiguration.html#line.46">SevenZMethodConfiguration</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>
  203. <div class="block">Doesn't configure any additional options.</div>
  204. <dl><dt><span class="strong">Parameters:</span></dt><dd><code>method</code> - the method to use</dd></dl>
  205. </li>
  206. </ul>
  207. <a name="SevenZMethodConfiguration(org.apache.commons.compress.archivers.sevenz.SevenZMethod, java.lang.Object)">
  208. <!-- -->
  209. </a>
  210. <ul class="blockListLast">
  211. <li class="blockList">
  212. <h4>SevenZMethodConfiguration</h4>
  213. <pre>public&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/sevenz/SevenZMethodConfiguration.html#line.56">SevenZMethodConfiguration</a>(<a href="../../../../../../org/apache/commons/compress/archivers/sevenz/SevenZMethod.html" title="enum in org.apache.commons.compress.archivers.sevenz">SevenZMethod</a>&nbsp;method,
  214. <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>&nbsp;options)</pre>
  215. <div class="block">Specifies and method plus configuration options.</div>
  216. <dl><dt><span class="strong">Parameters:</span></dt><dd><code>method</code> - the method to use</dd><dd><code>options</code> - the options to use</dd>
  217. <dt><span class="strong">Throws:</span></dt>
  218. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if the method doesn't understand the options specified.</dd></dl>
  219. </li>
  220. </ul>
  221. </li>
  222. </ul>
  223. <!-- ============ METHOD DETAIL ========== -->
  224. <ul class="blockList">
  225. <li class="blockList"><a name="method_detail">
  226. <!-- -->
  227. </a>
  228. <h3>Method Detail</h3>
  229. <a name="getMethod()">
  230. <!-- -->
  231. </a>
  232. <ul class="blockList">
  233. <li class="blockList">
  234. <h4>getMethod</h4>
  235. <pre>public&nbsp;<a href="../../../../../../org/apache/commons/compress/archivers/sevenz/SevenZMethod.html" title="enum in org.apache.commons.compress.archivers.sevenz">SevenZMethod</a>&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/sevenz/SevenZMethodConfiguration.html#line.69">getMethod</a>()</pre>
  236. <div class="block">The specified method.</div>
  237. <dl><dt><span class="strong">Returns:</span></dt><dd>the method</dd></dl>
  238. </li>
  239. </ul>
  240. <a name="getOptions()">
  241. <!-- -->
  242. </a>
  243. <ul class="blockListLast">
  244. <li class="blockList">
  245. <h4>getOptions</h4>
  246. <pre>public&nbsp;<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>&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/sevenz/SevenZMethodConfiguration.html#line.77">getOptions</a>()</pre>
  247. <div class="block">The specified options.</div>
  248. <dl><dt><span class="strong">Returns:</span></dt><dd>the options</dd></dl>
  249. </li>
  250. </ul>
  251. </li>
  252. </ul>
  253. </li>
  254. </ul>
  255. </div>
  256. </div>
  257. <!-- ========= END OF CLASS DATA ========= -->
  258. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  259. <div class="bottomNav"><a name="navbar_bottom">
  260. <!-- -->
  261. </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
  262. <!-- -->
  263. </a>
  264. <ul class="navList" title="Navigation">
  265. <li><a href="../../../../../../overview-summary.html">Overview</a></li>
  266. <li><a href="package-summary.html">Package</a></li>
  267. <li class="navBarCell1Rev">Class</li>
  268. <li><a href="class-use/SevenZMethodConfiguration.html">Use</a></li>
  269. <li><a href="package-tree.html">Tree</a></li>
  270. <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
  271. <li><a href="../../../../../../index-all.html">Index</a></li>
  272. <li><a href="../../../../../../help-doc.html">Help</a></li>
  273. </ul>
  274. </div>
  275. <div class="subNav">
  276. <ul class="navList">
  277. <li><a href="../../../../../../org/apache/commons/compress/archivers/sevenz/SevenZMethod.html" title="enum in org.apache.commons.compress.archivers.sevenz"><span class="strong">Prev Class</span></a></li>
  278. <li><a href="../../../../../../org/apache/commons/compress/archivers/sevenz/SevenZOutputFile.html" title="class in org.apache.commons.compress.archivers.sevenz"><span class="strong">Next Class</span></a></li>
  279. </ul>
  280. <ul class="navList">
  281. <li><a href="../../../../../../index.html?org/apache/commons/compress/archivers/sevenz/SevenZMethodConfiguration.html" target="_top">Frames</a></li>
  282. <li><a href="SevenZMethodConfiguration.html" target="_top">No Frames</a></li>
  283. </ul>
  284. <ul class="navList" id="allclasses_navbar_bottom">
  285. <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
  286. </ul>
  287. <div>
  288. <script type="text/javascript"><!--
  289. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  290. if(window==top) {
  291. allClassesLink.style.display = "block";
  292. }
  293. else {
  294. allClassesLink.style.display = "none";
  295. }
  296. //-->
  297. </script>
  298. </div>
  299. <div>
  300. <ul class="subNavList">
  301. <li>Summary:&nbsp;</li>
  302. <li>Nested&nbsp;|&nbsp;</li>
  303. <li>Field&nbsp;|&nbsp;</li>
  304. <li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
  305. <li><a href="#method_summary">Method</a></li>
  306. </ul>
  307. <ul class="subNavList">
  308. <li>Detail:&nbsp;</li>
  309. <li>Field&nbsp;|&nbsp;</li>
  310. <li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
  311. <li><a href="#method_detail">Method</a></li>
  312. </ul>
  313. </div>
  314. <a name="skip-navbar_bottom">
  315. <!-- -->
  316. </a></div>
  317. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  318. <p class="legalCopy"><small>Copyright &#169; 2016 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
  319. </body>
  320. </html>