ArchiveStreamProvider.html 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311
  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>ArchiveStreamProvider (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="ArchiveStreamProvider (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/ArchiveStreamProvider.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/ArchiveStreamFactory.html" title="class in org.apache.commons.compress.archivers"><span class="strong">Prev Class</span></a></li>
  43. <li><a href="../../../../../org/apache/commons/compress/archivers/Lister.html" title="class in org.apache.commons.compress.archivers"><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/ArchiveStreamProvider.html" target="_top">Frames</a></li>
  47. <li><a href="ArchiveStreamProvider.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.archivers</div>
  86. <h2 title="Interface ArchiveStreamProvider" class="title">Interface ArchiveStreamProvider</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/archivers/ArchiveStreamFactory.html" title="class in org.apache.commons.compress.archivers">ArchiveStreamFactory</a></dd>
  95. </dl>
  96. <hr>
  97. <br>
  98. <pre>public interface <a href="../../../../../src-html/org/apache/commons/compress/archivers/ArchiveStreamProvider.html#line.31">ArchiveStreamProvider</a></pre>
  99. <div class="block">Creates Archive <a href="../../../../../org/apache/commons/compress/archivers/ArchiveInputStream.html" title="class in org.apache.commons.compress.archivers"><code>ArchiveInputStream</code></a>s and <a href="../../../../../org/apache/commons/compress/archivers/ArchiveOutputStream.html" title="class in org.apache.commons.compress.archivers"><code>ArchiveOutputStream</code></a>s.</div>
  100. <dl><dt><span class="strong">Since:</span></dt>
  101. <dd>1.13</dd></dl>
  102. </li>
  103. </ul>
  104. </div>
  105. <div class="summary">
  106. <ul class="blockList">
  107. <li class="blockList">
  108. <!-- ========== METHOD SUMMARY =========== -->
  109. <ul class="blockList">
  110. <li class="blockList"><a name="method_summary">
  111. <!-- -->
  112. </a>
  113. <h3>Method Summary</h3>
  114. <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  115. <caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
  116. <tr>
  117. <th class="colFirst" scope="col">Modifier and Type</th>
  118. <th class="colLast" scope="col">Method and Description</th>
  119. </tr>
  120. <tr class="altColor">
  121. <td class="colFirst"><code><a href="../../../../../org/apache/commons/compress/archivers/ArchiveInputStream.html" title="class in org.apache.commons.compress.archivers">ArchiveInputStream</a></code></td>
  122. <td class="colLast"><code><strong><a href="../../../../../org/apache/commons/compress/archivers/ArchiveStreamProvider.html#createArchiveInputStream(java.lang.String,%20java.io.InputStream,%20java.lang.String)">createArchiveInputStream</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,
  123. <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,
  124. <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;encoding)</code>
  125. <div class="block">Creates an archive input stream from an archiver name and an input
  126. stream.</div>
  127. </td>
  128. </tr>
  129. <tr class="rowColor">
  130. <td class="colFirst"><code><a href="../../../../../org/apache/commons/compress/archivers/ArchiveOutputStream.html" title="class in org.apache.commons.compress.archivers">ArchiveOutputStream</a></code></td>
  131. <td class="colLast"><code><strong><a href="../../../../../org/apache/commons/compress/archivers/ArchiveStreamProvider.html#createArchiveOutputStream(java.lang.String,%20java.io.OutputStream,%20java.lang.String)">createArchiveOutputStream</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,
  132. <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,
  133. <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;encoding)</code>
  134. <div class="block">Creates an archive output stream from an archiver 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/archivers/ArchiveStreamProvider.html#getInputStreamArchiveNames()">getInputStreamArchiveNames</a></strong>()</code>
  141. <div class="block">Gets all the input stream archive 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/archivers/ArchiveStreamProvider.html#getOutputStreamArchiveNames()">getOutputStreamArchiveNames</a></strong>()</code>
  147. <div class="block">Gets all the output stream archive 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="createArchiveInputStream(java.lang.String, java.io.InputStream, java.lang.String)">
  166. <!-- -->
  167. </a>
  168. <ul class="blockList">
  169. <li class="blockList">
  170. <h4>createArchiveInputStream</h4>
  171. <pre><a href="../../../../../org/apache/commons/compress/archivers/ArchiveInputStream.html" title="class in org.apache.commons.compress.archivers">ArchiveInputStream</a>&nbsp;<a href="../../../../../src-html/org/apache/commons/compress/archivers/ArchiveStreamProvider.html#line.60">createArchiveInputStream</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. <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;encoding)
  174. throws <a href="../../../../../org/apache/commons/compress/archivers/ArchiveException.html" title="class in org.apache.commons.compress.archivers">ArchiveException</a></pre>
  175. <div class="block">Creates an archive input stream from an archiver name and an input
  176. stream.</div>
  177. <dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the archive name, i.e.
  178. <a href="../../../../../org/apache/commons/compress/archivers/ArchiveStreamFactory.html#AR">"ar"</a>,
  179. <a href="../../../../../org/apache/commons/compress/archivers/ArchiveStreamFactory.html#ARJ">"arj"</a>,
  180. <a href="../../../../../org/apache/commons/compress/archivers/ArchiveStreamFactory.html#ZIP">"zip"</a>,
  181. <a href="../../../../../org/apache/commons/compress/archivers/ArchiveStreamFactory.html#TAR">"tar"</a>,
  182. <a href="../../../../../org/apache/commons/compress/archivers/ArchiveStreamFactory.html#JAR">"jar"</a>,
  183. <a href="../../../../../org/apache/commons/compress/archivers/ArchiveStreamFactory.html#CPIO">"cpio"</a>,
  184. <a href="../../../../../org/apache/commons/compress/archivers/ArchiveStreamFactory.html#DUMP">"dump"</a>
  185. or
  186. <a href="../../../../../org/apache/commons/compress/archivers/ArchiveStreamFactory.html#SEVEN_Z">"7z"</a></dd><dd><code>in</code> - the input stream</dd><dd><code>encoding</code> - encoding name or null for the default</dd>
  187. <dt><span class="strong">Returns:</span></dt><dd>the archive input stream</dd>
  188. <dt><span class="strong">Throws:</span></dt>
  189. <dd><code><a href="../../../../../org/apache/commons/compress/archivers/ArchiveException.html" title="class in org.apache.commons.compress.archivers">ArchiveException</a></code> - if the archiver name is not known</dd>
  190. <dd><code><a href="../../../../../org/apache/commons/compress/archivers/StreamingNotSupportedException.html" title="class in org.apache.commons.compress.archivers">StreamingNotSupportedException</a></code> - if the format cannot be read from a stream</dd>
  191. <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>
  192. </li>
  193. </ul>
  194. <a name="createArchiveOutputStream(java.lang.String, java.io.OutputStream, java.lang.String)">
  195. <!-- -->
  196. </a>
  197. <ul class="blockList">
  198. <li class="blockList">
  199. <h4>createArchiveOutputStream</h4>
  200. <pre><a href="../../../../../org/apache/commons/compress/archivers/ArchiveOutputStream.html" title="class in org.apache.commons.compress.archivers">ArchiveOutputStream</a>&nbsp;<a href="../../../../../src-html/org/apache/commons/compress/archivers/ArchiveStreamProvider.html#line.87">createArchiveOutputStream</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,
  201. <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,
  202. <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;encoding)
  203. throws <a href="../../../../../org/apache/commons/compress/archivers/ArchiveException.html" title="class in org.apache.commons.compress.archivers">ArchiveException</a></pre>
  204. <div class="block">Creates an archive output stream from an archiver name and an output
  205. stream.</div>
  206. <dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the archive name, i.e.
  207. <a href="../../../../../org/apache/commons/compress/archivers/ArchiveStreamFactory.html#AR">"ar"</a>,
  208. <a href="../../../../../org/apache/commons/compress/archivers/ArchiveStreamFactory.html#ZIP">"zip"</a>,
  209. <a href="../../../../../org/apache/commons/compress/archivers/ArchiveStreamFactory.html#TAR">"tar"</a>,
  210. <a href="../../../../../org/apache/commons/compress/archivers/ArchiveStreamFactory.html#JAR">"jar"</a>
  211. or
  212. <a href="../../../../../org/apache/commons/compress/archivers/ArchiveStreamFactory.html#CPIO">"cpio"</a></dd><dd><code>out</code> - the output stream</dd><dd><code>encoding</code> - encoding name or null for the default</dd>
  213. <dt><span class="strong">Returns:</span></dt><dd>the archive output stream</dd>
  214. <dt><span class="strong">Throws:</span></dt>
  215. <dd><code><a href="../../../../../org/apache/commons/compress/archivers/ArchiveException.html" title="class in org.apache.commons.compress.archivers">ArchiveException</a></code> - if the archiver name is not known</dd>
  216. <dd><code><a href="../../../../../org/apache/commons/compress/archivers/StreamingNotSupportedException.html" title="class in org.apache.commons.compress.archivers">StreamingNotSupportedException</a></code> - if the format cannot be written to a stream</dd>
  217. <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>
  218. </li>
  219. </ul>
  220. <a name="getInputStreamArchiveNames()">
  221. <!-- -->
  222. </a>
  223. <ul class="blockList">
  224. <li class="blockList">
  225. <h4>getInputStreamArchiveNames</h4>
  226. <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/archivers/ArchiveStreamProvider.html#line.95">getInputStreamArchiveNames</a>()</pre>
  227. <div class="block">Gets all the input stream archive names for this provider</div>
  228. <dl><dt><span class="strong">Returns:</span></dt><dd>all the input archive names for this provider</dd></dl>
  229. </li>
  230. </ul>
  231. <a name="getOutputStreamArchiveNames()">
  232. <!-- -->
  233. </a>
  234. <ul class="blockListLast">
  235. <li class="blockList">
  236. <h4>getOutputStreamArchiveNames</h4>
  237. <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/archivers/ArchiveStreamProvider.html#line.102">getOutputStreamArchiveNames</a>()</pre>
  238. <div class="block">Gets all the output stream archive names for this provider</div>
  239. <dl><dt><span class="strong">Returns:</span></dt><dd>all the output archive names for this provider</dd></dl>
  240. </li>
  241. </ul>
  242. </li>
  243. </ul>
  244. </li>
  245. </ul>
  246. </div>
  247. </div>
  248. <!-- ========= END OF CLASS DATA ========= -->
  249. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  250. <div class="bottomNav"><a name="navbar_bottom">
  251. <!-- -->
  252. </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
  253. <!-- -->
  254. </a>
  255. <ul class="navList" title="Navigation">
  256. <li><a href="../../../../../overview-summary.html">Overview</a></li>
  257. <li><a href="package-summary.html">Package</a></li>
  258. <li class="navBarCell1Rev">Class</li>
  259. <li><a href="class-use/ArchiveStreamProvider.html">Use</a></li>
  260. <li><a href="package-tree.html">Tree</a></li>
  261. <li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
  262. <li><a href="../../../../../index-all.html">Index</a></li>
  263. <li><a href="../../../../../help-doc.html">Help</a></li>
  264. </ul>
  265. </div>
  266. <div class="subNav">
  267. <ul class="navList">
  268. <li><a href="../../../../../org/apache/commons/compress/archivers/ArchiveStreamFactory.html" title="class in org.apache.commons.compress.archivers"><span class="strong">Prev Class</span></a></li>
  269. <li><a href="../../../../../org/apache/commons/compress/archivers/Lister.html" title="class in org.apache.commons.compress.archivers"><span class="strong">Next Class</span></a></li>
  270. </ul>
  271. <ul class="navList">
  272. <li><a href="../../../../../index.html?org/apache/commons/compress/archivers/ArchiveStreamProvider.html" target="_top">Frames</a></li>
  273. <li><a href="ArchiveStreamProvider.html" target="_top">No Frames</a></li>
  274. </ul>
  275. <ul class="navList" id="allclasses_navbar_bottom">
  276. <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
  277. </ul>
  278. <div>
  279. <script type="text/javascript"><!--
  280. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  281. if(window==top) {
  282. allClassesLink.style.display = "block";
  283. }
  284. else {
  285. allClassesLink.style.display = "none";
  286. }
  287. //-->
  288. </script>
  289. </div>
  290. <div>
  291. <ul class="subNavList">
  292. <li>Summary:&nbsp;</li>
  293. <li>Nested&nbsp;|&nbsp;</li>
  294. <li>Field&nbsp;|&nbsp;</li>
  295. <li>Constr&nbsp;|&nbsp;</li>
  296. <li><a href="#method_summary">Method</a></li>
  297. </ul>
  298. <ul class="subNavList">
  299. <li>Detail:&nbsp;</li>
  300. <li>Field&nbsp;|&nbsp;</li>
  301. <li>Constr&nbsp;|&nbsp;</li>
  302. <li><a href="#method_detail">Method</a></li>
  303. </ul>
  304. </div>
  305. <a name="skip-navbar_bottom">
  306. <!-- -->
  307. </a></div>
  308. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  309. <p class="legalCopy"><small>Copyright &#169; 2016 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
  310. </body>
  311. </html>