ArchiveStreamFactory.html 60 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838
  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>ArchiveStreamFactory (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="ArchiveStreamFactory (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/ArchiveStreamFactory.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/ArchiveOutputStream.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/ArchiveStreamProvider.html" title="interface 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/ArchiveStreamFactory.html" target="_top">Frames</a></li>
  47. <li><a href="ArchiveStreamFactory.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><a href="#field_summary">Field</a>&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><a href="#field_detail">Field</a>&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.archivers</div>
  86. <h2 title="Class ArchiveStreamFactory" class="title">Class ArchiveStreamFactory</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.archivers.ArchiveStreamFactory</li>
  94. </ul>
  95. </li>
  96. </ul>
  97. <div class="description">
  98. <ul class="blockList">
  99. <li class="blockList">
  100. <dl>
  101. <dt>All Implemented Interfaces:</dt>
  102. <dd><a href="../../../../../org/apache/commons/compress/archivers/ArchiveStreamProvider.html" title="interface in org.apache.commons.compress.archivers">ArchiveStreamProvider</a></dd>
  103. </dl>
  104. <hr>
  105. <br>
  106. <pre>public class <a href="../../../../../src-html/org/apache/commons/compress/archivers/ArchiveStreamFactory.html#line.89">ArchiveStreamFactory</a>
  107. 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>
  108. implements <a href="../../../../../org/apache/commons/compress/archivers/ArchiveStreamProvider.html" title="interface in org.apache.commons.compress.archivers">ArchiveStreamProvider</a></pre>
  109. <div class="block">Factory to create Archive[In|Out]putStreams from names or the first bytes of
  110. the InputStream. In order to add other implementations, you should extend
  111. ArchiveStreamFactory and override the appropriate methods (and call their
  112. implementation from super of course).
  113. Compressing a ZIP-File:
  114. <pre>
  115. final OutputStream out = new FileOutputStream(output);
  116. ArchiveOutputStream os = new ArchiveStreamFactory().createArchiveOutputStream(ArchiveStreamFactory.ZIP, out);
  117. os.putArchiveEntry(new ZipArchiveEntry("testdata/test1.xml"));
  118. IOUtils.copy(new FileInputStream(file1), os);
  119. os.closeArchiveEntry();
  120. os.putArchiveEntry(new ZipArchiveEntry("testdata/test2.xml"));
  121. IOUtils.copy(new FileInputStream(file2), os);
  122. os.closeArchiveEntry();
  123. os.close();
  124. </pre>
  125. Decompressing a ZIP-File:
  126. <pre>
  127. final InputStream is = new FileInputStream(input);
  128. ArchiveInputStream in = new ArchiveStreamFactory().createArchiveInputStream(ArchiveStreamFactory.ZIP, is);
  129. ZipArchiveEntry entry = (ZipArchiveEntry)in.getNextEntry();
  130. OutputStream out = new FileOutputStream(new File(dir, entry.getName()));
  131. IOUtils.copy(in, out);
  132. out.close();
  133. in.close();
  134. </pre></div>
  135. <dl><dt><span class="strong">This class is immutable</span></dt>
  136. <dd>provided that the deprecated method setEntryEncoding is not used.</dd>
  137. <dt><span class="strong">This class is thread-safe</span></dt>
  138. <dd>even if the deprecated method setEntryEncoding is used</dd></dl>
  139. </li>
  140. </ul>
  141. </div>
  142. <div class="summary">
  143. <ul class="blockList">
  144. <li class="blockList">
  145. <!-- =========== FIELD SUMMARY =========== -->
  146. <ul class="blockList">
  147. <li class="blockList"><a name="field_summary">
  148. <!-- -->
  149. </a>
  150. <h3>Field Summary</h3>
  151. <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
  152. <caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
  153. <tr>
  154. <th class="colFirst" scope="col">Modifier and Type</th>
  155. <th class="colLast" scope="col">Field and Description</th>
  156. </tr>
  157. <tr class="altColor">
  158. <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>
  159. <td class="colLast"><code><strong><a href="../../../../../org/apache/commons/compress/archivers/ArchiveStreamFactory.html#AR">AR</a></strong></code>
  160. <div class="block">Constant (value "ar") used to identify the AR archive format.</div>
  161. </td>
  162. </tr>
  163. <tr class="rowColor">
  164. <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>
  165. <td class="colLast"><code><strong><a href="../../../../../org/apache/commons/compress/archivers/ArchiveStreamFactory.html#ARJ">ARJ</a></strong></code>
  166. <div class="block">Constant (value "arj") used to identify the ARJ archive format.</div>
  167. </td>
  168. </tr>
  169. <tr class="altColor">
  170. <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>
  171. <td class="colLast"><code><strong><a href="../../../../../org/apache/commons/compress/archivers/ArchiveStreamFactory.html#CPIO">CPIO</a></strong></code>
  172. <div class="block">Constant (value "cpio") used to identify the CPIO archive format.</div>
  173. </td>
  174. </tr>
  175. <tr class="rowColor">
  176. <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>
  177. <td class="colLast"><code><strong><a href="../../../../../org/apache/commons/compress/archivers/ArchiveStreamFactory.html#DUMP">DUMP</a></strong></code>
  178. <div class="block">Constant (value "dump") used to identify the Unix DUMP archive format.</div>
  179. </td>
  180. </tr>
  181. <tr class="altColor">
  182. <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>
  183. <td class="colLast"><code><strong><a href="../../../../../org/apache/commons/compress/archivers/ArchiveStreamFactory.html#JAR">JAR</a></strong></code>
  184. <div class="block">Constant (value "jar") used to identify the JAR archive format.</div>
  185. </td>
  186. </tr>
  187. <tr class="rowColor">
  188. <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>
  189. <td class="colLast"><code><strong><a href="../../../../../org/apache/commons/compress/archivers/ArchiveStreamFactory.html#SEVEN_Z">SEVEN_Z</a></strong></code>
  190. <div class="block">Constant (value "7z") used to identify the 7z archive format.</div>
  191. </td>
  192. </tr>
  193. <tr class="altColor">
  194. <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>
  195. <td class="colLast"><code><strong><a href="../../../../../org/apache/commons/compress/archivers/ArchiveStreamFactory.html#TAR">TAR</a></strong></code>
  196. <div class="block">Constant used to identify the TAR archive format.</div>
  197. </td>
  198. </tr>
  199. <tr class="rowColor">
  200. <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>
  201. <td class="colLast"><code><strong><a href="../../../../../org/apache/commons/compress/archivers/ArchiveStreamFactory.html#ZIP">ZIP</a></strong></code>
  202. <div class="block">Constant (value "zip") used to identify the ZIP archive format.</div>
  203. </td>
  204. </tr>
  205. </table>
  206. </li>
  207. </ul>
  208. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  209. <ul class="blockList">
  210. <li class="blockList"><a name="constructor_summary">
  211. <!-- -->
  212. </a>
  213. <h3>Constructor Summary</h3>
  214. <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  215. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  216. <tr>
  217. <th class="colOne" scope="col">Constructor and Description</th>
  218. </tr>
  219. <tr class="altColor">
  220. <td class="colOne"><code><strong><a href="../../../../../org/apache/commons/compress/archivers/ArchiveStreamFactory.html#ArchiveStreamFactory()">ArchiveStreamFactory</a></strong>()</code>
  221. <div class="block">Create an instance using the platform default encoding.</div>
  222. </td>
  223. </tr>
  224. <tr class="rowColor">
  225. <td class="colOne"><code><strong><a href="../../../../../org/apache/commons/compress/archivers/ArchiveStreamFactory.html#ArchiveStreamFactory(java.lang.String)">ArchiveStreamFactory</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;encoding)</code>
  226. <div class="block">Create an instance using the specified encoding.</div>
  227. </td>
  228. </tr>
  229. </table>
  230. </li>
  231. </ul>
  232. <!-- ========== METHOD SUMMARY =========== -->
  233. <ul class="blockList">
  234. <li class="blockList"><a name="method_summary">
  235. <!-- -->
  236. </a>
  237. <h3>Method Summary</h3>
  238. <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  239. <caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
  240. <tr>
  241. <th class="colFirst" scope="col">Modifier and Type</th>
  242. <th class="colLast" scope="col">Method and Description</th>
  243. </tr>
  244. <tr class="altColor">
  245. <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>
  246. <td class="colLast"><code><strong><a href="../../../../../org/apache/commons/compress/archivers/ArchiveStreamFactory.html#createArchiveInputStream(java.io.InputStream)">createArchiveInputStream</a></strong>(<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)</code>
  247. <div class="block">Create an archive input stream from an input stream, autodetecting
  248. the archive type from the first few bytes of the stream.</div>
  249. </td>
  250. </tr>
  251. <tr class="rowColor">
  252. <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>
  253. <td class="colLast"><code><strong><a href="../../../../../org/apache/commons/compress/archivers/ArchiveStreamFactory.html#createArchiveInputStream(java.lang.String,%20java.io.InputStream)">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;archiverName,
  254. <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)</code>
  255. <div class="block">Creates an archive input stream from an archiver name and an input stream.</div>
  256. </td>
  257. </tr>
  258. <tr class="altColor">
  259. <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>
  260. <td class="colLast"><code><strong><a href="../../../../../org/apache/commons/compress/archivers/ArchiveStreamFactory.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;archiverName,
  261. <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,
  262. <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;actualEncoding)</code>
  263. <div class="block">Creates an archive input stream from an archiver name and an input
  264. stream.</div>
  265. </td>
  266. </tr>
  267. <tr class="rowColor">
  268. <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>
  269. <td class="colLast"><code><strong><a href="../../../../../org/apache/commons/compress/archivers/ArchiveStreamFactory.html#createArchiveOutputStream(java.lang.String,%20java.io.OutputStream)">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;archiverName,
  270. <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>
  271. <div class="block">Creates an archive output stream from an archiver name and an output stream.</div>
  272. </td>
  273. </tr>
  274. <tr class="altColor">
  275. <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>
  276. <td class="colLast"><code><strong><a href="../../../../../org/apache/commons/compress/archivers/ArchiveStreamFactory.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;archiverName,
  277. <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,
  278. <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;actualEncoding)</code>
  279. <div class="block">Creates an archive output stream from an archiver name and an output
  280. stream.</div>
  281. </td>
  282. </tr>
  283. <tr class="rowColor">
  284. <td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/util/SortedMap.html?is-external=true" title="class or interface in java.util">SortedMap</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>,<a href="../../../../../org/apache/commons/compress/archivers/ArchiveStreamProvider.html" title="interface in org.apache.commons.compress.archivers">ArchiveStreamProvider</a>&gt;</code></td>
  285. <td class="colLast"><code><strong><a href="../../../../../org/apache/commons/compress/archivers/ArchiveStreamFactory.html#findAvailableArchiveInputStreamProviders()">findAvailableArchiveInputStreamProviders</a></strong>()</code>
  286. <div class="block">Constructs a new sorted map from input stream provider names to provider
  287. objects.</div>
  288. </td>
  289. </tr>
  290. <tr class="altColor">
  291. <td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/util/SortedMap.html?is-external=true" title="class or interface in java.util">SortedMap</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>,<a href="../../../../../org/apache/commons/compress/archivers/ArchiveStreamProvider.html" title="interface in org.apache.commons.compress.archivers">ArchiveStreamProvider</a>&gt;</code></td>
  292. <td class="colLast"><code><strong><a href="../../../../../org/apache/commons/compress/archivers/ArchiveStreamFactory.html#findAvailableArchiveOutputStreamProviders()">findAvailableArchiveOutputStreamProviders</a></strong>()</code>
  293. <div class="block">Constructs a new sorted map from output stream provider names to provider
  294. objects.</div>
  295. </td>
  296. </tr>
  297. <tr class="rowColor">
  298. <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/SortedMap.html?is-external=true" title="class or interface in java.util">SortedMap</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>,<a href="../../../../../org/apache/commons/compress/archivers/ArchiveStreamProvider.html" title="interface in org.apache.commons.compress.archivers">ArchiveStreamProvider</a>&gt;</code></td>
  299. <td class="colLast"><code><strong><a href="../../../../../org/apache/commons/compress/archivers/ArchiveStreamFactory.html#getArchiveInputStreamProviders()">getArchiveInputStreamProviders</a></strong>()</code>&nbsp;</td>
  300. </tr>
  301. <tr class="altColor">
  302. <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/SortedMap.html?is-external=true" title="class or interface in java.util">SortedMap</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>,<a href="../../../../../org/apache/commons/compress/archivers/ArchiveStreamProvider.html" title="interface in org.apache.commons.compress.archivers">ArchiveStreamProvider</a>&gt;</code></td>
  303. <td class="colLast"><code><strong><a href="../../../../../org/apache/commons/compress/archivers/ArchiveStreamFactory.html#getArchiveOutputStreamProviders()">getArchiveOutputStreamProviders</a></strong>()</code>&nbsp;</td>
  304. </tr>
  305. <tr class="rowColor">
  306. <td class="colFirst"><code><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>
  307. <td class="colLast"><code><strong><a href="../../../../../org/apache/commons/compress/archivers/ArchiveStreamFactory.html#getEntryEncoding()">getEntryEncoding</a></strong>()</code>
  308. <div class="block">Returns the encoding to use for arj, jar, zip, dump, cpio and tar
  309. files, or null for the archiver default.</div>
  310. </td>
  311. </tr>
  312. <tr class="altColor">
  313. <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>
  314. <td class="colLast"><code><strong><a href="../../../../../org/apache/commons/compress/archivers/ArchiveStreamFactory.html#getInputStreamArchiveNames()">getInputStreamArchiveNames</a></strong>()</code>
  315. <div class="block">Gets all the input stream archive names for this provider</div>
  316. </td>
  317. </tr>
  318. <tr class="rowColor">
  319. <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>
  320. <td class="colLast"><code><strong><a href="../../../../../org/apache/commons/compress/archivers/ArchiveStreamFactory.html#getOutputStreamArchiveNames()">getOutputStreamArchiveNames</a></strong>()</code>
  321. <div class="block">Gets all the output stream archive names for this provider</div>
  322. </td>
  323. </tr>
  324. <tr class="altColor">
  325. <td class="colFirst"><code>void</code></td>
  326. <td class="colLast"><code><strong><a href="../../../../../org/apache/commons/compress/archivers/ArchiveStreamFactory.html#setEntryEncoding(java.lang.String)">setEntryEncoding</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;entryEncoding)</code>
  327. <div class="block"><strong>Deprecated.</strong>&nbsp;
  328. <div class="block"><i>1.10 use <a href="../../../../../org/apache/commons/compress/archivers/ArchiveStreamFactory.html#ArchiveStreamFactory(java.lang.String)"><code>ArchiveStreamFactory(String)</code></a> to specify the encoding</i></div>
  329. </div>
  330. </td>
  331. </tr>
  332. </table>
  333. <ul class="blockList">
  334. <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
  335. <!-- -->
  336. </a>
  337. <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>
  338. <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>
  339. </ul>
  340. </li>
  341. </ul>
  342. </li>
  343. </ul>
  344. </div>
  345. <div class="details">
  346. <ul class="blockList">
  347. <li class="blockList">
  348. <!-- ============ FIELD DETAIL =========== -->
  349. <ul class="blockList">
  350. <li class="blockList"><a name="field_detail">
  351. <!-- -->
  352. </a>
  353. <h3>Field Detail</h3>
  354. <a name="AR">
  355. <!-- -->
  356. </a>
  357. <ul class="blockList">
  358. <li class="blockList">
  359. <h4>AR</h4>
  360. <pre>public static final&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> <a href="../../../../../src-html/org/apache/commons/compress/archivers/ArchiveStreamFactory.html#line.103">AR</a></pre>
  361. <div class="block">Constant (value "ar") used to identify the AR archive format.</div>
  362. <dl><dt><span class="strong">Since:</span></dt>
  363. <dd>1.1</dd>
  364. <dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.commons.compress.archivers.ArchiveStreamFactory.AR">Constant Field Values</a></dd></dl>
  365. </li>
  366. </ul>
  367. <a name="ARJ">
  368. <!-- -->
  369. </a>
  370. <ul class="blockList">
  371. <li class="blockList">
  372. <h4>ARJ</h4>
  373. <pre>public static final&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> <a href="../../../../../src-html/org/apache/commons/compress/archivers/ArchiveStreamFactory.html#line.110">ARJ</a></pre>
  374. <div class="block">Constant (value "arj") used to identify the ARJ archive format.
  375. Not supported as an output stream type.</div>
  376. <dl><dt><span class="strong">Since:</span></dt>
  377. <dd>1.6</dd>
  378. <dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.commons.compress.archivers.ArchiveStreamFactory.ARJ">Constant Field Values</a></dd></dl>
  379. </li>
  380. </ul>
  381. <a name="CPIO">
  382. <!-- -->
  383. </a>
  384. <ul class="blockList">
  385. <li class="blockList">
  386. <h4>CPIO</h4>
  387. <pre>public static final&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> <a href="../../../../../src-html/org/apache/commons/compress/archivers/ArchiveStreamFactory.html#line.116">CPIO</a></pre>
  388. <div class="block">Constant (value "cpio") used to identify the CPIO archive format.</div>
  389. <dl><dt><span class="strong">Since:</span></dt>
  390. <dd>1.1</dd>
  391. <dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.commons.compress.archivers.ArchiveStreamFactory.CPIO">Constant Field Values</a></dd></dl>
  392. </li>
  393. </ul>
  394. <a name="DUMP">
  395. <!-- -->
  396. </a>
  397. <ul class="blockList">
  398. <li class="blockList">
  399. <h4>DUMP</h4>
  400. <pre>public static final&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> <a href="../../../../../src-html/org/apache/commons/compress/archivers/ArchiveStreamFactory.html#line.123">DUMP</a></pre>
  401. <div class="block">Constant (value "dump") used to identify the Unix DUMP archive format.
  402. Not supported as an output stream type.</div>
  403. <dl><dt><span class="strong">Since:</span></dt>
  404. <dd>1.3</dd>
  405. <dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.commons.compress.archivers.ArchiveStreamFactory.DUMP">Constant Field Values</a></dd></dl>
  406. </li>
  407. </ul>
  408. <a name="JAR">
  409. <!-- -->
  410. </a>
  411. <ul class="blockList">
  412. <li class="blockList">
  413. <h4>JAR</h4>
  414. <pre>public static final&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> <a href="../../../../../src-html/org/apache/commons/compress/archivers/ArchiveStreamFactory.html#line.129">JAR</a></pre>
  415. <div class="block">Constant (value "jar") used to identify the JAR archive format.</div>
  416. <dl><dt><span class="strong">Since:</span></dt>
  417. <dd>1.1</dd>
  418. <dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.commons.compress.archivers.ArchiveStreamFactory.JAR">Constant Field Values</a></dd></dl>
  419. </li>
  420. </ul>
  421. <a name="TAR">
  422. <!-- -->
  423. </a>
  424. <ul class="blockList">
  425. <li class="blockList">
  426. <h4>TAR</h4>
  427. <pre>public static final&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> <a href="../../../../../src-html/org/apache/commons/compress/archivers/ArchiveStreamFactory.html#line.135">TAR</a></pre>
  428. <div class="block">Constant used to identify the TAR archive format.</div>
  429. <dl><dt><span class="strong">Since:</span></dt>
  430. <dd>1.1</dd>
  431. <dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.commons.compress.archivers.ArchiveStreamFactory.TAR">Constant Field Values</a></dd></dl>
  432. </li>
  433. </ul>
  434. <a name="ZIP">
  435. <!-- -->
  436. </a>
  437. <ul class="blockList">
  438. <li class="blockList">
  439. <h4>ZIP</h4>
  440. <pre>public static final&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> <a href="../../../../../src-html/org/apache/commons/compress/archivers/ArchiveStreamFactory.html#line.141">ZIP</a></pre>
  441. <div class="block">Constant (value "zip") used to identify the ZIP archive format.</div>
  442. <dl><dt><span class="strong">Since:</span></dt>
  443. <dd>1.1</dd>
  444. <dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.commons.compress.archivers.ArchiveStreamFactory.ZIP">Constant Field Values</a></dd></dl>
  445. </li>
  446. </ul>
  447. <a name="SEVEN_Z">
  448. <!-- -->
  449. </a>
  450. <ul class="blockListLast">
  451. <li class="blockList">
  452. <h4>SEVEN_Z</h4>
  453. <pre>public static final&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> <a href="../../../../../src-html/org/apache/commons/compress/archivers/ArchiveStreamFactory.html#line.147">SEVEN_Z</a></pre>
  454. <div class="block">Constant (value "7z") used to identify the 7z archive format.</div>
  455. <dl><dt><span class="strong">Since:</span></dt>
  456. <dd>1.8</dd>
  457. <dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.commons.compress.archivers.ArchiveStreamFactory.SEVEN_Z">Constant Field Values</a></dd></dl>
  458. </li>
  459. </ul>
  460. </li>
  461. </ul>
  462. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  463. <ul class="blockList">
  464. <li class="blockList"><a name="constructor_detail">
  465. <!-- -->
  466. </a>
  467. <h3>Constructor Detail</h3>
  468. <a name="ArchiveStreamFactory()">
  469. <!-- -->
  470. </a>
  471. <ul class="blockList">
  472. <li class="blockList">
  473. <h4>ArchiveStreamFactory</h4>
  474. <pre>public&nbsp;<a href="../../../../../src-html/org/apache/commons/compress/archivers/ArchiveStreamFactory.html#line.267">ArchiveStreamFactory</a>()</pre>
  475. <div class="block">Create an instance using the platform default encoding.</div>
  476. </li>
  477. </ul>
  478. <a name="ArchiveStreamFactory(java.lang.String)">
  479. <!-- -->
  480. </a>
  481. <ul class="blockListLast">
  482. <li class="blockList">
  483. <h4>ArchiveStreamFactory</h4>
  484. <pre>public&nbsp;<a href="../../../../../src-html/org/apache/commons/compress/archivers/ArchiveStreamFactory.html#line.278">ArchiveStreamFactory</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;encoding)</pre>
  485. <div class="block">Create an instance using the specified encoding.</div>
  486. <dl><dt><span class="strong">Parameters:</span></dt><dd><code>encoding</code> - the encoding to be used.</dd><dt><span class="strong">Since:</span></dt>
  487. <dd>1.10</dd></dl>
  488. </li>
  489. </ul>
  490. </li>
  491. </ul>
  492. <!-- ============ METHOD DETAIL ========== -->
  493. <ul class="blockList">
  494. <li class="blockList"><a name="method_detail">
  495. <!-- -->
  496. </a>
  497. <h3>Method Detail</h3>
  498. <a name="findAvailableArchiveInputStreamProviders()">
  499. <!-- -->
  500. </a>
  501. <ul class="blockList">
  502. <li class="blockList">
  503. <h4>findAvailableArchiveInputStreamProviders</h4>
  504. <pre>public static&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/util/SortedMap.html?is-external=true" title="class or interface in java.util">SortedMap</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>,<a href="../../../../../org/apache/commons/compress/archivers/ArchiveStreamProvider.html" title="interface in org.apache.commons.compress.archivers">ArchiveStreamProvider</a>&gt;&nbsp;<a href="../../../../../src-html/org/apache/commons/compress/archivers/ArchiveStreamFactory.html#line.209">findAvailableArchiveInputStreamProviders</a>()</pre>
  505. <div class="block">Constructs a new sorted map from input stream provider names to provider
  506. objects.
  507. <p>
  508. The map returned by this method will have one entry for each provider for
  509. which support is available in the current Java virtual machine. If two or
  510. more supported provider have the same name then the resulting map will
  511. contain just one of them; which one it will contain is not specified.
  512. </p>
  513. <p>
  514. The invocation of this method, and the subsequent use of the resulting
  515. map, may cause time-consuming disk or network I/O operations to occur.
  516. This method is provided for applications that need to enumerate all of
  517. the available providers, for example to allow user provider selection.
  518. </p>
  519. <p>
  520. This method may return different results at different times if new
  521. providers are dynamically made available to the current Java virtual
  522. machine.
  523. </p></div>
  524. <dl><dt><span class="strong">Returns:</span></dt><dd>An immutable, map from names to provider objects</dd><dt><span class="strong">Since:</span></dt>
  525. <dd>1.13</dd></dl>
  526. </li>
  527. </ul>
  528. <a name="findAvailableArchiveOutputStreamProviders()">
  529. <!-- -->
  530. </a>
  531. <ul class="blockList">
  532. <li class="blockList">
  533. <h4>findAvailableArchiveOutputStreamProviders</h4>
  534. <pre>public static&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/util/SortedMap.html?is-external=true" title="class or interface in java.util">SortedMap</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>,<a href="../../../../../org/apache/commons/compress/archivers/ArchiveStreamProvider.html" title="interface in org.apache.commons.compress.archivers">ArchiveStreamProvider</a>&gt;&nbsp;<a href="../../../../../src-html/org/apache/commons/compress/archivers/ArchiveStreamFactory.html#line.250">findAvailableArchiveOutputStreamProviders</a>()</pre>
  535. <div class="block">Constructs a new sorted map from output stream provider names to provider
  536. objects.
  537. <p>
  538. The map returned by this method will have one entry for each provider for
  539. which support is available in the current Java virtual machine. If two or
  540. more supported provider have the same name then the resulting map will
  541. contain just one of them; which one it will contain is not specified.
  542. </p>
  543. <p>
  544. The invocation of this method, and the subsequent use of the resulting
  545. map, may cause time-consuming disk or network I/O operations to occur.
  546. This method is provided for applications that need to enumerate all of
  547. the available providers, for example to allow user provider selection.
  548. </p>
  549. <p>
  550. This method may return different results at different times if new
  551. providers are dynamically made available to the current Java virtual
  552. machine.
  553. </p></div>
  554. <dl><dt><span class="strong">Returns:</span></dt><dd>An immutable, map from names to provider objects</dd><dt><span class="strong">Since:</span></dt>
  555. <dd>1.13</dd></dl>
  556. </li>
  557. </ul>
  558. <a name="getEntryEncoding()">
  559. <!-- -->
  560. </a>
  561. <ul class="blockList">
  562. <li class="blockList">
  563. <h4>getEntryEncoding</h4>
  564. <pre>public&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/archivers/ArchiveStreamFactory.html#line.292">getEntryEncoding</a>()</pre>
  565. <div class="block">Returns the encoding to use for arj, jar, zip, dump, cpio and tar
  566. files, or null for the archiver default.</div>
  567. <dl><dt><span class="strong">Returns:</span></dt><dd>entry encoding, or null for the archiver default</dd><dt><span class="strong">Since:</span></dt>
  568. <dd>1.5</dd></dl>
  569. </li>
  570. </ul>
  571. <a name="setEntryEncoding(java.lang.String)">
  572. <!-- -->
  573. </a>
  574. <ul class="blockList">
  575. <li class="blockList">
  576. <h4>setEntryEncoding</h4>
  577. <pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
  578. public&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/commons/compress/archivers/ArchiveStreamFactory.html#line.306">setEntryEncoding</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;entryEncoding)</pre>
  579. <div class="block"><span class="strong">Deprecated.</span>&nbsp;<i>1.10 use <a href="../../../../../org/apache/commons/compress/archivers/ArchiveStreamFactory.html#ArchiveStreamFactory(java.lang.String)"><code>ArchiveStreamFactory(String)</code></a> to specify the encoding</i></div>
  580. <div class="block">Sets the encoding to use for arj, jar, zip, dump, cpio and tar files. Use null for the archiver default.</div>
  581. <dl><dt><span class="strong">Parameters:</span></dt><dd><code>entryEncoding</code> - the entry encoding, null uses the archiver default.</dd>
  582. <dt><span class="strong">Throws:</span></dt>
  583. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - if the constructor <a href="../../../../../org/apache/commons/compress/archivers/ArchiveStreamFactory.html#ArchiveStreamFactory(java.lang.String)"><code>ArchiveStreamFactory(String)</code></a>
  584. was used to specify the factory encoding.</dd><dt><span class="strong">Since:</span></dt>
  585. <dd>1.5</dd></dl>
  586. </li>
  587. </ul>
  588. <a name="createArchiveInputStream(java.lang.String, java.io.InputStream)">
  589. <!-- -->
  590. </a>
  591. <ul class="blockList">
  592. <li class="blockList">
  593. <h4>createArchiveInputStream</h4>
  594. <pre>public&nbsp;<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/ArchiveStreamFactory.html#line.326">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;archiverName,
  595. <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)
  596. throws <a href="../../../../../org/apache/commons/compress/archivers/ArchiveException.html" title="class in org.apache.commons.compress.archivers">ArchiveException</a></pre>
  597. <div class="block">Creates an archive input stream from an archiver name and an input stream.</div>
  598. <dl><dt><span class="strong">Parameters:</span></dt><dd><code>archiverName</code> - the archive name,
  599. i.e. <a href="../../../../../org/apache/commons/compress/archivers/ArchiveStreamFactory.html#AR">"ar"</a>, <a href="../../../../../org/apache/commons/compress/archivers/ArchiveStreamFactory.html#ARJ">"arj"</a>, <a href="../../../../../org/apache/commons/compress/archivers/ArchiveStreamFactory.html#ZIP">"zip"</a>, <a href="../../../../../org/apache/commons/compress/archivers/ArchiveStreamFactory.html#TAR">"tar"</a>, <a href="../../../../../org/apache/commons/compress/archivers/ArchiveStreamFactory.html#JAR">"jar"</a>, <a href="../../../../../org/apache/commons/compress/archivers/ArchiveStreamFactory.html#CPIO">"cpio"</a>, <a href="../../../../../org/apache/commons/compress/archivers/ArchiveStreamFactory.html#DUMP">"dump"</a> or <a href="../../../../../org/apache/commons/compress/archivers/ArchiveStreamFactory.html#SEVEN_Z">"7z"</a></dd><dd><code>in</code> - the input stream</dd>
  600. <dt><span class="strong">Returns:</span></dt><dd>the archive input stream</dd>
  601. <dt><span class="strong">Throws:</span></dt>
  602. <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>
  603. <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
  604. read from a stream</dd>
  605. <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>
  606. </li>
  607. </ul>
  608. <a name="createArchiveInputStream(java.lang.String, java.io.InputStream, java.lang.String)">
  609. <!-- -->
  610. </a>
  611. <ul class="blockList">
  612. <li class="blockList">
  613. <h4>createArchiveInputStream</h4>
  614. <pre>public&nbsp;<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/ArchiveStreamFactory.html#line.332">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;archiverName,
  615. <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,
  616. <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;actualEncoding)
  617. throws <a href="../../../../../org/apache/commons/compress/archivers/ArchiveException.html" title="class in org.apache.commons.compress.archivers">ArchiveException</a></pre>
  618. <div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/commons/compress/archivers/ArchiveStreamProvider.html#createArchiveInputStream(java.lang.String,%20java.io.InputStream,%20java.lang.String)">ArchiveStreamProvider</a></code></strong></div>
  619. <div class="block">Creates an archive input stream from an archiver name and an input
  620. stream.</div>
  621. <dl>
  622. <dt><strong>Specified by:</strong></dt>
  623. <dd><code><a href="../../../../../org/apache/commons/compress/archivers/ArchiveStreamProvider.html#createArchiveInputStream(java.lang.String,%20java.io.InputStream,%20java.lang.String)">createArchiveInputStream</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/commons/compress/archivers/ArchiveStreamProvider.html" title="interface in org.apache.commons.compress.archivers">ArchiveStreamProvider</a></code></dd>
  624. <dt><span class="strong">Parameters:</span></dt><dd><code>archiverName</code> - the archive name, i.e.
  625. <a href="../../../../../org/apache/commons/compress/archivers/ArchiveStreamFactory.html#AR">"ar"</a>,
  626. <a href="../../../../../org/apache/commons/compress/archivers/ArchiveStreamFactory.html#ARJ">"arj"</a>,
  627. <a href="../../../../../org/apache/commons/compress/archivers/ArchiveStreamFactory.html#ZIP">"zip"</a>,
  628. <a href="../../../../../org/apache/commons/compress/archivers/ArchiveStreamFactory.html#TAR">"tar"</a>,
  629. <a href="../../../../../org/apache/commons/compress/archivers/ArchiveStreamFactory.html#JAR">"jar"</a>,
  630. <a href="../../../../../org/apache/commons/compress/archivers/ArchiveStreamFactory.html#CPIO">"cpio"</a>,
  631. <a href="../../../../../org/apache/commons/compress/archivers/ArchiveStreamFactory.html#DUMP">"dump"</a>
  632. or
  633. <a href="../../../../../org/apache/commons/compress/archivers/ArchiveStreamFactory.html#SEVEN_Z">"7z"</a></dd><dd><code>in</code> - the input stream</dd><dd><code>actualEncoding</code> - encoding name or null for the default</dd>
  634. <dt><span class="strong">Returns:</span></dt><dd>the archive input stream</dd>
  635. <dt><span class="strong">Throws:</span></dt>
  636. <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>
  637. <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></dl>
  638. </li>
  639. </ul>
  640. <a name="createArchiveOutputStream(java.lang.String, java.io.OutputStream)">
  641. <!-- -->
  642. </a>
  643. <ul class="blockList">
  644. <li class="blockList">
  645. <h4>createArchiveOutputStream</h4>
  646. <pre>public&nbsp;<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/ArchiveStreamFactory.html#line.406">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;archiverName,
  647. <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)
  648. throws <a href="../../../../../org/apache/commons/compress/archivers/ArchiveException.html" title="class in org.apache.commons.compress.archivers">ArchiveException</a></pre>
  649. <div class="block">Creates an archive output stream from an archiver name and an output stream.</div>
  650. <dl><dt><span class="strong">Parameters:</span></dt><dd><code>archiverName</code> - the archive name,
  651. i.e. <a href="../../../../../org/apache/commons/compress/archivers/ArchiveStreamFactory.html#AR">"ar"</a>, <a href="../../../../../org/apache/commons/compress/archivers/ArchiveStreamFactory.html#ZIP">"zip"</a>, <a href="../../../../../org/apache/commons/compress/archivers/ArchiveStreamFactory.html#TAR">"tar"</a>, <a href="../../../../../org/apache/commons/compress/archivers/ArchiveStreamFactory.html#JAR">"jar"</a> or <a href="../../../../../org/apache/commons/compress/archivers/ArchiveStreamFactory.html#CPIO">"cpio"</a></dd><dd><code>out</code> - the output stream</dd>
  652. <dt><span class="strong">Returns:</span></dt><dd>the archive output stream</dd>
  653. <dt><span class="strong">Throws:</span></dt>
  654. <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>
  655. <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
  656. written to a stream</dd>
  657. <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>
  658. </li>
  659. </ul>
  660. <a name="createArchiveOutputStream(java.lang.String, java.io.OutputStream, java.lang.String)">
  661. <!-- -->
  662. </a>
  663. <ul class="blockList">
  664. <li class="blockList">
  665. <h4>createArchiveOutputStream</h4>
  666. <pre>public&nbsp;<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/ArchiveStreamFactory.html#line.412">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;archiverName,
  667. <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,
  668. <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;actualEncoding)
  669. throws <a href="../../../../../org/apache/commons/compress/archivers/ArchiveException.html" title="class in org.apache.commons.compress.archivers">ArchiveException</a></pre>
  670. <div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/commons/compress/archivers/ArchiveStreamProvider.html#createArchiveOutputStream(java.lang.String,%20java.io.OutputStream,%20java.lang.String)">ArchiveStreamProvider</a></code></strong></div>
  671. <div class="block">Creates an archive output stream from an archiver name and an output
  672. stream.</div>
  673. <dl>
  674. <dt><strong>Specified by:</strong></dt>
  675. <dd><code><a href="../../../../../org/apache/commons/compress/archivers/ArchiveStreamProvider.html#createArchiveOutputStream(java.lang.String,%20java.io.OutputStream,%20java.lang.String)">createArchiveOutputStream</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/commons/compress/archivers/ArchiveStreamProvider.html" title="interface in org.apache.commons.compress.archivers">ArchiveStreamProvider</a></code></dd>
  676. <dt><span class="strong">Parameters:</span></dt><dd><code>archiverName</code> - the archive name, i.e.
  677. <a href="../../../../../org/apache/commons/compress/archivers/ArchiveStreamFactory.html#AR">"ar"</a>,
  678. <a href="../../../../../org/apache/commons/compress/archivers/ArchiveStreamFactory.html#ZIP">"zip"</a>,
  679. <a href="../../../../../org/apache/commons/compress/archivers/ArchiveStreamFactory.html#TAR">"tar"</a>,
  680. <a href="../../../../../org/apache/commons/compress/archivers/ArchiveStreamFactory.html#JAR">"jar"</a>
  681. or
  682. <a href="../../../../../org/apache/commons/compress/archivers/ArchiveStreamFactory.html#CPIO">"cpio"</a></dd><dd><code>out</code> - the output stream</dd><dd><code>actualEncoding</code> - encoding name or null for the default</dd>
  683. <dt><span class="strong">Returns:</span></dt><dd>the archive output stream</dd>
  684. <dt><span class="strong">Throws:</span></dt>
  685. <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>
  686. <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></dl>
  687. </li>
  688. </ul>
  689. <a name="createArchiveInputStream(java.io.InputStream)">
  690. <!-- -->
  691. </a>
  692. <ul class="blockList">
  693. <li class="blockList">
  694. <h4>createArchiveInputStream</h4>
  695. <pre>public&nbsp;<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/ArchiveStreamFactory.html#line.474">createArchiveInputStream</a>(<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)
  696. throws <a href="../../../../../org/apache/commons/compress/archivers/ArchiveException.html" title="class in org.apache.commons.compress.archivers">ArchiveException</a></pre>
  697. <div class="block">Create an archive input stream from an input stream, autodetecting
  698. the archive type from the first few bytes of the stream. The InputStream
  699. must support marks, like BufferedInputStream.</div>
  700. <dl><dt><span class="strong">Parameters:</span></dt><dd><code>in</code> - the input stream</dd>
  701. <dt><span class="strong">Returns:</span></dt><dd>the archive input stream</dd>
  702. <dt><span class="strong">Throws:</span></dt>
  703. <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>
  704. <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
  705. read from a stream</dd>
  706. <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 stream is null or does not support mark</dd></dl>
  707. </li>
  708. </ul>
  709. <a name="getArchiveInputStreamProviders()">
  710. <!-- -->
  711. </a>
  712. <ul class="blockList">
  713. <li class="blockList">
  714. <h4>getArchiveInputStreamProviders</h4>
  715. <pre>public&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/util/SortedMap.html?is-external=true" title="class or interface in java.util">SortedMap</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>,<a href="../../../../../org/apache/commons/compress/archivers/ArchiveStreamProvider.html" title="interface in org.apache.commons.compress.archivers">ArchiveStreamProvider</a>&gt;&nbsp;<a href="../../../../../src-html/org/apache/commons/compress/archivers/ArchiveStreamFactory.html#line.545">getArchiveInputStreamProviders</a>()</pre>
  716. </li>
  717. </ul>
  718. <a name="getArchiveOutputStreamProviders()">
  719. <!-- -->
  720. </a>
  721. <ul class="blockList">
  722. <li class="blockList">
  723. <h4>getArchiveOutputStreamProviders</h4>
  724. <pre>public&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/util/SortedMap.html?is-external=true" title="class or interface in java.util">SortedMap</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>,<a href="../../../../../org/apache/commons/compress/archivers/ArchiveStreamProvider.html" title="interface in org.apache.commons.compress.archivers">ArchiveStreamProvider</a>&gt;&nbsp;<a href="../../../../../src-html/org/apache/commons/compress/archivers/ArchiveStreamFactory.html#line.553">getArchiveOutputStreamProviders</a>()</pre>
  725. </li>
  726. </ul>
  727. <a name="getInputStreamArchiveNames()">
  728. <!-- -->
  729. </a>
  730. <ul class="blockList">
  731. <li class="blockList">
  732. <h4>getInputStreamArchiveNames</h4>
  733. <pre>public&nbsp;<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/ArchiveStreamFactory.html#line.562">getInputStreamArchiveNames</a>()</pre>
  734. <div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/commons/compress/archivers/ArchiveStreamProvider.html#getInputStreamArchiveNames()">ArchiveStreamProvider</a></code></strong></div>
  735. <div class="block">Gets all the input stream archive names for this provider</div>
  736. <dl>
  737. <dt><strong>Specified by:</strong></dt>
  738. <dd><code><a href="../../../../../org/apache/commons/compress/archivers/ArchiveStreamProvider.html#getInputStreamArchiveNames()">getInputStreamArchiveNames</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/commons/compress/archivers/ArchiveStreamProvider.html" title="interface in org.apache.commons.compress.archivers">ArchiveStreamProvider</a></code></dd>
  739. <dt><span class="strong">Returns:</span></dt><dd>all the input archive names for this provider</dd></dl>
  740. </li>
  741. </ul>
  742. <a name="getOutputStreamArchiveNames()">
  743. <!-- -->
  744. </a>
  745. <ul class="blockListLast">
  746. <li class="blockList">
  747. <h4>getOutputStreamArchiveNames</h4>
  748. <pre>public&nbsp;<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/ArchiveStreamFactory.html#line.567">getOutputStreamArchiveNames</a>()</pre>
  749. <div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/commons/compress/archivers/ArchiveStreamProvider.html#getOutputStreamArchiveNames()">ArchiveStreamProvider</a></code></strong></div>
  750. <div class="block">Gets all the output stream archive names for this provider</div>
  751. <dl>
  752. <dt><strong>Specified by:</strong></dt>
  753. <dd><code><a href="../../../../../org/apache/commons/compress/archivers/ArchiveStreamProvider.html#getOutputStreamArchiveNames()">getOutputStreamArchiveNames</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/commons/compress/archivers/ArchiveStreamProvider.html" title="interface in org.apache.commons.compress.archivers">ArchiveStreamProvider</a></code></dd>
  754. <dt><span class="strong">Returns:</span></dt><dd>all the output archive names for this provider</dd></dl>
  755. </li>
  756. </ul>
  757. </li>
  758. </ul>
  759. </li>
  760. </ul>
  761. </div>
  762. </div>
  763. <!-- ========= END OF CLASS DATA ========= -->
  764. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  765. <div class="bottomNav"><a name="navbar_bottom">
  766. <!-- -->
  767. </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
  768. <!-- -->
  769. </a>
  770. <ul class="navList" title="Navigation">
  771. <li><a href="../../../../../overview-summary.html">Overview</a></li>
  772. <li><a href="package-summary.html">Package</a></li>
  773. <li class="navBarCell1Rev">Class</li>
  774. <li><a href="class-use/ArchiveStreamFactory.html">Use</a></li>
  775. <li><a href="package-tree.html">Tree</a></li>
  776. <li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
  777. <li><a href="../../../../../index-all.html">Index</a></li>
  778. <li><a href="../../../../../help-doc.html">Help</a></li>
  779. </ul>
  780. </div>
  781. <div class="subNav">
  782. <ul class="navList">
  783. <li><a href="../../../../../org/apache/commons/compress/archivers/ArchiveOutputStream.html" title="class in org.apache.commons.compress.archivers"><span class="strong">Prev Class</span></a></li>
  784. <li><a href="../../../../../org/apache/commons/compress/archivers/ArchiveStreamProvider.html" title="interface in org.apache.commons.compress.archivers"><span class="strong">Next Class</span></a></li>
  785. </ul>
  786. <ul class="navList">
  787. <li><a href="../../../../../index.html?org/apache/commons/compress/archivers/ArchiveStreamFactory.html" target="_top">Frames</a></li>
  788. <li><a href="ArchiveStreamFactory.html" target="_top">No Frames</a></li>
  789. </ul>
  790. <ul class="navList" id="allclasses_navbar_bottom">
  791. <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
  792. </ul>
  793. <div>
  794. <script type="text/javascript"><!--
  795. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  796. if(window==top) {
  797. allClassesLink.style.display = "block";
  798. }
  799. else {
  800. allClassesLink.style.display = "none";
  801. }
  802. //-->
  803. </script>
  804. </div>
  805. <div>
  806. <ul class="subNavList">
  807. <li>Summary:&nbsp;</li>
  808. <li>Nested&nbsp;|&nbsp;</li>
  809. <li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
  810. <li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
  811. <li><a href="#method_summary">Method</a></li>
  812. </ul>
  813. <ul class="subNavList">
  814. <li>Detail:&nbsp;</li>
  815. <li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li>
  816. <li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
  817. <li><a href="#method_detail">Method</a></li>
  818. </ul>
  819. </div>
  820. <a name="skip-navbar_bottom">
  821. <!-- -->
  822. </a></div>
  823. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  824. <p class="legalCopy"><small>Copyright &#169; 2016 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
  825. </body>
  826. </html>