DeflateParameters.html 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326
  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>DeflateParameters (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="DeflateParameters (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/DeflateParameters.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/compressors/deflate/DeflateCompressorOutputStream.html" title="class in org.apache.commons.compress.compressors.deflate"><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/compressors/deflate/DeflateParameters.html" target="_top">Frames</a></li>
  47. <li><a href="DeflateParameters.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.compressors.deflate</div>
  86. <h2 title="Class DeflateParameters" class="title">Class DeflateParameters</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.compressors.deflate.DeflateParameters</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/compressors/deflate/DeflateParameters.html#line.28">DeflateParameters</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">Parameters for the Deflate compressor.</div>
  105. <dl><dt><span class="strong">Since:</span></dt>
  106. <dd>1.9</dd></dl>
  107. </li>
  108. </ul>
  109. </div>
  110. <div class="summary">
  111. <ul class="blockList">
  112. <li class="blockList">
  113. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  114. <ul class="blockList">
  115. <li class="blockList"><a name="constructor_summary">
  116. <!-- -->
  117. </a>
  118. <h3>Constructor Summary</h3>
  119. <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  120. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  121. <tr>
  122. <th class="colOne" scope="col">Constructor and Description</th>
  123. </tr>
  124. <tr class="altColor">
  125. <td class="colOne"><code><strong><a href="../../../../../../org/apache/commons/compress/compressors/deflate/DeflateParameters.html#DeflateParameters()">DeflateParameters</a></strong>()</code>&nbsp;</td>
  126. </tr>
  127. </table>
  128. </li>
  129. </ul>
  130. <!-- ========== METHOD SUMMARY =========== -->
  131. <ul class="blockList">
  132. <li class="blockList"><a name="method_summary">
  133. <!-- -->
  134. </a>
  135. <h3>Method Summary</h3>
  136. <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  137. <caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
  138. <tr>
  139. <th class="colFirst" scope="col">Modifier and Type</th>
  140. <th class="colLast" scope="col">Method and Description</th>
  141. </tr>
  142. <tr class="altColor">
  143. <td class="colFirst"><code>int</code></td>
  144. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/compressors/deflate/DeflateParameters.html#getCompressionLevel()">getCompressionLevel</a></strong>()</code>
  145. <div class="block">The compression level.</div>
  146. </td>
  147. </tr>
  148. <tr class="rowColor">
  149. <td class="colFirst"><code>void</code></td>
  150. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/compressors/deflate/DeflateParameters.html#setCompressionLevel(int)">setCompressionLevel</a></strong>(int&nbsp;compressionLevel)</code>
  151. <div class="block">Sets the compression level.</div>
  152. </td>
  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/compressors/deflate/DeflateParameters.html#setWithZlibHeader(boolean)">setWithZlibHeader</a></strong>(boolean&nbsp;zlibHeader)</code>
  157. <div class="block">Sets the zlib header presence parameter.</div>
  158. </td>
  159. </tr>
  160. <tr class="rowColor">
  161. <td class="colFirst"><code>boolean</code></td>
  162. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/compressors/deflate/DeflateParameters.html#withZlibHeader()">withZlibHeader</a></strong>()</code>
  163. <div class="block">Whether or not the zlib header shall be written (when
  164. compressing) or expected (when decompressing).</div>
  165. </td>
  166. </tr>
  167. </table>
  168. <ul class="blockList">
  169. <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
  170. <!-- -->
  171. </a>
  172. <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>
  173. <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>
  174. </ul>
  175. </li>
  176. </ul>
  177. </li>
  178. </ul>
  179. </div>
  180. <div class="details">
  181. <ul class="blockList">
  182. <li class="blockList">
  183. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  184. <ul class="blockList">
  185. <li class="blockList"><a name="constructor_detail">
  186. <!-- -->
  187. </a>
  188. <h3>Constructor Detail</h3>
  189. <a name="DeflateParameters()">
  190. <!-- -->
  191. </a>
  192. <ul class="blockListLast">
  193. <li class="blockList">
  194. <h4>DeflateParameters</h4>
  195. <pre>public&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/compressors/deflate/DeflateParameters.html#line.28">DeflateParameters</a>()</pre>
  196. </li>
  197. </ul>
  198. </li>
  199. </ul>
  200. <!-- ============ METHOD DETAIL ========== -->
  201. <ul class="blockList">
  202. <li class="blockList"><a name="method_detail">
  203. <!-- -->
  204. </a>
  205. <h3>Method Detail</h3>
  206. <a name="withZlibHeader()">
  207. <!-- -->
  208. </a>
  209. <ul class="blockList">
  210. <li class="blockList">
  211. <h4>withZlibHeader</h4>
  212. <pre>public&nbsp;boolean&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/compressors/deflate/DeflateParameters.html#line.38">withZlibHeader</a>()</pre>
  213. <div class="block">Whether or not the zlib header shall be written (when
  214. compressing) or expected (when decompressing).</div>
  215. <dl><dt><span class="strong">Returns:</span></dt><dd>true if zlib header shall be written</dd></dl>
  216. </li>
  217. </ul>
  218. <a name="setWithZlibHeader(boolean)">
  219. <!-- -->
  220. </a>
  221. <ul class="blockList">
  222. <li class="blockList">
  223. <h4>setWithZlibHeader</h4>
  224. <pre>public&nbsp;void&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/compressors/deflate/DeflateParameters.html#line.50">setWithZlibHeader</a>(boolean&nbsp;zlibHeader)</pre>
  225. <div class="block">Sets the zlib header presence parameter.
  226. <p>This affects whether or not the zlib header will be written
  227. (when compressing) or expected (when decompressing).</p></div>
  228. <dl><dt><span class="strong">Parameters:</span></dt><dd><code>zlibHeader</code> - true if zlib header shall be written</dd></dl>
  229. </li>
  230. </ul>
  231. <a name="getCompressionLevel()">
  232. <!-- -->
  233. </a>
  234. <ul class="blockList">
  235. <li class="blockList">
  236. <h4>getCompressionLevel</h4>
  237. <pre>public&nbsp;int&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/compressors/deflate/DeflateParameters.html#line.59">getCompressionLevel</a>()</pre>
  238. <div class="block">The compression level.</div>
  239. <dl><dt><span class="strong">Returns:</span></dt><dd>the compression level</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../org/apache/commons/compress/compressors/deflate/DeflateParameters.html#setCompressionLevel(int)"><code>setCompressionLevel(int)</code></a></dd></dl>
  240. </li>
  241. </ul>
  242. <a name="setCompressionLevel(int)">
  243. <!-- -->
  244. </a>
  245. <ul class="blockListLast">
  246. <li class="blockList">
  247. <h4>setCompressionLevel</h4>
  248. <pre>public&nbsp;void&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/compressors/deflate/DeflateParameters.html#line.72">setCompressionLevel</a>(int&nbsp;compressionLevel)</pre>
  249. <div class="block">Sets the compression level.</div>
  250. <dl><dt><span class="strong">Parameters:</span></dt><dd><code>compressionLevel</code> - the compression level (between 0 and 9)</dd><dt><span class="strong">See Also:</span></dt><dd><a href="http://docs.oracle.com/javase/7/docs/api/java/util/zip/Deflater.html?is-external=true#NO_COMPRESSION" title="class or interface in java.util.zip"><code>Deflater.NO_COMPRESSION</code></a>,
  251. <a href="http://docs.oracle.com/javase/7/docs/api/java/util/zip/Deflater.html?is-external=true#BEST_SPEED" title="class or interface in java.util.zip"><code>Deflater.BEST_SPEED</code></a>,
  252. <a href="http://docs.oracle.com/javase/7/docs/api/java/util/zip/Deflater.html?is-external=true#DEFAULT_COMPRESSION" title="class or interface in java.util.zip"><code>Deflater.DEFAULT_COMPRESSION</code></a>,
  253. <a href="http://docs.oracle.com/javase/7/docs/api/java/util/zip/Deflater.html?is-external=true#BEST_COMPRESSION" title="class or interface in java.util.zip"><code>Deflater.BEST_COMPRESSION</code></a></dd></dl>
  254. </li>
  255. </ul>
  256. </li>
  257. </ul>
  258. </li>
  259. </ul>
  260. </div>
  261. </div>
  262. <!-- ========= END OF CLASS DATA ========= -->
  263. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  264. <div class="bottomNav"><a name="navbar_bottom">
  265. <!-- -->
  266. </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
  267. <!-- -->
  268. </a>
  269. <ul class="navList" title="Navigation">
  270. <li><a href="../../../../../../overview-summary.html">Overview</a></li>
  271. <li><a href="package-summary.html">Package</a></li>
  272. <li class="navBarCell1Rev">Class</li>
  273. <li><a href="class-use/DeflateParameters.html">Use</a></li>
  274. <li><a href="package-tree.html">Tree</a></li>
  275. <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
  276. <li><a href="../../../../../../index-all.html">Index</a></li>
  277. <li><a href="../../../../../../help-doc.html">Help</a></li>
  278. </ul>
  279. </div>
  280. <div class="subNav">
  281. <ul class="navList">
  282. <li><a href="../../../../../../org/apache/commons/compress/compressors/deflate/DeflateCompressorOutputStream.html" title="class in org.apache.commons.compress.compressors.deflate"><span class="strong">Prev Class</span></a></li>
  283. <li>Next Class</li>
  284. </ul>
  285. <ul class="navList">
  286. <li><a href="../../../../../../index.html?org/apache/commons/compress/compressors/deflate/DeflateParameters.html" target="_top">Frames</a></li>
  287. <li><a href="DeflateParameters.html" target="_top">No Frames</a></li>
  288. </ul>
  289. <ul class="navList" id="allclasses_navbar_bottom">
  290. <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
  291. </ul>
  292. <div>
  293. <script type="text/javascript"><!--
  294. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  295. if(window==top) {
  296. allClassesLink.style.display = "block";
  297. }
  298. else {
  299. allClassesLink.style.display = "none";
  300. }
  301. //-->
  302. </script>
  303. </div>
  304. <div>
  305. <ul class="subNavList">
  306. <li>Summary:&nbsp;</li>
  307. <li>Nested&nbsp;|&nbsp;</li>
  308. <li>Field&nbsp;|&nbsp;</li>
  309. <li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
  310. <li><a href="#method_summary">Method</a></li>
  311. </ul>
  312. <ul class="subNavList">
  313. <li>Detail:&nbsp;</li>
  314. <li>Field&nbsp;|&nbsp;</li>
  315. <li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
  316. <li><a href="#method_detail">Method</a></li>
  317. </ul>
  318. </div>
  319. <a name="skip-navbar_bottom">
  320. <!-- -->
  321. </a></div>
  322. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  323. <p class="legalCopy"><small>Copyright &#169; 2016 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
  324. </body>
  325. </html>