CompressorStreamProvider.html 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312
  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>CompressorStreamProvider (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="CompressorStreamProvider (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/CompressorStreamProvider.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/CompressorStreamFactory.html" title="class in org.apache.commons.compress.compressors"><span class="strong">Prev Class</span></a></li>
  43. <li><a href="../../../../../org/apache/commons/compress/compressors/FileNameUtil.html" title="class in org.apache.commons.compress.compressors"><span class="strong">Next Class</span></a></li>
  44. </ul>
  45. <ul class="navList">
  46. <li><a href="../../../../../index.html?org/apache/commons/compress/compressors/CompressorStreamProvider.html" target="_top">Frames</a></li>
  47. <li><a href="CompressorStreamProvider.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</div>
  86. <h2 title="Interface CompressorStreamProvider" class="title">Interface CompressorStreamProvider</h2>
  87. </div>
  88. <div class="contentContainer">
  89. <div class="description">
  90. <ul class="blockList">
  91. <li class="blockList">
  92. <dl>
  93. <dt>All Known Implementing Classes:</dt>
  94. <dd><a href="../../../../../org/apache/commons/compress/compressors/CompressorStreamFactory.html" title="class in org.apache.commons.compress.compressors">CompressorStreamFactory</a></dd>
  95. </dl>
  96. <hr>
  97. <br>
  98. <pre>public interface <a href="../../../../../src-html/org/apache/commons/compress/compressors/CompressorStreamProvider.html#line.32">CompressorStreamProvider</a></pre>
  99. <div class="block">Creates Compressor <a href="../../../../../org/apache/commons/compress/compressors/CompressorInputStream.html" title="class in org.apache.commons.compress.compressors"><code>CompressorInputStream</code></a>s and
  100. <a href="../../../../../org/apache/commons/compress/compressors/CompressorOutputStream.html" title="class in org.apache.commons.compress.compressors"><code>CompressorOutputStream</code></a>s.</div>
  101. <dl><dt><span class="strong">Since:</span></dt>
  102. <dd>1.13</dd></dl>
  103. </li>
  104. </ul>
  105. </div>
  106. <div class="summary">
  107. <ul class="blockList">
  108. <li class="blockList">
  109. <!-- ========== METHOD SUMMARY =========== -->
  110. <ul class="blockList">
  111. <li class="blockList"><a name="method_summary">
  112. <!-- -->
  113. </a>
  114. <h3>Method Summary</h3>
  115. <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  116. <caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
  117. <tr>
  118. <th class="colFirst" scope="col">Modifier and Type</th>
  119. <th class="colLast" scope="col">Method and Description</th>
  120. </tr>
  121. <tr class="altColor">
  122. <td class="colFirst"><code><a href="../../../../../org/apache/commons/compress/compressors/CompressorInputStream.html" title="class in org.apache.commons.compress.compressors">CompressorInputStream</a></code></td>
  123. <td class="colLast"><code><strong><a href="../../../../../org/apache/commons/compress/compressors/CompressorStreamProvider.html#createCompressorInputStream(java.lang.String,%20java.io.InputStream,%20boolean)">createCompressorInputStream</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;name,
  124. <a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a>&nbsp;in,
  125. boolean&nbsp;decompressUntilEOF)</code>
  126. <div class="block">Creates a compressor input stream from a compressor name and an input
  127. stream.</div>
  128. </td>
  129. </tr>
  130. <tr class="rowColor">
  131. <td class="colFirst"><code><a href="../../../../../org/apache/commons/compress/compressors/CompressorOutputStream.html" title="class in org.apache.commons.compress.compressors">CompressorOutputStream</a></code></td>
  132. <td class="colLast"><code><strong><a href="../../../../../org/apache/commons/compress/compressors/CompressorStreamProvider.html#createCompressorOutputStream(java.lang.String,%20java.io.OutputStream)">createCompressorOutputStream</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;name,
  133. <a href="http://docs.oracle.com/javase/7/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a>&nbsp;out)</code>
  134. <div class="block">Creates a compressor output stream from an compressor name and an output
  135. stream.</div>
  136. </td>
  137. </tr>
  138. <tr class="altColor">
  139. <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<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>&gt;</code></td>
  140. <td class="colLast"><code><strong><a href="../../../../../org/apache/commons/compress/compressors/CompressorStreamProvider.html#getInputStreamCompressorNames()">getInputStreamCompressorNames</a></strong>()</code>
  141. <div class="block">Gets all the input stream compressor names for this provider</div>
  142. </td>
  143. </tr>
  144. <tr class="rowColor">
  145. <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<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>&gt;</code></td>
  146. <td class="colLast"><code><strong><a href="../../../../../org/apache/commons/compress/compressors/CompressorStreamProvider.html#getOutputStreamCompressorNames()">getOutputStreamCompressorNames</a></strong>()</code>
  147. <div class="block">Gets all the output stream compressor names for this provider</div>
  148. </td>
  149. </tr>
  150. </table>
  151. </li>
  152. </ul>
  153. </li>
  154. </ul>
  155. </div>
  156. <div class="details">
  157. <ul class="blockList">
  158. <li class="blockList">
  159. <!-- ============ METHOD DETAIL ========== -->
  160. <ul class="blockList">
  161. <li class="blockList"><a name="method_detail">
  162. <!-- -->
  163. </a>
  164. <h3>Method Detail</h3>
  165. <a name="createCompressorInputStream(java.lang.String, java.io.InputStream, boolean)">
  166. <!-- -->
  167. </a>
  168. <ul class="blockList">
  169. <li class="blockList">
  170. <h4>createCompressorInputStream</h4>
  171. <pre><a href="../../../../../org/apache/commons/compress/compressors/CompressorInputStream.html" title="class in org.apache.commons.compress.compressors">CompressorInputStream</a>&nbsp;<a href="../../../../../src-html/org/apache/commons/compress/compressors/CompressorStreamProvider.html#line.63">createCompressorInputStream</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;name,
  172. <a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a>&nbsp;in,
  173. boolean&nbsp;decompressUntilEOF)
  174. throws <a href="../../../../../org/apache/commons/compress/compressors/CompressorException.html" title="class in org.apache.commons.compress.compressors">CompressorException</a></pre>
  175. <div class="block">Creates a compressor input stream from a compressor name and an input
  176. stream.</div>
  177. <dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - of the compressor, i.e.
  178. <a href="../../../../../org/apache/commons/compress/compressors/CompressorStreamFactory.html#GZIP">"gz"</a>,
  179. <a href="../../../../../org/apache/commons/compress/compressors/CompressorStreamFactory.html#BZIP2">"bzip2"</a>,
  180. <a href="../../../../../org/apache/commons/compress/compressors/CompressorStreamFactory.html#XZ">"xz"</a>,
  181. <a href="../../../../../org/apache/commons/compress/compressors/CompressorStreamFactory.html#LZMA">"lzma"</a>,
  182. <a href="../../../../../org/apache/commons/compress/compressors/CompressorStreamFactory.html#PACK200">"pack200"</a>,
  183. <a href="../../../../../org/apache/commons/compress/compressors/CompressorStreamFactory.html#SNAPPY_RAW">"snappy-raw"</a>,
  184. <a href="../../../../../org/apache/commons/compress/compressors/CompressorStreamFactory.html#SNAPPY_FRAMED">"snappy-framed"</a>,
  185. <a href="../../../../../org/apache/commons/compress/compressors/CompressorStreamFactory.html#Z">"z"</a>
  186. or
  187. <a href="../../../../../org/apache/commons/compress/compressors/CompressorStreamFactory.html#DEFLATE">"deflate"</a></dd><dd><code>in</code> - the input stream</dd><dd><code>decompressUntilEOF</code> - if true, decompress until the end of the input; if false, stop
  188. after the first stream and leave the input position to point
  189. to the next byte after the stream. This setting applies to the
  190. gzip, bzip2 and xz formats only.</dd>
  191. <dt><span class="strong">Returns:</span></dt><dd>compressor input stream</dd>
  192. <dt><span class="strong">Throws:</span></dt>
  193. <dd><code><a href="../../../../../org/apache/commons/compress/compressors/CompressorException.html" title="class in org.apache.commons.compress.compressors">CompressorException</a></code> - if the compressor name is not known</dd>
  194. <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 name or input stream is null</dd></dl>
  195. </li>
  196. </ul>
  197. <a name="createCompressorOutputStream(java.lang.String, java.io.OutputStream)">
  198. <!-- -->
  199. </a>
  200. <ul class="blockList">
  201. <li class="blockList">
  202. <h4>createCompressorOutputStream</h4>
  203. <pre><a href="../../../../../org/apache/commons/compress/compressors/CompressorOutputStream.html" title="class in org.apache.commons.compress.compressors">CompressorOutputStream</a>&nbsp;<a href="../../../../../src-html/org/apache/commons/compress/compressors/CompressorStreamProvider.html#line.86">createCompressorOutputStream</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;name,
  204. <a href="http://docs.oracle.com/javase/7/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a>&nbsp;out)
  205. throws <a href="../../../../../org/apache/commons/compress/compressors/CompressorException.html" title="class in org.apache.commons.compress.compressors">CompressorException</a></pre>
  206. <div class="block">Creates a compressor output stream from an compressor name and an output
  207. stream.</div>
  208. <dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the compressor name, i.e.
  209. <a href="../../../../../org/apache/commons/compress/compressors/CompressorStreamFactory.html#GZIP">"gz"</a>,
  210. <a href="../../../../../org/apache/commons/compress/compressors/CompressorStreamFactory.html#BZIP2">"bzip2"</a>,
  211. <a href="../../../../../org/apache/commons/compress/compressors/CompressorStreamFactory.html#XZ">"xz"</a>,
  212. <a href="../../../../../org/apache/commons/compress/compressors/CompressorStreamFactory.html#PACK200">"pack200"</a>
  213. or
  214. <a href="../../../../../org/apache/commons/compress/compressors/CompressorStreamFactory.html#DEFLATE">"deflate"</a></dd><dd><code>out</code> - the output stream</dd>
  215. <dt><span class="strong">Returns:</span></dt><dd>the compressor output stream</dd>
  216. <dt><span class="strong">Throws:</span></dt>
  217. <dd><code><a href="../../../../../org/apache/commons/compress/compressors/CompressorException.html" title="class in org.apache.commons.compress.compressors">CompressorException</a></code> - if the archiver name is not known</dd>
  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 archiver name or stream is null</dd></dl>
  219. </li>
  220. </ul>
  221. <a name="getInputStreamCompressorNames()">
  222. <!-- -->
  223. </a>
  224. <ul class="blockList">
  225. <li class="blockList">
  226. <h4>getInputStreamCompressorNames</h4>
  227. <pre><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<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>&gt;&nbsp;<a href="../../../../../src-html/org/apache/commons/compress/compressors/CompressorStreamProvider.html#line.94">getInputStreamCompressorNames</a>()</pre>
  228. <div class="block">Gets all the input stream compressor names for this provider</div>
  229. <dl><dt><span class="strong">Returns:</span></dt><dd>all the input compressor names for this provider</dd></dl>
  230. </li>
  231. </ul>
  232. <a name="getOutputStreamCompressorNames()">
  233. <!-- -->
  234. </a>
  235. <ul class="blockListLast">
  236. <li class="blockList">
  237. <h4>getOutputStreamCompressorNames</h4>
  238. <pre><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<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>&gt;&nbsp;<a href="../../../../../src-html/org/apache/commons/compress/compressors/CompressorStreamProvider.html#line.101">getOutputStreamCompressorNames</a>()</pre>
  239. <div class="block">Gets all the output stream compressor names for this provider</div>
  240. <dl><dt><span class="strong">Returns:</span></dt><dd>all the output compressor names for this provider</dd></dl>
  241. </li>
  242. </ul>
  243. </li>
  244. </ul>
  245. </li>
  246. </ul>
  247. </div>
  248. </div>
  249. <!-- ========= END OF CLASS DATA ========= -->
  250. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  251. <div class="bottomNav"><a name="navbar_bottom">
  252. <!-- -->
  253. </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
  254. <!-- -->
  255. </a>
  256. <ul class="navList" title="Navigation">
  257. <li><a href="../../../../../overview-summary.html">Overview</a></li>
  258. <li><a href="package-summary.html">Package</a></li>
  259. <li class="navBarCell1Rev">Class</li>
  260. <li><a href="class-use/CompressorStreamProvider.html">Use</a></li>
  261. <li><a href="package-tree.html">Tree</a></li>
  262. <li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
  263. <li><a href="../../../../../index-all.html">Index</a></li>
  264. <li><a href="../../../../../help-doc.html">Help</a></li>
  265. </ul>
  266. </div>
  267. <div class="subNav">
  268. <ul class="navList">
  269. <li><a href="../../../../../org/apache/commons/compress/compressors/CompressorStreamFactory.html" title="class in org.apache.commons.compress.compressors"><span class="strong">Prev Class</span></a></li>
  270. <li><a href="../../../../../org/apache/commons/compress/compressors/FileNameUtil.html" title="class in org.apache.commons.compress.compressors"><span class="strong">Next Class</span></a></li>
  271. </ul>
  272. <ul class="navList">
  273. <li><a href="../../../../../index.html?org/apache/commons/compress/compressors/CompressorStreamProvider.html" target="_top">Frames</a></li>
  274. <li><a href="CompressorStreamProvider.html" target="_top">No Frames</a></li>
  275. </ul>
  276. <ul class="navList" id="allclasses_navbar_bottom">
  277. <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
  278. </ul>
  279. <div>
  280. <script type="text/javascript"><!--
  281. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  282. if(window==top) {
  283. allClassesLink.style.display = "block";
  284. }
  285. else {
  286. allClassesLink.style.display = "none";
  287. }
  288. //-->
  289. </script>
  290. </div>
  291. <div>
  292. <ul class="subNavList">
  293. <li>Summary:&nbsp;</li>
  294. <li>Nested&nbsp;|&nbsp;</li>
  295. <li>Field&nbsp;|&nbsp;</li>
  296. <li>Constr&nbsp;|&nbsp;</li>
  297. <li><a href="#method_summary">Method</a></li>
  298. </ul>
  299. <ul class="subNavList">
  300. <li>Detail:&nbsp;</li>
  301. <li>Field&nbsp;|&nbsp;</li>
  302. <li>Constr&nbsp;|&nbsp;</li>
  303. <li><a href="#method_detail">Method</a></li>
  304. </ul>
  305. </div>
  306. <a name="skip-navbar_bottom">
  307. <!-- -->
  308. </a></div>
  309. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  310. <p class="legalCopy"><small>Copyright &#169; 2016 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
  311. </body>
  312. </html>