BZip2Utils.html 14 KB

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