GzipUtils.html 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285
  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>GzipUtils (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="GzipUtils (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/GzipUtils.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/gzip/GzipParameters.html" title="class in org.apache.commons.compress.compressors.gzip"><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/gzip/GzipUtils.html" target="_top">Frames</a></li>
  47. <li><a href="GzipUtils.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>Constr&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>Constr&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.gzip</div>
  86. <h2 title="Class GzipUtils" class="title">Class GzipUtils</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.gzip.GzipUtils</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/gzip/GzipUtils.html#line.29">GzipUtils</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">Utility code for the gzip compression format.</div>
  105. <dl><dt><span class="strong">This class is thread-safe</span></dt>
  106. <dd></dd></dl>
  107. </li>
  108. </ul>
  109. </div>
  110. <div class="summary">
  111. <ul class="blockList">
  112. <li class="blockList">
  113. <!-- ========== METHOD SUMMARY =========== -->
  114. <ul class="blockList">
  115. <li class="blockList"><a name="method_summary">
  116. <!-- -->
  117. </a>
  118. <h3>Method Summary</h3>
  119. <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  120. <caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
  121. <tr>
  122. <th class="colFirst" scope="col">Modifier and Type</th>
  123. <th class="colLast" scope="col">Method and Description</th>
  124. </tr>
  125. <tr class="altColor">
  126. <td class="colFirst"><code>static <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>
  127. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/compressors/gzip/GzipUtils.html#getCompressedFilename(java.lang.String)">getCompressedFilename</a></strong>(<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;filename)</code>
  128. <div class="block">Maps the given filename to the name that the file should have after
  129. compression with gzip.</div>
  130. </td>
  131. </tr>
  132. <tr class="rowColor">
  133. <td class="colFirst"><code>static <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>
  134. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/compressors/gzip/GzipUtils.html#getUncompressedFilename(java.lang.String)">getUncompressedFilename</a></strong>(<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;filename)</code>
  135. <div class="block">Maps the given name of a gzip-compressed file to the name that the
  136. file should have after uncompression.</div>
  137. </td>
  138. </tr>
  139. <tr class="altColor">
  140. <td class="colFirst"><code>static boolean</code></td>
  141. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/compressors/gzip/GzipUtils.html#isCompressedFilename(java.lang.String)">isCompressedFilename</a></strong>(<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;filename)</code>
  142. <div class="block">Detects common gzip suffixes in the given filename.</div>
  143. </td>
  144. </tr>
  145. </table>
  146. <ul class="blockList">
  147. <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
  148. <!-- -->
  149. </a>
  150. <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>
  151. <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>
  152. </ul>
  153. </li>
  154. </ul>
  155. </li>
  156. </ul>
  157. </div>
  158. <div class="details">
  159. <ul class="blockList">
  160. <li class="blockList">
  161. <!-- ============ METHOD DETAIL ========== -->
  162. <ul class="blockList">
  163. <li class="blockList"><a name="method_detail">
  164. <!-- -->
  165. </a>
  166. <h3>Method Detail</h3>
  167. <a name="isCompressedFilename(java.lang.String)">
  168. <!-- -->
  169. </a>
  170. <ul class="blockList">
  171. <li class="blockList">
  172. <h4>isCompressedFilename</h4>
  173. <pre>public static&nbsp;boolean&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/compressors/gzip/GzipUtils.html#line.64">isCompressedFilename</a>(<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;filename)</pre>
  174. <div class="block">Detects common gzip suffixes in the given filename.</div>
  175. <dl><dt><span class="strong">Parameters:</span></dt><dd><code>filename</code> - name of a file</dd>
  176. <dt><span class="strong">Returns:</span></dt><dd><code>true</code> if the filename has a common gzip suffix,
  177. <code>false</code> otherwise</dd></dl>
  178. </li>
  179. </ul>
  180. <a name="getUncompressedFilename(java.lang.String)">
  181. <!-- -->
  182. </a>
  183. <ul class="blockList">
  184. <li class="blockList">
  185. <h4>getUncompressedFilename</h4>
  186. <pre>public static&nbsp;<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;<a href="../../../../../../src-html/org/apache/commons/compress/compressors/gzip/GzipUtils.html#line.81">getUncompressedFilename</a>(<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;filename)</pre>
  187. <div class="block">Maps the given name of a gzip-compressed file to the name that the
  188. file should have after uncompression. Commonly used file type specific
  189. suffixes like ".tgz" or ".svgz" are automatically detected and
  190. correctly mapped. For example the name "package.tgz" is mapped to
  191. "package.tar". And any filenames with the generic ".gz" suffix
  192. (or any other generic gzip suffix) is mapped to a name without that
  193. suffix. If no gzip suffix is detected, then the filename is returned
  194. unmapped.</div>
  195. <dl><dt><span class="strong">Parameters:</span></dt><dd><code>filename</code> - name of a file</dd>
  196. <dt><span class="strong">Returns:</span></dt><dd>name of the corresponding uncompressed file</dd></dl>
  197. </li>
  198. </ul>
  199. <a name="getCompressedFilename(java.lang.String)">
  200. <!-- -->
  201. </a>
  202. <ul class="blockListLast">
  203. <li class="blockList">
  204. <h4>getCompressedFilename</h4>
  205. <pre>public static&nbsp;<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;<a href="../../../../../../src-html/org/apache/commons/compress/compressors/gzip/GzipUtils.html#line.96">getCompressedFilename</a>(<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;filename)</pre>
  206. <div class="block">Maps the given filename to the name that the file should have after
  207. compression with gzip. Common file types with custom suffixes for
  208. compressed versions are automatically detected and correctly mapped.
  209. For example the name "package.tar" is mapped to "package.tgz". If no
  210. custom mapping is applicable, then the default ".gz" suffix is appended
  211. to the filename.</div>
  212. <dl><dt><span class="strong">Parameters:</span></dt><dd><code>filename</code> - name of a file</dd>
  213. <dt><span class="strong">Returns:</span></dt><dd>name of the corresponding compressed file</dd></dl>
  214. </li>
  215. </ul>
  216. </li>
  217. </ul>
  218. </li>
  219. </ul>
  220. </div>
  221. </div>
  222. <!-- ========= END OF CLASS DATA ========= -->
  223. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  224. <div class="bottomNav"><a name="navbar_bottom">
  225. <!-- -->
  226. </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
  227. <!-- -->
  228. </a>
  229. <ul class="navList" title="Navigation">
  230. <li><a href="../../../../../../overview-summary.html">Overview</a></li>
  231. <li><a href="package-summary.html">Package</a></li>
  232. <li class="navBarCell1Rev">Class</li>
  233. <li><a href="class-use/GzipUtils.html">Use</a></li>
  234. <li><a href="package-tree.html">Tree</a></li>
  235. <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
  236. <li><a href="../../../../../../index-all.html">Index</a></li>
  237. <li><a href="../../../../../../help-doc.html">Help</a></li>
  238. </ul>
  239. </div>
  240. <div class="subNav">
  241. <ul class="navList">
  242. <li><a href="../../../../../../org/apache/commons/compress/compressors/gzip/GzipParameters.html" title="class in org.apache.commons.compress.compressors.gzip"><span class="strong">Prev Class</span></a></li>
  243. <li>Next Class</li>
  244. </ul>
  245. <ul class="navList">
  246. <li><a href="../../../../../../index.html?org/apache/commons/compress/compressors/gzip/GzipUtils.html" target="_top">Frames</a></li>
  247. <li><a href="GzipUtils.html" target="_top">No Frames</a></li>
  248. </ul>
  249. <ul class="navList" id="allclasses_navbar_bottom">
  250. <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
  251. </ul>
  252. <div>
  253. <script type="text/javascript"><!--
  254. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  255. if(window==top) {
  256. allClassesLink.style.display = "block";
  257. }
  258. else {
  259. allClassesLink.style.display = "none";
  260. }
  261. //-->
  262. </script>
  263. </div>
  264. <div>
  265. <ul class="subNavList">
  266. <li>Summary:&nbsp;</li>
  267. <li>Nested&nbsp;|&nbsp;</li>
  268. <li>Field&nbsp;|&nbsp;</li>
  269. <li>Constr&nbsp;|&nbsp;</li>
  270. <li><a href="#method_summary">Method</a></li>
  271. </ul>
  272. <ul class="subNavList">
  273. <li>Detail:&nbsp;</li>
  274. <li>Field&nbsp;|&nbsp;</li>
  275. <li>Constr&nbsp;|&nbsp;</li>
  276. <li><a href="#method_detail">Method</a></li>
  277. </ul>
  278. </div>
  279. <a name="skip-navbar_bottom">
  280. <!-- -->
  281. </a></div>
  282. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  283. <p class="legalCopy"><small>Copyright &#169; 2016 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
  284. </body>
  285. </html>