ArArchiveOutputStream.html 30 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507
  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>ArArchiveOutputStream (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="ArArchiveOutputStream (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/ArArchiveOutputStream.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/ar/ArArchiveInputStream.html" title="class in org.apache.commons.compress.archivers.ar"><span class="strong">Prev Class</span></a></li>
  43. <li>Next Class</li>
  44. </ul>
  45. <ul class="navList">
  46. <li><a href="../../../../../../index.html?org/apache/commons/compress/archivers/ar/ArArchiveOutputStream.html" target="_top">Frames</a></li>
  47. <li><a href="ArArchiveOutputStream.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.ar</div>
  86. <h2 title="Class ArArchiveOutputStream" class="title">Class ArArchiveOutputStream</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><a href="http://docs.oracle.com/javase/7/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">java.io.OutputStream</a></li>
  94. <li>
  95. <ul class="inheritance">
  96. <li><a href="../../../../../../org/apache/commons/compress/archivers/ArchiveOutputStream.html" title="class in org.apache.commons.compress.archivers">org.apache.commons.compress.archivers.ArchiveOutputStream</a></li>
  97. <li>
  98. <ul class="inheritance">
  99. <li>org.apache.commons.compress.archivers.ar.ArArchiveOutputStream</li>
  100. </ul>
  101. </li>
  102. </ul>
  103. </li>
  104. </ul>
  105. </li>
  106. </ul>
  107. <div class="description">
  108. <ul class="blockList">
  109. <li class="blockList">
  110. <dl>
  111. <dt>All Implemented Interfaces:</dt>
  112. <dd><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/io/Flushable.html?is-external=true" title="class or interface in java.io">Flushable</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></dd>
  113. </dl>
  114. <hr>
  115. <br>
  116. <pre>public class <a href="../../../../../../src-html/org/apache/commons/compress/archivers/ar/ArArchiveOutputStream.html#line.34">ArArchiveOutputStream</a>
  117. extends <a href="../../../../../../org/apache/commons/compress/archivers/ArchiveOutputStream.html" title="class in org.apache.commons.compress.archivers">ArchiveOutputStream</a></pre>
  118. <div class="block">Implements the "ar" archive format as an output stream.</div>
  119. <dl><dt><span class="strong">This class is not thread-safe</span></dt>
  120. <dd></dd></dl>
  121. </li>
  122. </ul>
  123. </div>
  124. <div class="summary">
  125. <ul class="blockList">
  126. <li class="blockList">
  127. <!-- =========== FIELD SUMMARY =========== -->
  128. <ul class="blockList">
  129. <li class="blockList"><a name="field_summary">
  130. <!-- -->
  131. </a>
  132. <h3>Field Summary</h3>
  133. <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
  134. <caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
  135. <tr>
  136. <th class="colFirst" scope="col">Modifier and Type</th>
  137. <th class="colLast" scope="col">Field and Description</th>
  138. </tr>
  139. <tr class="altColor">
  140. <td class="colFirst"><code>static int</code></td>
  141. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/ar/ArArchiveOutputStream.html#LONGFILE_BSD">LONGFILE_BSD</a></strong></code>
  142. <div class="block">BSD ar extensions are used to store long file names in the archive.</div>
  143. </td>
  144. </tr>
  145. <tr class="rowColor">
  146. <td class="colFirst"><code>static int</code></td>
  147. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/ar/ArArchiveOutputStream.html#LONGFILE_ERROR">LONGFILE_ERROR</a></strong></code>
  148. <div class="block">Fail if a long file name is required in the archive.</div>
  149. </td>
  150. </tr>
  151. </table>
  152. </li>
  153. </ul>
  154. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  155. <ul class="blockList">
  156. <li class="blockList"><a name="constructor_summary">
  157. <!-- -->
  158. </a>
  159. <h3>Constructor Summary</h3>
  160. <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  161. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  162. <tr>
  163. <th class="colOne" scope="col">Constructor and Description</th>
  164. </tr>
  165. <tr class="altColor">
  166. <td class="colOne"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/ar/ArArchiveOutputStream.html#ArArchiveOutputStream(java.io.OutputStream)">ArArchiveOutputStream</a></strong>(<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;pOut)</code>&nbsp;</td>
  167. </tr>
  168. </table>
  169. </li>
  170. </ul>
  171. <!-- ========== METHOD SUMMARY =========== -->
  172. <ul class="blockList">
  173. <li class="blockList"><a name="method_summary">
  174. <!-- -->
  175. </a>
  176. <h3>Method Summary</h3>
  177. <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  178. <caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
  179. <tr>
  180. <th class="colFirst" scope="col">Modifier and Type</th>
  181. <th class="colLast" scope="col">Method and Description</th>
  182. </tr>
  183. <tr class="altColor">
  184. <td class="colFirst"><code>void</code></td>
  185. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/ar/ArArchiveOutputStream.html#close()">close</a></strong>()</code>
  186. <div class="block">Calls finish if necessary, and then closes the OutputStream</div>
  187. </td>
  188. </tr>
  189. <tr class="rowColor">
  190. <td class="colFirst"><code>void</code></td>
  191. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/ar/ArArchiveOutputStream.html#closeArchiveEntry()">closeArchiveEntry</a></strong>()</code>
  192. <div class="block">Closes the archive entry, writing any trailer information that may
  193. be required.</div>
  194. </td>
  195. </tr>
  196. <tr class="altColor">
  197. <td class="colFirst"><code><a href="../../../../../../org/apache/commons/compress/archivers/ArchiveEntry.html" title="interface in org.apache.commons.compress.archivers">ArchiveEntry</a></code></td>
  198. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/ar/ArArchiveOutputStream.html#createArchiveEntry(java.io.File,%20java.lang.String)">createArchiveEntry</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>&nbsp;inputFile,
  199. <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;entryName)</code>
  200. <div class="block">Create an archive entry using the inputFile and entryName provided.</div>
  201. </td>
  202. </tr>
  203. <tr class="rowColor">
  204. <td class="colFirst"><code>void</code></td>
  205. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/ar/ArArchiveOutputStream.html#finish()">finish</a></strong>()</code>
  206. <div class="block">Finishes the addition of entries to this stream, without closing it.</div>
  207. </td>
  208. </tr>
  209. <tr class="altColor">
  210. <td class="colFirst"><code>void</code></td>
  211. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/ar/ArArchiveOutputStream.html#putArchiveEntry(org.apache.commons.compress.archivers.ArchiveEntry)">putArchiveEntry</a></strong>(<a href="../../../../../../org/apache/commons/compress/archivers/ArchiveEntry.html" title="interface in org.apache.commons.compress.archivers">ArchiveEntry</a>&nbsp;pEntry)</code>
  212. <div class="block">Writes the headers for an archive entry to the output stream.</div>
  213. </td>
  214. </tr>
  215. <tr class="rowColor">
  216. <td class="colFirst"><code>void</code></td>
  217. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/ar/ArArchiveOutputStream.html#setLongFileMode(int)">setLongFileMode</a></strong>(int&nbsp;longFileMode)</code>
  218. <div class="block">Set the long file mode.</div>
  219. </td>
  220. </tr>
  221. <tr class="altColor">
  222. <td class="colFirst"><code>void</code></td>
  223. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/ar/ArArchiveOutputStream.html#write(byte[],%20int,%20int)">write</a></strong>(byte[]&nbsp;b,
  224. int&nbsp;off,
  225. int&nbsp;len)</code>&nbsp;</td>
  226. </tr>
  227. </table>
  228. <ul class="blockList">
  229. <li class="blockList"><a name="methods_inherited_from_class_org.apache.commons.compress.archivers.ArchiveOutputStream">
  230. <!-- -->
  231. </a>
  232. <h3>Methods inherited from class&nbsp;org.apache.commons.compress.archivers.<a href="../../../../../../org/apache/commons/compress/archivers/ArchiveOutputStream.html" title="class in org.apache.commons.compress.archivers">ArchiveOutputStream</a></h3>
  233. <code><a href="../../../../../../org/apache/commons/compress/archivers/ArchiveOutputStream.html#canWriteEntryData(org.apache.commons.compress.archivers.ArchiveEntry)">canWriteEntryData</a>, <a href="../../../../../../org/apache/commons/compress/archivers/ArchiveOutputStream.html#count(int)">count</a>, <a href="../../../../../../org/apache/commons/compress/archivers/ArchiveOutputStream.html#count(long)">count</a>, <a href="../../../../../../org/apache/commons/compress/archivers/ArchiveOutputStream.html#getBytesWritten()">getBytesWritten</a>, <a href="../../../../../../org/apache/commons/compress/archivers/ArchiveOutputStream.html#getCount()">getCount</a>, <a href="../../../../../../org/apache/commons/compress/archivers/ArchiveOutputStream.html#write(int)">write</a></code></li>
  234. </ul>
  235. <ul class="blockList">
  236. <li class="blockList"><a name="methods_inherited_from_class_java.io.OutputStream">
  237. <!-- -->
  238. </a>
  239. <h3>Methods inherited from class&nbsp;java.io.<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></h3>
  240. <code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/OutputStream.html?is-external=true#flush()" title="class or interface in java.io">flush</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/io/OutputStream.html?is-external=true#write(byte[])" title="class or interface in java.io">write</a></code></li>
  241. </ul>
  242. <ul class="blockList">
  243. <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
  244. <!-- -->
  245. </a>
  246. <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>
  247. <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>
  248. </ul>
  249. </li>
  250. </ul>
  251. </li>
  252. </ul>
  253. </div>
  254. <div class="details">
  255. <ul class="blockList">
  256. <li class="blockList">
  257. <!-- ============ FIELD DETAIL =========== -->
  258. <ul class="blockList">
  259. <li class="blockList"><a name="field_detail">
  260. <!-- -->
  261. </a>
  262. <h3>Field Detail</h3>
  263. <a name="LONGFILE_ERROR">
  264. <!-- -->
  265. </a>
  266. <ul class="blockList">
  267. <li class="blockList">
  268. <h4>LONGFILE_ERROR</h4>
  269. <pre>public static final&nbsp;int <a href="../../../../../../src-html/org/apache/commons/compress/archivers/ar/ArArchiveOutputStream.html#line.36">LONGFILE_ERROR</a></pre>
  270. <div class="block">Fail if a long file name is required in the archive.</div>
  271. <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../constant-values.html#org.apache.commons.compress.archivers.ar.ArArchiveOutputStream.LONGFILE_ERROR">Constant Field Values</a></dd></dl>
  272. </li>
  273. </ul>
  274. <a name="LONGFILE_BSD">
  275. <!-- -->
  276. </a>
  277. <ul class="blockListLast">
  278. <li class="blockList">
  279. <h4>LONGFILE_BSD</h4>
  280. <pre>public static final&nbsp;int <a href="../../../../../../src-html/org/apache/commons/compress/archivers/ar/ArArchiveOutputStream.html#line.39">LONGFILE_BSD</a></pre>
  281. <div class="block">BSD ar extensions are used to store long file names in the archive.</div>
  282. <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../constant-values.html#org.apache.commons.compress.archivers.ar.ArArchiveOutputStream.LONGFILE_BSD">Constant Field Values</a></dd></dl>
  283. </li>
  284. </ul>
  285. </li>
  286. </ul>
  287. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  288. <ul class="blockList">
  289. <li class="blockList"><a name="constructor_detail">
  290. <!-- -->
  291. </a>
  292. <h3>Constructor Detail</h3>
  293. <a name="ArArchiveOutputStream(java.io.OutputStream)">
  294. <!-- -->
  295. </a>
  296. <ul class="blockListLast">
  297. <li class="blockList">
  298. <h4>ArArchiveOutputStream</h4>
  299. <pre>public&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/ar/ArArchiveOutputStream.html#line.50">ArArchiveOutputStream</a>(<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;pOut)</pre>
  300. </li>
  301. </ul>
  302. </li>
  303. </ul>
  304. <!-- ============ METHOD DETAIL ========== -->
  305. <ul class="blockList">
  306. <li class="blockList"><a name="method_detail">
  307. <!-- -->
  308. </a>
  309. <h3>Method Detail</h3>
  310. <a name="setLongFileMode(int)">
  311. <!-- -->
  312. </a>
  313. <ul class="blockList">
  314. <li class="blockList">
  315. <h4>setLongFileMode</h4>
  316. <pre>public&nbsp;void&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/ar/ArArchiveOutputStream.html#line.62">setLongFileMode</a>(int&nbsp;longFileMode)</pre>
  317. <div class="block">Set the long file mode.
  318. This can be LONGFILE_ERROR(0) or LONGFILE_BSD(1).
  319. This specifies the treatment of long file names (names &gt;= 16).
  320. Default is LONGFILE_ERROR.</div>
  321. <dl><dt><span class="strong">Parameters:</span></dt><dd><code>longFileMode</code> - the mode to use</dd><dt><span class="strong">Since:</span></dt>
  322. <dd>1.3</dd></dl>
  323. </li>
  324. </ul>
  325. <a name="closeArchiveEntry()">
  326. <!-- -->
  327. </a>
  328. <ul class="blockList">
  329. <li class="blockList">
  330. <h4>closeArchiveEntry</h4>
  331. <pre>public&nbsp;void&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/ar/ArArchiveOutputStream.html#line.73">closeArchiveEntry</a>()
  332. 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></pre>
  333. <div class="block"><strong>Description copied from class:&nbsp;<code><a href="../../../../../../org/apache/commons/compress/archivers/ArchiveOutputStream.html#closeArchiveEntry()">ArchiveOutputStream</a></code></strong></div>
  334. <div class="block">Closes the archive entry, writing any trailer information that may
  335. be required.</div>
  336. <dl>
  337. <dt><strong>Specified by:</strong></dt>
  338. <dd><code><a href="../../../../../../org/apache/commons/compress/archivers/ArchiveOutputStream.html#closeArchiveEntry()">closeArchiveEntry</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../org/apache/commons/compress/archivers/ArchiveOutputStream.html" title="class in org.apache.commons.compress.archivers">ArchiveOutputStream</a></code></dd>
  339. <dt><span class="strong">Throws:</span></dt>
  340. <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 an I/O error occurs</dd></dl>
  341. </li>
  342. </ul>
  343. <a name="putArchiveEntry(org.apache.commons.compress.archivers.ArchiveEntry)">
  344. <!-- -->
  345. </a>
  346. <ul class="blockList">
  347. <li class="blockList">
  348. <h4>putArchiveEntry</h4>
  349. <pre>public&nbsp;void&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/ar/ArArchiveOutputStream.html#line.87">putArchiveEntry</a>(<a href="../../../../../../org/apache/commons/compress/archivers/ArchiveEntry.html" title="interface in org.apache.commons.compress.archivers">ArchiveEntry</a>&nbsp;pEntry)
  350. 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></pre>
  351. <div class="block"><strong>Description copied from class:&nbsp;<code><a href="../../../../../../org/apache/commons/compress/archivers/ArchiveOutputStream.html#putArchiveEntry(org.apache.commons.compress.archivers.ArchiveEntry)">ArchiveOutputStream</a></code></strong></div>
  352. <div class="block">Writes the headers for an archive entry to the output stream.
  353. The caller must then write the content to the stream and call
  354. <a href="../../../../../../org/apache/commons/compress/archivers/ArchiveOutputStream.html#closeArchiveEntry()"><code>ArchiveOutputStream.closeArchiveEntry()</code></a> to complete the process.</div>
  355. <dl>
  356. <dt><strong>Specified by:</strong></dt>
  357. <dd><code><a href="../../../../../../org/apache/commons/compress/archivers/ArchiveOutputStream.html#putArchiveEntry(org.apache.commons.compress.archivers.ArchiveEntry)">putArchiveEntry</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../org/apache/commons/compress/archivers/ArchiveOutputStream.html" title="class in org.apache.commons.compress.archivers">ArchiveOutputStream</a></code></dd>
  358. <dt><span class="strong">Parameters:</span></dt><dd><code>pEntry</code> - describes the entry</dd>
  359. <dt><span class="strong">Throws:</span></dt>
  360. <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 an I/O error occurs</dd></dl>
  361. </li>
  362. </ul>
  363. <a name="write(byte[], int, int)">
  364. <!-- -->
  365. </a>
  366. <ul class="blockList">
  367. <li class="blockList">
  368. <h4>write</h4>
  369. <pre>public&nbsp;void&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/ar/ArArchiveOutputStream.html#line.198">write</a>(byte[]&nbsp;b,
  370. int&nbsp;off,
  371. int&nbsp;len)
  372. 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></pre>
  373. <dl>
  374. <dt><strong>Overrides:</strong></dt>
  375. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/OutputStream.html?is-external=true#write(byte[],%20int,%20int)" title="class or interface in java.io">write</a></code>&nbsp;in class&nbsp;<code><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></code></dd>
  376. <dt><span class="strong">Throws:</span></dt>
  377. <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></dd></dl>
  378. </li>
  379. </ul>
  380. <a name="close()">
  381. <!-- -->
  382. </a>
  383. <ul class="blockList">
  384. <li class="blockList">
  385. <h4>close</h4>
  386. <pre>public&nbsp;void&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/ar/ArArchiveOutputStream.html#line.208">close</a>()
  387. 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></pre>
  388. <div class="block">Calls finish if necessary, and then closes the OutputStream</div>
  389. <dl>
  390. <dt><strong>Specified by:</strong></dt>
  391. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Closeable.html?is-external=true#close()" title="class or interface in java.io">close</a></code>&nbsp;in interface&nbsp;<code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</a></code></dd>
  392. <dt><strong>Specified by:</strong></dt>
  393. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/AutoCloseable.html?is-external=true#close()" title="class or interface in java.lang">close</a></code>&nbsp;in interface&nbsp;<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></code></dd>
  394. <dt><strong>Overrides:</strong></dt>
  395. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/OutputStream.html?is-external=true#close()" title="class or interface in java.io">close</a></code>&nbsp;in class&nbsp;<code><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></code></dd>
  396. <dt><span class="strong">Throws:</span></dt>
  397. <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></dd></dl>
  398. </li>
  399. </ul>
  400. <a name="createArchiveEntry(java.io.File, java.lang.String)">
  401. <!-- -->
  402. </a>
  403. <ul class="blockList">
  404. <li class="blockList">
  405. <h4>createArchiveEntry</h4>
  406. <pre>public&nbsp;<a href="../../../../../../org/apache/commons/compress/archivers/ArchiveEntry.html" title="interface in org.apache.commons.compress.archivers">ArchiveEntry</a>&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/ar/ArArchiveOutputStream.html#line.217">createArchiveEntry</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>&nbsp;inputFile,
  407. <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;entryName)
  408. 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></pre>
  409. <div class="block"><strong>Description copied from class:&nbsp;<code><a href="../../../../../../org/apache/commons/compress/archivers/ArchiveOutputStream.html#createArchiveEntry(java.io.File,%20java.lang.String)">ArchiveOutputStream</a></code></strong></div>
  410. <div class="block">Create an archive entry using the inputFile and entryName provided.</div>
  411. <dl>
  412. <dt><strong>Specified by:</strong></dt>
  413. <dd><code><a href="../../../../../../org/apache/commons/compress/archivers/ArchiveOutputStream.html#createArchiveEntry(java.io.File,%20java.lang.String)">createArchiveEntry</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../org/apache/commons/compress/archivers/ArchiveOutputStream.html" title="class in org.apache.commons.compress.archivers">ArchiveOutputStream</a></code></dd>
  414. <dt><span class="strong">Parameters:</span></dt><dd><code>inputFile</code> - the file to create the entry from</dd><dd><code>entryName</code> - name to use for the entry</dd>
  415. <dt><span class="strong">Returns:</span></dt><dd>the ArchiveEntry set up with details from the file</dd>
  416. <dt><span class="strong">Throws:</span></dt>
  417. <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 an I/O error occurs</dd></dl>
  418. </li>
  419. </ul>
  420. <a name="finish()">
  421. <!-- -->
  422. </a>
  423. <ul class="blockListLast">
  424. <li class="blockList">
  425. <h4>finish</h4>
  426. <pre>public&nbsp;void&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/ar/ArArchiveOutputStream.html#line.226">finish</a>()
  427. 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></pre>
  428. <div class="block"><strong>Description copied from class:&nbsp;<code><a href="../../../../../../org/apache/commons/compress/archivers/ArchiveOutputStream.html#finish()">ArchiveOutputStream</a></code></strong></div>
  429. <div class="block">Finishes the addition of entries to this stream, without closing it.
  430. Additional data can be written, if the format supports it.</div>
  431. <dl>
  432. <dt><strong>Specified by:</strong></dt>
  433. <dd><code><a href="../../../../../../org/apache/commons/compress/archivers/ArchiveOutputStream.html#finish()">finish</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../org/apache/commons/compress/archivers/ArchiveOutputStream.html" title="class in org.apache.commons.compress.archivers">ArchiveOutputStream</a></code></dd>
  434. <dt><span class="strong">Throws:</span></dt>
  435. <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 the user forgets to close the entry.</dd></dl>
  436. </li>
  437. </ul>
  438. </li>
  439. </ul>
  440. </li>
  441. </ul>
  442. </div>
  443. </div>
  444. <!-- ========= END OF CLASS DATA ========= -->
  445. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  446. <div class="bottomNav"><a name="navbar_bottom">
  447. <!-- -->
  448. </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
  449. <!-- -->
  450. </a>
  451. <ul class="navList" title="Navigation">
  452. <li><a href="../../../../../../overview-summary.html">Overview</a></li>
  453. <li><a href="package-summary.html">Package</a></li>
  454. <li class="navBarCell1Rev">Class</li>
  455. <li><a href="class-use/ArArchiveOutputStream.html">Use</a></li>
  456. <li><a href="package-tree.html">Tree</a></li>
  457. <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
  458. <li><a href="../../../../../../index-all.html">Index</a></li>
  459. <li><a href="../../../../../../help-doc.html">Help</a></li>
  460. </ul>
  461. </div>
  462. <div class="subNav">
  463. <ul class="navList">
  464. <li><a href="../../../../../../org/apache/commons/compress/archivers/ar/ArArchiveInputStream.html" title="class in org.apache.commons.compress.archivers.ar"><span class="strong">Prev Class</span></a></li>
  465. <li>Next Class</li>
  466. </ul>
  467. <ul class="navList">
  468. <li><a href="../../../../../../index.html?org/apache/commons/compress/archivers/ar/ArArchiveOutputStream.html" target="_top">Frames</a></li>
  469. <li><a href="ArArchiveOutputStream.html" target="_top">No Frames</a></li>
  470. </ul>
  471. <ul class="navList" id="allclasses_navbar_bottom">
  472. <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
  473. </ul>
  474. <div>
  475. <script type="text/javascript"><!--
  476. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  477. if(window==top) {
  478. allClassesLink.style.display = "block";
  479. }
  480. else {
  481. allClassesLink.style.display = "none";
  482. }
  483. //-->
  484. </script>
  485. </div>
  486. <div>
  487. <ul class="subNavList">
  488. <li>Summary:&nbsp;</li>
  489. <li>Nested&nbsp;|&nbsp;</li>
  490. <li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
  491. <li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
  492. <li><a href="#method_summary">Method</a></li>
  493. </ul>
  494. <ul class="subNavList">
  495. <li>Detail:&nbsp;</li>
  496. <li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li>
  497. <li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
  498. <li><a href="#method_detail">Method</a></li>
  499. </ul>
  500. </div>
  501. <a name="skip-navbar_bottom">
  502. <!-- -->
  503. </a></div>
  504. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  505. <p class="legalCopy"><small>Copyright &#169; 2016 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
  506. </body>
  507. </html>