ParallelScatterZipCreator.html 35 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462
  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>ParallelScatterZipCreator (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="ParallelScatterZipCreator (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/ParallelScatterZipCreator.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/zip/JarMarker.html" title="class in org.apache.commons.compress.archivers.zip"><span class="strong">Prev Class</span></a></li>
  43. <li><a href="../../../../../../org/apache/commons/compress/archivers/zip/PKWareExtraHeader.html" title="class in org.apache.commons.compress.archivers.zip"><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/zip/ParallelScatterZipCreator.html" target="_top">Frames</a></li>
  47. <li><a href="ParallelScatterZipCreator.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><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>Field&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.zip</div>
  86. <h2 title="Class ParallelScatterZipCreator" class="title">Class ParallelScatterZipCreator</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.zip.ParallelScatterZipCreator</li>
  94. </ul>
  95. </li>
  96. </ul>
  97. <div class="description">
  98. <ul class="blockList">
  99. <li class="blockList">
  100. <hr>
  101. <br>
  102. <pre>public class <a href="../../../../../../src-html/org/apache/commons/compress/archivers/zip/ParallelScatterZipCreator.html#line.54">ParallelScatterZipCreator</a>
  103. extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
  104. <div class="block">Creates a zip in parallel by using multiple threadlocal <a href="../../../../../../org/apache/commons/compress/archivers/zip/ScatterZipOutputStream.html" title="class in org.apache.commons.compress.archivers.zip"><code>ScatterZipOutputStream</code></a> instances.
  105. <p>
  106. Note that this class generally makes no guarantees about the order of things written to
  107. the output file. Things that need to come in a specific order (manifests, directories)
  108. must be handled by the client of this class, usually by writing these things to the
  109. <a href="../../../../../../org/apache/commons/compress/archivers/zip/ZipArchiveOutputStream.html" title="class in org.apache.commons.compress.archivers.zip"><code>ZipArchiveOutputStream</code></a> <em>before</em> calling <a href="../../../../../../org/apache/commons/compress/archivers/zip/ParallelScatterZipCreator.html#writeTo(org.apache.commons.compress.archivers.zip.ZipArchiveOutputStream)"><code>writeTo</code></a> on this class.</p>
  110. <p>
  111. The client can supply an <a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/ExecutorService.html?is-external=true" title="class or interface in java.util.concurrent"><code>ExecutorService</code></a>, but for reasons of
  112. memory model consistency, this will be shut down by this class prior to completion.
  113. </p></div>
  114. <dl><dt><span class="strong">Since:</span></dt>
  115. <dd>1.10</dd></dl>
  116. </li>
  117. </ul>
  118. </div>
  119. <div class="summary">
  120. <ul class="blockList">
  121. <li class="blockList">
  122. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  123. <ul class="blockList">
  124. <li class="blockList"><a name="constructor_summary">
  125. <!-- -->
  126. </a>
  127. <h3>Constructor Summary</h3>
  128. <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  129. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  130. <tr>
  131. <th class="colOne" scope="col">Constructor and Description</th>
  132. </tr>
  133. <tr class="altColor">
  134. <td class="colOne"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/zip/ParallelScatterZipCreator.html#ParallelScatterZipCreator()">ParallelScatterZipCreator</a></strong>()</code>
  135. <div class="block">Create a ParallelScatterZipCreator with default threads, which is set to the number of available
  136. processors, as defined by <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Runtime.html?is-external=true#availableProcessors()" title="class or interface in java.lang"><code>Runtime.availableProcessors()</code></a></div>
  137. </td>
  138. </tr>
  139. <tr class="rowColor">
  140. <td class="colOne"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/zip/ParallelScatterZipCreator.html#ParallelScatterZipCreator(java.util.concurrent.ExecutorService)">ParallelScatterZipCreator</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/ExecutorService.html?is-external=true" title="class or interface in java.util.concurrent">ExecutorService</a>&nbsp;executorService)</code>
  141. <div class="block">Create a ParallelScatterZipCreator</div>
  142. </td>
  143. </tr>
  144. <tr class="altColor">
  145. <td class="colOne"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/zip/ParallelScatterZipCreator.html#ParallelScatterZipCreator(java.util.concurrent.ExecutorService,%20org.apache.commons.compress.parallel.ScatterGatherBackingStoreSupplier)">ParallelScatterZipCreator</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/ExecutorService.html?is-external=true" title="class or interface in java.util.concurrent">ExecutorService</a>&nbsp;executorService,
  146. <a href="../../../../../../org/apache/commons/compress/parallel/ScatterGatherBackingStoreSupplier.html" title="interface in org.apache.commons.compress.parallel">ScatterGatherBackingStoreSupplier</a>&nbsp;backingStoreSupplier)</code>
  147. <div class="block">Create a ParallelScatterZipCreator</div>
  148. </td>
  149. </tr>
  150. </table>
  151. </li>
  152. </ul>
  153. <!-- ========== METHOD SUMMARY =========== -->
  154. <ul class="blockList">
  155. <li class="blockList"><a name="method_summary">
  156. <!-- -->
  157. </a>
  158. <h3>Method Summary</h3>
  159. <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  160. <caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
  161. <tr>
  162. <th class="colFirst" scope="col">Modifier and Type</th>
  163. <th class="colLast" scope="col">Method and Description</th>
  164. </tr>
  165. <tr class="altColor">
  166. <td class="colFirst"><code>void</code></td>
  167. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/zip/ParallelScatterZipCreator.html#addArchiveEntry(org.apache.commons.compress.archivers.zip.ZipArchiveEntry,%20org.apache.commons.compress.parallel.InputStreamSupplier)">addArchiveEntry</a></strong>(<a href="../../../../../../org/apache/commons/compress/archivers/zip/ZipArchiveEntry.html" title="class in org.apache.commons.compress.archivers.zip">ZipArchiveEntry</a>&nbsp;zipArchiveEntry,
  168. <a href="../../../../../../org/apache/commons/compress/parallel/InputStreamSupplier.html" title="interface in org.apache.commons.compress.parallel">InputStreamSupplier</a>&nbsp;source)</code>
  169. <div class="block">Adds an archive entry to this archive.</div>
  170. </td>
  171. </tr>
  172. <tr class="rowColor">
  173. <td class="colFirst"><code>void</code></td>
  174. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/zip/ParallelScatterZipCreator.html#addArchiveEntry(org.apache.commons.compress.archivers.zip.ZipArchiveEntryRequestSupplier)">addArchiveEntry</a></strong>(<a href="../../../../../../org/apache/commons/compress/archivers/zip/ZipArchiveEntryRequestSupplier.html" title="interface in org.apache.commons.compress.archivers.zip">ZipArchiveEntryRequestSupplier</a>&nbsp;zipArchiveEntryRequestSupplier)</code>
  175. <div class="block">Adds an archive entry to this archive.</div>
  176. </td>
  177. </tr>
  178. <tr class="altColor">
  179. <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/Callable.html?is-external=true" title="class or interface in java.util.concurrent">Callable</a>&lt;<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>&gt;</code></td>
  180. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/zip/ParallelScatterZipCreator.html#createCallable(org.apache.commons.compress.archivers.zip.ZipArchiveEntry,%20org.apache.commons.compress.parallel.InputStreamSupplier)">createCallable</a></strong>(<a href="../../../../../../org/apache/commons/compress/archivers/zip/ZipArchiveEntry.html" title="class in org.apache.commons.compress.archivers.zip">ZipArchiveEntry</a>&nbsp;zipArchiveEntry,
  181. <a href="../../../../../../org/apache/commons/compress/parallel/InputStreamSupplier.html" title="interface in org.apache.commons.compress.parallel">InputStreamSupplier</a>&nbsp;source)</code>
  182. <div class="block">Create a callable that will compress the given archive entry.</div>
  183. </td>
  184. </tr>
  185. <tr class="rowColor">
  186. <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/Callable.html?is-external=true" title="class or interface in java.util.concurrent">Callable</a>&lt;<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>&gt;</code></td>
  187. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/zip/ParallelScatterZipCreator.html#createCallable(org.apache.commons.compress.archivers.zip.ZipArchiveEntryRequestSupplier)">createCallable</a></strong>(<a href="../../../../../../org/apache/commons/compress/archivers/zip/ZipArchiveEntryRequestSupplier.html" title="interface in org.apache.commons.compress.archivers.zip">ZipArchiveEntryRequestSupplier</a>&nbsp;zipArchiveEntryRequestSupplier)</code>
  188. <div class="block">Create a callable that will compress archive entry supplied by <a href="../../../../../../org/apache/commons/compress/archivers/zip/ZipArchiveEntryRequestSupplier.html" title="interface in org.apache.commons.compress.archivers.zip"><code>ZipArchiveEntryRequestSupplier</code></a>.</div>
  189. </td>
  190. </tr>
  191. <tr class="altColor">
  192. <td class="colFirst"><code><a href="../../../../../../org/apache/commons/compress/archivers/zip/ScatterStatistics.html" title="class in org.apache.commons.compress.archivers.zip">ScatterStatistics</a></code></td>
  193. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/zip/ParallelScatterZipCreator.html#getStatisticsMessage()">getStatisticsMessage</a></strong>()</code>
  194. <div class="block">Returns a message describing the overall statistics of the compression run</div>
  195. </td>
  196. </tr>
  197. <tr class="rowColor">
  198. <td class="colFirst"><code>void</code></td>
  199. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/zip/ParallelScatterZipCreator.html#submit(java.util.concurrent.Callable)">submit</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/Callable.html?is-external=true" title="class or interface in java.util.concurrent">Callable</a>&lt;<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>&gt;&nbsp;callable)</code>
  200. <div class="block">Submit a callable for compression.</div>
  201. </td>
  202. </tr>
  203. <tr class="altColor">
  204. <td class="colFirst"><code>void</code></td>
  205. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/zip/ParallelScatterZipCreator.html#writeTo(org.apache.commons.compress.archivers.zip.ZipArchiveOutputStream)">writeTo</a></strong>(<a href="../../../../../../org/apache/commons/compress/archivers/zip/ZipArchiveOutputStream.html" title="class in org.apache.commons.compress.archivers.zip">ZipArchiveOutputStream</a>&nbsp;targetStream)</code>
  206. <div class="block">Write the contents this to the target <a href="../../../../../../org/apache/commons/compress/archivers/zip/ZipArchiveOutputStream.html" title="class in org.apache.commons.compress.archivers.zip"><code>ZipArchiveOutputStream</code></a>.</div>
  207. </td>
  208. </tr>
  209. </table>
  210. <ul class="blockList">
  211. <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
  212. <!-- -->
  213. </a>
  214. <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>
  215. <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>
  216. </ul>
  217. </li>
  218. </ul>
  219. </li>
  220. </ul>
  221. </div>
  222. <div class="details">
  223. <ul class="blockList">
  224. <li class="blockList">
  225. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  226. <ul class="blockList">
  227. <li class="blockList"><a name="constructor_detail">
  228. <!-- -->
  229. </a>
  230. <h3>Constructor Detail</h3>
  231. <a name="ParallelScatterZipCreator()">
  232. <!-- -->
  233. </a>
  234. <ul class="blockList">
  235. <li class="blockList">
  236. <h4>ParallelScatterZipCreator</h4>
  237. <pre>public&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/zip/ParallelScatterZipCreator.html#line.99">ParallelScatterZipCreator</a>()</pre>
  238. <div class="block">Create a ParallelScatterZipCreator with default threads, which is set to the number of available
  239. processors, as defined by <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Runtime.html?is-external=true#availableProcessors()" title="class or interface in java.lang"><code>Runtime.availableProcessors()</code></a></div>
  240. </li>
  241. </ul>
  242. <a name="ParallelScatterZipCreator(java.util.concurrent.ExecutorService)">
  243. <!-- -->
  244. </a>
  245. <ul class="blockList">
  246. <li class="blockList">
  247. <h4>ParallelScatterZipCreator</h4>
  248. <pre>public&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/zip/ParallelScatterZipCreator.html#line.109">ParallelScatterZipCreator</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/ExecutorService.html?is-external=true" title="class or interface in java.util.concurrent">ExecutorService</a>&nbsp;executorService)</pre>
  249. <div class="block">Create a ParallelScatterZipCreator</div>
  250. <dl><dt><span class="strong">Parameters:</span></dt><dd><code>executorService</code> - The executorService to use for parallel scheduling. For technical reasons,
  251. this will be shut down by this class.</dd></dl>
  252. </li>
  253. </ul>
  254. <a name="ParallelScatterZipCreator(java.util.concurrent.ExecutorService, org.apache.commons.compress.parallel.ScatterGatherBackingStoreSupplier)">
  255. <!-- -->
  256. </a>
  257. <ul class="blockListLast">
  258. <li class="blockList">
  259. <h4>ParallelScatterZipCreator</h4>
  260. <pre>public&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/zip/ParallelScatterZipCreator.html#line.120">ParallelScatterZipCreator</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/ExecutorService.html?is-external=true" title="class or interface in java.util.concurrent">ExecutorService</a>&nbsp;executorService,
  261. <a href="../../../../../../org/apache/commons/compress/parallel/ScatterGatherBackingStoreSupplier.html" title="interface in org.apache.commons.compress.parallel">ScatterGatherBackingStoreSupplier</a>&nbsp;backingStoreSupplier)</pre>
  262. <div class="block">Create a ParallelScatterZipCreator</div>
  263. <dl><dt><span class="strong">Parameters:</span></dt><dd><code>executorService</code> - The executorService to use. For technical reasons, this will be shut down
  264. by this class.</dd><dd><code>backingStoreSupplier</code> - The supplier of backing store which shall be used</dd></dl>
  265. </li>
  266. </ul>
  267. </li>
  268. </ul>
  269. <!-- ============ METHOD DETAIL ========== -->
  270. <ul class="blockList">
  271. <li class="blockList"><a name="method_detail">
  272. <!-- -->
  273. </a>
  274. <h3>Method Detail</h3>
  275. <a name="addArchiveEntry(org.apache.commons.compress.archivers.zip.ZipArchiveEntry, org.apache.commons.compress.parallel.InputStreamSupplier)">
  276. <!-- -->
  277. </a>
  278. <ul class="blockList">
  279. <li class="blockList">
  280. <h4>addArchiveEntry</h4>
  281. <pre>public&nbsp;void&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/zip/ParallelScatterZipCreator.html#line.136">addArchiveEntry</a>(<a href="../../../../../../org/apache/commons/compress/archivers/zip/ZipArchiveEntry.html" title="class in org.apache.commons.compress.archivers.zip">ZipArchiveEntry</a>&nbsp;zipArchiveEntry,
  282. <a href="../../../../../../org/apache/commons/compress/parallel/InputStreamSupplier.html" title="interface in org.apache.commons.compress.parallel">InputStreamSupplier</a>&nbsp;source)</pre>
  283. <div class="block">Adds an archive entry to this archive.
  284. <p>
  285. This method is expected to be called from a single client thread
  286. </p></div>
  287. <dl><dt><span class="strong">Parameters:</span></dt><dd><code>zipArchiveEntry</code> - The entry to add.</dd><dd><code>source</code> - The source input stream supplier</dd></dl>
  288. </li>
  289. </ul>
  290. <a name="addArchiveEntry(org.apache.commons.compress.archivers.zip.ZipArchiveEntryRequestSupplier)">
  291. <!-- -->
  292. </a>
  293. <ul class="blockList">
  294. <li class="blockList">
  295. <h4>addArchiveEntry</h4>
  296. <pre>public&nbsp;void&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/zip/ParallelScatterZipCreator.html#line.149">addArchiveEntry</a>(<a href="../../../../../../org/apache/commons/compress/archivers/zip/ZipArchiveEntryRequestSupplier.html" title="interface in org.apache.commons.compress.archivers.zip">ZipArchiveEntryRequestSupplier</a>&nbsp;zipArchiveEntryRequestSupplier)</pre>
  297. <div class="block">Adds an archive entry to this archive.
  298. <p>
  299. This method is expected to be called from a single client thread
  300. </p></div>
  301. <dl><dt><span class="strong">Parameters:</span></dt><dd><code>zipArchiveEntryRequestSupplier</code> - Should supply the entry to be added.</dd><dt><span class="strong">Since:</span></dt>
  302. <dd>1.13</dd></dl>
  303. </li>
  304. </ul>
  305. <a name="submit(java.util.concurrent.Callable)">
  306. <!-- -->
  307. </a>
  308. <ul class="blockList">
  309. <li class="blockList">
  310. <h4>submit</h4>
  311. <pre>public final&nbsp;void&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/zip/ParallelScatterZipCreator.html#line.160">submit</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/Callable.html?is-external=true" title="class or interface in java.util.concurrent">Callable</a>&lt;<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>&gt;&nbsp;callable)</pre>
  312. <div class="block">Submit a callable for compression.</div>
  313. <dl><dt><span class="strong">Parameters:</span></dt><dd><code>callable</code> - The callable to run, created by <a href="../../../../../../org/apache/commons/compress/archivers/zip/ParallelScatterZipCreator.html#createCallable(org.apache.commons.compress.archivers.zip.ZipArchiveEntry,%20org.apache.commons.compress.parallel.InputStreamSupplier)"><code>createCallable</code></a>, possibly wrapped by caller.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../org/apache/commons/compress/archivers/zip/ParallelScatterZipCreator.html#createCallable(org.apache.commons.compress.archivers.zip.ZipArchiveEntry,%20org.apache.commons.compress.parallel.InputStreamSupplier)"><code>for details of if/when to use this.</code></a></dd></dl>
  314. </li>
  315. </ul>
  316. <a name="createCallable(org.apache.commons.compress.archivers.zip.ZipArchiveEntry, org.apache.commons.compress.parallel.InputStreamSupplier)">
  317. <!-- -->
  318. </a>
  319. <ul class="blockList">
  320. <li class="blockList">
  321. <h4>createCallable</h4>
  322. <pre>public final&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/Callable.html?is-external=true" title="class or interface in java.util.concurrent">Callable</a>&lt;<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>&gt;&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/zip/ParallelScatterZipCreator.html#line.182">createCallable</a>(<a href="../../../../../../org/apache/commons/compress/archivers/zip/ZipArchiveEntry.html" title="class in org.apache.commons.compress.archivers.zip">ZipArchiveEntry</a>&nbsp;zipArchiveEntry,
  323. <a href="../../../../../../org/apache/commons/compress/parallel/InputStreamSupplier.html" title="interface in org.apache.commons.compress.parallel">InputStreamSupplier</a>&nbsp;source)</pre>
  324. <div class="block">Create a callable that will compress the given archive entry.
  325. <p>This method is expected to be called from a single client thread.</p>
  326. Consider using <a href="../../../../../../org/apache/commons/compress/archivers/zip/ParallelScatterZipCreator.html#addArchiveEntry(org.apache.commons.compress.archivers.zip.ZipArchiveEntry,%20org.apache.commons.compress.parallel.InputStreamSupplier)"><code>addArchiveEntry</code></a>, which wraps this method and <a href="../../../../../../org/apache/commons/compress/archivers/zip/ParallelScatterZipCreator.html#submit(java.util.concurrent.Callable)"><code>submit</code></a>.
  327. The most common use case for using <a href="../../../../../../org/apache/commons/compress/archivers/zip/ParallelScatterZipCreator.html#createCallable(org.apache.commons.compress.archivers.zip.ZipArchiveEntry,%20org.apache.commons.compress.parallel.InputStreamSupplier)"><code>createCallable</code></a> and <a href="../../../../../../org/apache/commons/compress/archivers/zip/ParallelScatterZipCreator.html#submit(java.util.concurrent.Callable)"><code>submit</code></a> from a
  328. client is if you want to wrap the callable in something that can be prioritized by the supplied
  329. <a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/ExecutorService.html?is-external=true" title="class or interface in java.util.concurrent"><code>ExecutorService</code></a>, for instance to process large or slow files first.
  330. Since the creation of the <a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/ExecutorService.html?is-external=true" title="class or interface in java.util.concurrent"><code>ExecutorService</code></a> is handled by the client, all of this is up to the client.</div>
  331. <dl><dt><span class="strong">Parameters:</span></dt><dd><code>zipArchiveEntry</code> - The entry to add.</dd><dd><code>source</code> - The source input stream supplier</dd>
  332. <dt><span class="strong">Returns:</span></dt><dd>A callable that should subsequently passed to #submit, possibly in a wrapped/adapted from. The
  333. value of this callable is not used, but any exceptions happening inside the compression
  334. will be propagated through the callable.</dd></dl>
  335. </li>
  336. </ul>
  337. <a name="createCallable(org.apache.commons.compress.archivers.zip.ZipArchiveEntryRequestSupplier)">
  338. <!-- -->
  339. </a>
  340. <ul class="blockList">
  341. <li class="blockList">
  342. <h4>createCallable</h4>
  343. <pre>public final&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/Callable.html?is-external=true" title="class or interface in java.util.concurrent">Callable</a>&lt;<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>&gt;&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/zip/ParallelScatterZipCreator.html#line.213">createCallable</a>(<a href="../../../../../../org/apache/commons/compress/archivers/zip/ZipArchiveEntryRequestSupplier.html" title="interface in org.apache.commons.compress.archivers.zip">ZipArchiveEntryRequestSupplier</a>&nbsp;zipArchiveEntryRequestSupplier)</pre>
  344. <div class="block">Create a callable that will compress archive entry supplied by <a href="../../../../../../org/apache/commons/compress/archivers/zip/ZipArchiveEntryRequestSupplier.html" title="interface in org.apache.commons.compress.archivers.zip"><code>ZipArchiveEntryRequestSupplier</code></a>.
  345. <p>This method is expected to be called from a single client thread.</p>
  346. The same as <a href="../../../../../../org/apache/commons/compress/archivers/zip/ParallelScatterZipCreator.html#createCallable(org.apache.commons.compress.archivers.zip.ZipArchiveEntry,%20org.apache.commons.compress.parallel.InputStreamSupplier)"><code>createCallable(ZipArchiveEntry, InputStreamSupplier)</code></a>, but the archive entry
  347. to be added is supplied by a <a href="../../../../../../org/apache/commons/compress/archivers/zip/ZipArchiveEntryRequestSupplier.html" title="interface in org.apache.commons.compress.archivers.zip"><code>ZipArchiveEntryRequestSupplier</code></a>.</div>
  348. <dl><dt><span class="strong">Parameters:</span></dt><dd><code>zipArchiveEntryRequestSupplier</code> - Should supply the entry to be added.</dd>
  349. <dt><span class="strong">Returns:</span></dt><dd>A callable that should subsequently passed to #submit, possibly in a wrapped/adapted from. The
  350. value of this callable is not used, but any exceptions happening inside the compression
  351. will be propagated through the callable.</dd><dt><span class="strong">Since:</span></dt>
  352. <dd>1.13</dd>
  353. <dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../org/apache/commons/compress/archivers/zip/ParallelScatterZipCreator.html#createCallable(org.apache.commons.compress.archivers.zip.ZipArchiveEntry,%20org.apache.commons.compress.parallel.InputStreamSupplier)"><code>createCallable(ZipArchiveEntry, InputStreamSupplier)</code></a></dd></dl>
  354. </li>
  355. </ul>
  356. <a name="writeTo(org.apache.commons.compress.archivers.zip.ZipArchiveOutputStream)">
  357. <!-- -->
  358. </a>
  359. <ul class="blockList">
  360. <li class="blockList">
  361. <h4>writeTo</h4>
  362. <pre>public&nbsp;void&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/zip/ParallelScatterZipCreator.html#line.235">writeTo</a>(<a href="../../../../../../org/apache/commons/compress/archivers/zip/ZipArchiveOutputStream.html" title="class in org.apache.commons.compress.archivers.zip">ZipArchiveOutputStream</a>&nbsp;targetStream)
  363. throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a>,
  364. <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/InterruptedException.html?is-external=true" title="class or interface in java.lang">InterruptedException</a>,
  365. <a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/ExecutionException.html?is-external=true" title="class or interface in java.util.concurrent">ExecutionException</a></pre>
  366. <div class="block">Write the contents this to the target <a href="../../../../../../org/apache/commons/compress/archivers/zip/ZipArchiveOutputStream.html" title="class in org.apache.commons.compress.archivers.zip"><code>ZipArchiveOutputStream</code></a>.
  367. <p>
  368. It may be beneficial to write things like directories and manifest files to the targetStream
  369. before calling this method.
  370. </p></div>
  371. <dl><dt><span class="strong">Parameters:</span></dt><dd><code>targetStream</code> - The <a href="../../../../../../org/apache/commons/compress/archivers/zip/ZipArchiveOutputStream.html" title="class in org.apache.commons.compress.archivers.zip"><code>ZipArchiveOutputStream</code></a> to receive the contents of the scatter streams</dd>
  372. <dt><span class="strong">Throws:</span></dt>
  373. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If writing fails</dd>
  374. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/InterruptedException.html?is-external=true" title="class or interface in java.lang">InterruptedException</a></code> - If we get interrupted</dd>
  375. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/ExecutionException.html?is-external=true" title="class or interface in java.util.concurrent">ExecutionException</a></code> - If something happens in the parallel execution</dd></dl>
  376. </li>
  377. </ul>
  378. <a name="getStatisticsMessage()">
  379. <!-- -->
  380. </a>
  381. <ul class="blockListLast">
  382. <li class="blockList">
  383. <h4>getStatisticsMessage</h4>
  384. <pre>public&nbsp;<a href="../../../../../../org/apache/commons/compress/archivers/zip/ScatterStatistics.html" title="class in org.apache.commons.compress.archivers.zip">ScatterStatistics</a>&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/zip/ParallelScatterZipCreator.html#line.262">getStatisticsMessage</a>()</pre>
  385. <div class="block">Returns a message describing the overall statistics of the compression run</div>
  386. <dl><dt><span class="strong">Returns:</span></dt><dd>A string</dd></dl>
  387. </li>
  388. </ul>
  389. </li>
  390. </ul>
  391. </li>
  392. </ul>
  393. </div>
  394. </div>
  395. <!-- ========= END OF CLASS DATA ========= -->
  396. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  397. <div class="bottomNav"><a name="navbar_bottom">
  398. <!-- -->
  399. </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
  400. <!-- -->
  401. </a>
  402. <ul class="navList" title="Navigation">
  403. <li><a href="../../../../../../overview-summary.html">Overview</a></li>
  404. <li><a href="package-summary.html">Package</a></li>
  405. <li class="navBarCell1Rev">Class</li>
  406. <li><a href="class-use/ParallelScatterZipCreator.html">Use</a></li>
  407. <li><a href="package-tree.html">Tree</a></li>
  408. <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
  409. <li><a href="../../../../../../index-all.html">Index</a></li>
  410. <li><a href="../../../../../../help-doc.html">Help</a></li>
  411. </ul>
  412. </div>
  413. <div class="subNav">
  414. <ul class="navList">
  415. <li><a href="../../../../../../org/apache/commons/compress/archivers/zip/JarMarker.html" title="class in org.apache.commons.compress.archivers.zip"><span class="strong">Prev Class</span></a></li>
  416. <li><a href="../../../../../../org/apache/commons/compress/archivers/zip/PKWareExtraHeader.html" title="class in org.apache.commons.compress.archivers.zip"><span class="strong">Next Class</span></a></li>
  417. </ul>
  418. <ul class="navList">
  419. <li><a href="../../../../../../index.html?org/apache/commons/compress/archivers/zip/ParallelScatterZipCreator.html" target="_top">Frames</a></li>
  420. <li><a href="ParallelScatterZipCreator.html" target="_top">No Frames</a></li>
  421. </ul>
  422. <ul class="navList" id="allclasses_navbar_bottom">
  423. <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
  424. </ul>
  425. <div>
  426. <script type="text/javascript"><!--
  427. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  428. if(window==top) {
  429. allClassesLink.style.display = "block";
  430. }
  431. else {
  432. allClassesLink.style.display = "none";
  433. }
  434. //-->
  435. </script>
  436. </div>
  437. <div>
  438. <ul class="subNavList">
  439. <li>Summary:&nbsp;</li>
  440. <li>Nested&nbsp;|&nbsp;</li>
  441. <li>Field&nbsp;|&nbsp;</li>
  442. <li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
  443. <li><a href="#method_summary">Method</a></li>
  444. </ul>
  445. <ul class="subNavList">
  446. <li>Detail:&nbsp;</li>
  447. <li>Field&nbsp;|&nbsp;</li>
  448. <li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
  449. <li><a href="#method_detail">Method</a></li>
  450. </ul>
  451. </div>
  452. <a name="skip-navbar_bottom">
  453. <!-- -->
  454. </a></div>
  455. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  456. <p class="legalCopy"><small>Copyright &#169; 2016 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
  457. </body>
  458. </html>