Home Explore Help
Sign In
carlos.garcia
/
praktikum-holons
5
0
Fork 1
Files Issues 10 Pull Requests 0 Wiki
Tree: 255bb05616
Branches Tags
praktikum-ho...
/
jars
/
commons-compress-1.13
/
apidocs
/
org
/
apache
/
commons
/
compress
/
archivers
/
tar
/
TarArchiveOutputStream.html

TarArchiveOutputStream.html 52 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838 
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
    2. 

  2. <!-- NewPage -->
    3. 

  3. <html lang="de">
    4. 

  4. <head>
    5. 

  5. <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
    6. 

  6. <title>TarArchiveOutputStream (Apache Commons Compress 1.13 API)</title>
    7. 

  7. <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
    8. 

  8. </head>
    9. 

  9. <body>
    10. 

  10. <script type="text/javascript"><!--
    11. 

  11.     try {
    12. 

  12.         if (location.href.indexOf('is-external=true') == -1) {
    13. 

  13.             parent.document.title="TarArchiveOutputStream (Apache Commons Compress 1.13 API)";
    14. 

  14.         }
    15. 

  15.     }
    16. 

  16.     catch(err) {
    17. 

  17.     }
    18. 

  18. //-->
    19. 

  19. </script>
    20. 

  20. <noscript>
    21. 

  21. <div>JavaScript is disabled on your browser.</div>
    22. 

  22. </noscript>
    23. 

  23. <!-- ========= START OF TOP NAVBAR ======= -->
    24. 

  24. <div class="topNav"><a name="navbar_top">
    25. 

  25. <!--   -->
    26. 

  26. </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
    27. 

  27. <!--   -->
    28. 

  28. </a>
    29. 

  29. <ul class="navList" title="Navigation">
    30. 

  30. <li><a href="../../../../../../overview-summary.html">Overview</a></li>
    31. 

  31. <li><a href="package-summary.html">Package</a></li>
    32. 

  32. <li class="navBarCell1Rev">Class</li>
    33. 

  33. <li><a href="class-use/TarArchiveOutputStream.html">Use</a></li>
    34. 

  34. <li><a href="package-tree.html">Tree</a></li>
    35. 

  35. <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
    36. 

  36. <li><a href="../../../../../../index-all.html">Index</a></li>
    37. 

  37. <li><a href="../../../../../../help-doc.html">Help</a></li>
    38. 

  38. </ul>
    39. 

  39. </div>
    40. 

  40. <div class="subNav">
    41. 

  41. <ul class="navList">
    42. 

  42. <li><a href="../../../../../../org/apache/commons/compress/archivers/tar/TarArchiveInputStream.html" title="class in org.apache.commons.compress.archivers.tar"><span class="strong">Prev Class</span></a></li>
    43. 

  43. <li><a href="../../../../../../org/apache/commons/compress/archivers/tar/TarArchiveSparseEntry.html" title="class in org.apache.commons.compress.archivers.tar"><span class="strong">Next Class</span></a></li>
    44. 

  44. </ul>
    45. 

  45. <ul class="navList">
    46. 

  46. <li><a href="../../../../../../index.html?org/apache/commons/compress/archivers/tar/TarArchiveOutputStream.html" target="_top">Frames</a></li>
    47. 

  47. <li><a href="TarArchiveOutputStream.html" target="_top">No Frames</a></li>
    48. 

  48. </ul>
    49. 

  49. <ul class="navList" id="allclasses_navbar_top">
    50. 

  50. <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
    51. 

  51. </ul>
    52. 

  52. <div>
    53. 

  53. <script type="text/javascript"><!--
    54. 

  54.   allClassesLink = document.getElementById("allclasses_navbar_top");
    55. 

  55.   if(window==top) {
    56. 

  56.     allClassesLink.style.display = "block";
    57. 

  57.   }
    58. 

  58.   else {
    59. 

  59.     allClassesLink.style.display = "none";
    60. 

  60.   }
    61. 

  61.   //-->
    62. 

  62. </script>
    63. 

  63. </div>
    64. 

  64. <div>
    65. 

  65. <ul class="subNavList">
    66. 

  66. <li>Summary:&nbsp;</li>
    67. 

  67. <li>Nested&nbsp;|&nbsp;</li>
    68. 

  68. <li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
    69. 

  69. <li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
    70. 

  70. <li><a href="#method_summary">Method</a></li>
    71. 

  71. </ul>
    72. 

  72. <ul class="subNavList">
    73. 

  73. <li>Detail:&nbsp;</li>
    74. 

  74. <li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li>
    75. 

  75. <li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
    76. 

  76. <li><a href="#method_detail">Method</a></li>
    77. 

  77. </ul>
    78. 

  78. </div>
    79. 

  79. <a name="skip-navbar_top">
    80. 

  80. <!--   -->
    81. 

  81. </a></div>
    82. 

  82. <!-- ========= END OF TOP NAVBAR ========= -->
    83. 

  83. <!-- ======== START OF CLASS DATA ======== -->
    84. 

  84. <div class="header">
    85. 

  85. <div class="subTitle">org.apache.commons.compress.archivers.tar</div>
    86. 

  86. <h2 title="Class TarArchiveOutputStream" class="title">Class TarArchiveOutputStream</h2>
    87. 

  87. </div>
    88. 

  88. <div class="contentContainer">
    89. 

  89. <ul class="inheritance">
    90. 

  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. 

  91. <li>
    92. 

  92. <ul class="inheritance">
    93. 

  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. 

  94. <li>
    95. 

  95. <ul class="inheritance">
    96. 

  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. 

  97. <li>
    98. 

  98. <ul class="inheritance">
    99. 

  99. <li>org.apache.commons.compress.archivers.tar.TarArchiveOutputStream</li>
    100. 

  100. </ul>
    101. 

  101. </li>
    102. 

  102. </ul>
    103. 

  103. </li>
    104. 

  104. </ul>
    105. 

  105. </li>
    106. 

  106. </ul>
    107. 

  107. <div class="description">
    108. 

  108. <ul class="blockList">
    109. 

  109. <li class="blockList">
    110. 

  110. <dl>
    111. 

  111. <dt>All Implemented Interfaces:</dt>
    112. 

  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. 

  113. </dl>
    114. 

  114. <hr>
    115. 

  115. <br>
    116. 

  116. <pre>public class <a href="../../../../../../src-html/org/apache/commons/compress/archivers/tar/TarArchiveOutputStream.html#line.43">TarArchiveOutputStream</a>
    117. 

  117. extends <a href="../../../../../../org/apache/commons/compress/archivers/ArchiveOutputStream.html" title="class in org.apache.commons.compress.archivers">ArchiveOutputStream</a></pre>
    118. 

  118. <div class="block">The TarOutputStream writes a UNIX tar archive as an OutputStream.
    119. 

  119.  Methods are provided to put entries, and then write their contents
    120. 

  120.  by writing to this stream using write().</div>
    121. 

  121. <dl><dt><span class="strong">This class is not thread-safe</span></dt>
    122. 

  122.   <dd></dd></dl>
    123. 

  123. </li>
    124. 

  124. </ul>
    125. 

  125. </div>
    126. 

  126. <div class="summary">
    127. 

  127. <ul class="blockList">
    128. 

  128. <li class="blockList">
    129. 

  129. <!-- =========== FIELD SUMMARY =========== -->
    130. 

  130. <ul class="blockList">
    131. 

  131. <li class="blockList"><a name="field_summary">
    132. 

  132. <!--   -->
    133. 

  133. </a>
    134. 

  134. <h3>Field Summary</h3>
    135. 

  135. <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
    136. 

  136. <caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
    137. 

  137. <tr>
    138. 

  138. <th class="colFirst" scope="col">Modifier and Type</th>
    139. 

  139. <th class="colLast" scope="col">Field and Description</th>
    140. 

  140. </tr>
    141. 

  141. <tr class="altColor">
    142. 

  142. <td class="colFirst"><code>static int</code></td>
    143. 

  143. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/tar/TarArchiveOutputStream.html#BIGNUMBER_ERROR">BIGNUMBER_ERROR</a></strong></code>
    144. 

  144. <div class="block">Fail if a big number (e.g. size &gt; 8GiB) is required in the archive.</div>
    145. 

  145. </td>
    146. 

  146. </tr>
    147. 

  147. <tr class="rowColor">
    148. 

  148. <td class="colFirst"><code>static int</code></td>
    149. 

  149. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/tar/TarArchiveOutputStream.html#BIGNUMBER_POSIX">BIGNUMBER_POSIX</a></strong></code>
    150. 

  150. <div class="block">POSIX/PAX extensions are used to store big numbers in the archive.</div>
    151. 

  151. </td>
    152. 

  152. </tr>
    153. 

  153. <tr class="altColor">
    154. 

  154. <td class="colFirst"><code>static int</code></td>
    155. 

  155. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/tar/TarArchiveOutputStream.html#BIGNUMBER_STAR">BIGNUMBER_STAR</a></strong></code>
    156. 

  156. <div class="block">star/GNU tar/BSD tar extensions are used to store big number in the archive.</div>
    157. 

  157. </td>
    158. 

  158. </tr>
    159. 

  159. <tr class="rowColor">
    160. 

  160. <td class="colFirst"><code>static int</code></td>
    161. 

  161. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/tar/TarArchiveOutputStream.html#LONGFILE_ERROR">LONGFILE_ERROR</a></strong></code>
    162. 

  162. <div class="block">Fail if a long file name is required in the archive.</div>
    163. 

  163. </td>
    164. 

  164. </tr>
    165. 

  165. <tr class="altColor">
    166. 

  166. <td class="colFirst"><code>static int</code></td>
    167. 

  167. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/tar/TarArchiveOutputStream.html#LONGFILE_GNU">LONGFILE_GNU</a></strong></code>
    168. 

  168. <div class="block">GNU tar extensions are used to store long file names in the archive.</div>
    169. 

  169. </td>
    170. 

  170. </tr>
    171. 

  171. <tr class="rowColor">
    172. 

  172. <td class="colFirst"><code>static int</code></td>
    173. 

  173. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/tar/TarArchiveOutputStream.html#LONGFILE_POSIX">LONGFILE_POSIX</a></strong></code>
    174. 

  174. <div class="block">POSIX/PAX extensions are used to store long file names in the archive.</div>
    175. 

  175. </td>
    176. 

  176. </tr>
    177. 

  177. <tr class="altColor">
    178. 

  178. <td class="colFirst"><code>static int</code></td>
    179. 

  179. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/tar/TarArchiveOutputStream.html#LONGFILE_TRUNCATE">LONGFILE_TRUNCATE</a></strong></code>
    180. 

  180. <div class="block">Long paths will be truncated in the archive.</div>
    181. 

  181. </td>
    182. 

  182. </tr>
    183. 

  183. </table>
    184. 

  184. </li>
    185. 

  185. </ul>
    186. 

  186. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
    187. 

  187. <ul class="blockList">
    188. 

  188. <li class="blockList"><a name="constructor_summary">
    189. 

  189. <!--   -->
    190. 

  190. </a>
    191. 

  191. <h3>Constructor Summary</h3>
    192. 

  192. <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
    193. 

  193. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
    194. 

  194. <tr>
    195. 

  195. <th class="colOne" scope="col">Constructor and Description</th>
    196. 

  196. </tr>
    197. 

  197. <tr class="altColor">
    198. 

  198. <td class="colOne"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/tar/TarArchiveOutputStream.html#TarArchiveOutputStream(java.io.OutputStream)">TarArchiveOutputStream</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;os)</code>
    199. 

  199. <div class="block">Constructor for TarInputStream.</div>
    200. 

  200. </td>
    201. 

  201. </tr>
    202. 

  202. <tr class="rowColor">
    203. 

  203. <td class="colOne"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/tar/TarArchiveOutputStream.html#TarArchiveOutputStream(java.io.OutputStream,%20int)">TarArchiveOutputStream</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;os,
    204. 

  204.                                             int&nbsp;blockSize)</code>
    205. 

  205. <div class="block">Constructor for TarInputStream.</div>
    206. 

  206. </td>
    207. 

  207. </tr>
    208. 

  208. <tr class="altColor">
    209. 

  209. <td class="colOne"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/tar/TarArchiveOutputStream.html#TarArchiveOutputStream(java.io.OutputStream,%20int,%20int)">TarArchiveOutputStream</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;os,
    210. 

  210.                                             int&nbsp;blockSize,
    211. 

  211.                                             int&nbsp;recordSize)</code>
    212. 

  212. <div class="block">Constructor for TarInputStream.</div>
    213. 

  213. </td>
    214. 

  214. </tr>
    215. 

  215. <tr class="rowColor">
    216. 

  216. <td class="colOne"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/tar/TarArchiveOutputStream.html#TarArchiveOutputStream(java.io.OutputStream,%20int,%20int,%20java.lang.String)">TarArchiveOutputStream</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;os,
    217. 

  217.                                             int&nbsp;blockSize,
    218. 

  218.                                             int&nbsp;recordSize,
    219. 

  219.                                             <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>
    220. 

  220. <div class="block">Constructor for TarInputStream.</div>
    221. 

  221. </td>
    222. 

  222. </tr>
    223. 

  223. <tr class="altColor">
    224. 

  224. <td class="colOne"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/tar/TarArchiveOutputStream.html#TarArchiveOutputStream(java.io.OutputStream,%20int,%20java.lang.String)">TarArchiveOutputStream</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;os,
    225. 

  225.                                             int&nbsp;blockSize,
    226. 

  226.                                             <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>
    227. 

  227. <div class="block">Constructor for TarInputStream.</div>
    228. 

  228. </td>
    229. 

  229. </tr>
    230. 

  230. <tr class="rowColor">
    231. 

  231. <td class="colOne"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/tar/TarArchiveOutputStream.html#TarArchiveOutputStream(java.io.OutputStream,%20java.lang.String)">TarArchiveOutputStream</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;os,
    232. 

  232.                                             <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>
    233. 

  233. <div class="block">Constructor for TarInputStream.</div>
    234. 

  234. </td>
    235. 

  235. </tr>
    236. 

  236. </table>
    237. 

  237. </li>
    238. 

  238. </ul>
    239. 

  239. <!-- ========== METHOD SUMMARY =========== -->
    240. 

  240. <ul class="blockList">
    241. 

  241. <li class="blockList"><a name="method_summary">
    242. 

  242. <!--   -->
    243. 

  243. </a>
    244. 

  244. <h3>Method Summary</h3>
    245. 

  245. <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
    246. 

  246. <caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
    247. 

  247. <tr>
    248. 

  248. <th class="colFirst" scope="col">Modifier and Type</th>
    249. 

  249. <th class="colLast" scope="col">Method and Description</th>
    250. 

  250. </tr>
    251. 

  251. <tr class="altColor">
    252. 

  252. <td class="colFirst"><code>void</code></td>
    253. 

  253. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/tar/TarArchiveOutputStream.html#close()">close</a></strong>()</code>
    254. 

  254. <div class="block">Closes the underlying OutputStream.</div>
    255. 

  255. </td>
    256. 

  256. </tr>
    257. 

  257. <tr class="rowColor">
    258. 

  258. <td class="colFirst"><code>void</code></td>
    259. 

  259. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/tar/TarArchiveOutputStream.html#closeArchiveEntry()">closeArchiveEntry</a></strong>()</code>
    260. 

  260. <div class="block">Close an entry.</div>
    261. 

  261. </td>
    262. 

  262. </tr>
    263. 

  263. <tr class="altColor">
    264. 

  264. <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>
    265. 

  265. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/tar/TarArchiveOutputStream.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,
    266. 

  266.                                     <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>
    267. 

  267. <div class="block">Create an archive entry using the inputFile and entryName provided.</div>
    268. 

  268. </td>
    269. 

  269. </tr>
    270. 

  270. <tr class="rowColor">
    271. 

  271. <td class="colFirst"><code>void</code></td>
    272. 

  272. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/tar/TarArchiveOutputStream.html#finish()">finish</a></strong>()</code>
    273. 

  273. <div class="block">Ends the TAR archive without closing the underlying OutputStream.</div>
    274. 

  274. </td>
    275. 

  275. </tr>
    276. 

  276. <tr class="altColor">
    277. 

  277. <td class="colFirst"><code>void</code></td>
    278. 

  278. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/tar/TarArchiveOutputStream.html#flush()">flush</a></strong>()</code>&nbsp;</td>
    279. 

  279. </tr>
    280. 

  280. <tr class="rowColor">
    281. 

  281. <td class="colFirst"><code>long</code></td>
    282. 

  282. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/tar/TarArchiveOutputStream.html#getBytesWritten()">getBytesWritten</a></strong>()</code>
    283. 

  283. <div class="block">Returns the current number of bytes written to this stream.</div>
    284. 

  284. </td>
    285. 

  285. </tr>
    286. 

  286. <tr class="altColor">
    287. 

  287. <td class="colFirst"><code>int</code></td>
    288. 

  288. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/tar/TarArchiveOutputStream.html#getCount()">getCount</a></strong>()</code>
    289. 

  289. <div class="block"><strong>Deprecated.</strong>&nbsp;</div>
    290. 

  290. </td>
    291. 

  291. </tr>
    292. 

  292. <tr class="rowColor">
    293. 

  293. <td class="colFirst"><code>int</code></td>
    294. 

  294. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/tar/TarArchiveOutputStream.html#getRecordSize()">getRecordSize</a></strong>()</code>
    295. 

  295. <div class="block">Get the record size being used by this stream's TarBuffer.</div>
    296. 

  296. </td>
    297. 

  297. </tr>
    298. 

  298. <tr class="altColor">
    299. 

  299. <td class="colFirst"><code>void</code></td>
    300. 

  300. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/tar/TarArchiveOutputStream.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;archiveEntry)</code>
    301. 

  301. <div class="block">Put an entry on the output stream.</div>
    302. 

  302. </td>
    303. 

  303. </tr>
    304. 

  304. <tr class="rowColor">
    305. 

  305. <td class="colFirst"><code>void</code></td>
    306. 

  306. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/tar/TarArchiveOutputStream.html#setAddPaxHeadersForNonAsciiNames(boolean)">setAddPaxHeadersForNonAsciiNames</a></strong>(boolean&nbsp;b)</code>
    307. 

  307. <div class="block">Whether to add a PAX extension header for non-ASCII file names.</div>
    308. 

  308. </td>
    309. 

  309. </tr>
    310. 

  310. <tr class="altColor">
    311. 

  311. <td class="colFirst"><code>void</code></td>
    312. 

  312. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/tar/TarArchiveOutputStream.html#setBigNumberMode(int)">setBigNumberMode</a></strong>(int&nbsp;bigNumberMode)</code>
    313. 

  313. <div class="block">Set the big number mode.</div>
    314. 

  314. </td>
    315. 

  315. </tr>
    316. 

  316. <tr class="rowColor">
    317. 

  317. <td class="colFirst"><code>void</code></td>
    318. 

  318. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/tar/TarArchiveOutputStream.html#setLongFileMode(int)">setLongFileMode</a></strong>(int&nbsp;longFileMode)</code>
    319. 

  319. <div class="block">Set the long file mode.</div>
    320. 

  320. </td>
    321. 

  321. </tr>
    322. 

  322. <tr class="altColor">
    323. 

  323. <td class="colFirst"><code>void</code></td>
    324. 

  324. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/tar/TarArchiveOutputStream.html#write(byte[],%20int,%20int)">write</a></strong>(byte[]&nbsp;wBuf,
    325. 

  325.           int&nbsp;wOffset,
    326. 

  326.           int&nbsp;numToWrite)</code>
    327. 

  327. <div class="block">Writes bytes to the current tar archive entry.</div>
    328. 

  328. </td>
    329. 

  329. </tr>
    330. 

  330. </table>
    331. 

  331. <ul class="blockList">
    332. 

  332. <li class="blockList"><a name="methods_inherited_from_class_org.apache.commons.compress.archivers.ArchiveOutputStream">
    333. 

  333. <!--   -->
    334. 

  334. </a>
    335. 

  335. <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>
    336. 

  336. <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#write(int)">write</a></code></li>
    337. 

  337. </ul>
    338. 

  338. <ul class="blockList">
    339. 

  339. <li class="blockList"><a name="methods_inherited_from_class_java.io.OutputStream">
    340. 

  340. <!--   -->
    341. 

  341. </a>
    342. 

  342. <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>
    343. 

  343. <code><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>
    344. 

  344. </ul>
    345. 

  345. <ul class="blockList">
    346. 

  346. <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
    347. 

  347. <!--   -->
    348. 

  348. </a>
    349. 

  349. <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>
    350. 

  350. <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>
    351. 

  351. </ul>
    352. 

  352. </li>
    353. 

  353. </ul>
    354. 

  354. </li>
    355. 

  355. </ul>
    356. 

  356. </div>
    357. 

  357. <div class="details">
    358. 

  358. <ul class="blockList">
    359. 

  359. <li class="blockList">
    360. 

  360. <!-- ============ FIELD DETAIL =========== -->
    361. 

  361. <ul class="blockList">
    362. 

  362. <li class="blockList"><a name="field_detail">
    363. 

  363. <!--   -->
    364. 

  364. </a>
    365. 

  365. <h3>Field Detail</h3>
    366. 

  366. <a name="LONGFILE_ERROR">
    367. 

  367. <!--   -->
    368. 

  368. </a>
    369. 

  369. <ul class="blockList">
    370. 

  370. <li class="blockList">
    371. 

  371. <h4>LONGFILE_ERROR</h4>
    372. 

  372. <pre>public static final&nbsp;int <a href="../../../../../../src-html/org/apache/commons/compress/archivers/tar/TarArchiveOutputStream.html#line.45">LONGFILE_ERROR</a></pre>
    373. 

  373. <div class="block">Fail if a long file name is required in the archive.</div>
    374. 

  374. <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../constant-values.html#org.apache.commons.compress.archivers.tar.TarArchiveOutputStream.LONGFILE_ERROR">Constant Field Values</a></dd></dl>
    375. 

  375. </li>
    376. 

  376. </ul>
    377. 

  377. <a name="LONGFILE_TRUNCATE">
    378. 

  378. <!--   -->
    379. 

  379. </a>
    380. 

  380. <ul class="blockList">
    381. 

  381. <li class="blockList">
    382. 

  382. <h4>LONGFILE_TRUNCATE</h4>
    383. 

  383. <pre>public static final&nbsp;int <a href="../../../../../../src-html/org/apache/commons/compress/archivers/tar/TarArchiveOutputStream.html#line.48">LONGFILE_TRUNCATE</a></pre>
    384. 

  384. <div class="block">Long paths will be truncated in the archive.</div>
    385. 

  385. <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../constant-values.html#org.apache.commons.compress.archivers.tar.TarArchiveOutputStream.LONGFILE_TRUNCATE">Constant Field Values</a></dd></dl>
    386. 

  386. </li>
    387. 

  387. </ul>
    388. 

  388. <a name="LONGFILE_GNU">
    389. 

  389. <!--   -->
    390. 

  390. </a>
    391. 

  391. <ul class="blockList">
    392. 

  392. <li class="blockList">
    393. 

  393. <h4>LONGFILE_GNU</h4>
    394. 

  394. <pre>public static final&nbsp;int <a href="../../../../../../src-html/org/apache/commons/compress/archivers/tar/TarArchiveOutputStream.html#line.51">LONGFILE_GNU</a></pre>
    395. 

  395. <div class="block">GNU tar extensions are used to store long file names in the archive.</div>
    396. 

  396. <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../constant-values.html#org.apache.commons.compress.archivers.tar.TarArchiveOutputStream.LONGFILE_GNU">Constant Field Values</a></dd></dl>
    397. 

  397. </li>
    398. 

  398. </ul>
    399. 

  399. <a name="LONGFILE_POSIX">
    400. 

  400. <!--   -->
    401. 

  401. </a>
    402. 

  402. <ul class="blockList">
    403. 

  403. <li class="blockList">
    404. 

  404. <h4>LONGFILE_POSIX</h4>
    405. 

  405. <pre>public static final&nbsp;int <a href="../../../../../../src-html/org/apache/commons/compress/archivers/tar/TarArchiveOutputStream.html#line.54">LONGFILE_POSIX</a></pre>
    406. 

  406. <div class="block">POSIX/PAX extensions are used to store long file names in the archive.</div>
    407. 

  407. <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../constant-values.html#org.apache.commons.compress.archivers.tar.TarArchiveOutputStream.LONGFILE_POSIX">Constant Field Values</a></dd></dl>
    408. 

  408. </li>
    409. 

  409. </ul>
    410. 

  410. <a name="BIGNUMBER_ERROR">
    411. 

  411. <!--   -->
    412. 

  412. </a>
    413. 

  413. <ul class="blockList">
    414. 

  414. <li class="blockList">
    415. 

  415. <h4>BIGNUMBER_ERROR</h4>
    416. 

  416. <pre>public static final&nbsp;int <a href="../../../../../../src-html/org/apache/commons/compress/archivers/tar/TarArchiveOutputStream.html#line.57">BIGNUMBER_ERROR</a></pre>
    417. 

  417. <div class="block">Fail if a big number (e.g. size &gt; 8GiB) is required in the archive.</div>
    418. 

  418. <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../constant-values.html#org.apache.commons.compress.archivers.tar.TarArchiveOutputStream.BIGNUMBER_ERROR">Constant Field Values</a></dd></dl>
    419. 

  419. </li>
    420. 

  420. </ul>
    421. 

  421. <a name="BIGNUMBER_STAR">
    422. 

  422. <!--   -->
    423. 

  423. </a>
    424. 

  424. <ul class="blockList">
    425. 

  425. <li class="blockList">
    426. 

  426. <h4>BIGNUMBER_STAR</h4>
    427. 

  427. <pre>public static final&nbsp;int <a href="../../../../../../src-html/org/apache/commons/compress/archivers/tar/TarArchiveOutputStream.html#line.60">BIGNUMBER_STAR</a></pre>
    428. 

  428. <div class="block">star/GNU tar/BSD tar extensions are used to store big number in the archive.</div>
    429. 

  429. <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../constant-values.html#org.apache.commons.compress.archivers.tar.TarArchiveOutputStream.BIGNUMBER_STAR">Constant Field Values</a></dd></dl>
    430. 

  430. </li>
    431. 

  431. </ul>
    432. 

  432. <a name="BIGNUMBER_POSIX">
    433. 

  433. <!--   -->
    434. 

  434. </a>
    435. 

  435. <ul class="blockListLast">
    436. 

  436. <li class="blockList">
    437. 

  437. <h4>BIGNUMBER_POSIX</h4>
    438. 

  438. <pre>public static final&nbsp;int <a href="../../../../../../src-html/org/apache/commons/compress/archivers/tar/TarArchiveOutputStream.html#line.63">BIGNUMBER_POSIX</a></pre>
    439. 

  439. <div class="block">POSIX/PAX extensions are used to store big numbers in the archive.</div>
    440. 

  440. <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../constant-values.html#org.apache.commons.compress.archivers.tar.TarArchiveOutputStream.BIGNUMBER_POSIX">Constant Field Values</a></dd></dl>
    441. 

  441. </li>
    442. 

  442. </ul>
    443. 

  443. </li>
    444. 

  444. </ul>
    445. 

  445. <!-- ========= CONSTRUCTOR DETAIL ======== -->
    446. 

  446. <ul class="blockList">
    447. 

  447. <li class="blockList"><a name="constructor_detail">
    448. 

  448. <!--   -->
    449. 

  449. </a>
    450. 

  450. <h3>Constructor Detail</h3>
    451. 

  451. <a name="TarArchiveOutputStream(java.io.OutputStream)">
    452. 

  452. <!--   -->
    453. 

  453. </a>
    454. 

  454. <ul class="blockList">
    455. 

  455. <li class="blockList">
    456. 

  456. <h4>TarArchiveOutputStream</h4>
    457. 

  457. <pre>public&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/tar/TarArchiveOutputStream.html#line.100">TarArchiveOutputStream</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;os)</pre>
    458. 

  458. <div class="block">Constructor for TarInputStream.</div>
    459. 

  459. <dl><dt><span class="strong">Parameters:</span></dt><dd><code>os</code> - the output stream to use</dd></dl>
    460. 

  460. </li>
    461. 

  461. </ul>
    462. 

  462. <a name="TarArchiveOutputStream(java.io.OutputStream, java.lang.String)">
    463. 

  463. <!--   -->
    464. 

  464. </a>
    465. 

  465. <ul class="blockList">
    466. 

  466. <li class="blockList">
    467. 

  467. <h4>TarArchiveOutputStream</h4>
    468. 

  468. <pre>public&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/tar/TarArchiveOutputStream.html#line.110">TarArchiveOutputStream</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;os,
    469. 

  469.                       <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>
    470. 

  470. <div class="block">Constructor for TarInputStream.</div>
    471. 

  471. <dl><dt><span class="strong">Parameters:</span></dt><dd><code>os</code> - the output stream to use</dd><dd><code>encoding</code> - name of the encoding to use for file names</dd><dt><span class="strong">Since:</span></dt>
    472. 

  472.   <dd>1.4</dd></dl>
    473. 

  473. </li>
    474. 

  474. </ul>
    475. 

  475. <a name="TarArchiveOutputStream(java.io.OutputStream, int)">
    476. 

  476. <!--   -->
    477. 

  477. </a>
    478. 

  478. <ul class="blockList">
    479. 

  479. <li class="blockList">
    480. 

  480. <h4>TarArchiveOutputStream</h4>
    481. 

  481. <pre>public&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/tar/TarArchiveOutputStream.html#line.119">TarArchiveOutputStream</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;os,
    482. 

  482.                       int&nbsp;blockSize)</pre>
    483. 

  483. <div class="block">Constructor for TarInputStream.</div>
    484. 

  484. <dl><dt><span class="strong">Parameters:</span></dt><dd><code>os</code> - the output stream to use</dd><dd><code>blockSize</code> - the block size to use</dd></dl>
    485. 

  485. </li>
    486. 

  486. </ul>
    487. 

  487. <a name="TarArchiveOutputStream(java.io.OutputStream, int, java.lang.String)">
    488. 

  488. <!--   -->
    489. 

  489. </a>
    490. 

  490. <ul class="blockList">
    491. 

  491. <li class="blockList">
    492. 

  492. <h4>TarArchiveOutputStream</h4>
    493. 

  493. <pre>public&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/tar/TarArchiveOutputStream.html#line.130">TarArchiveOutputStream</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;os,
    494. 

  494.                       int&nbsp;blockSize,
    495. 

  495.                       <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>
    496. 

  496. <div class="block">Constructor for TarInputStream.</div>
    497. 

  497. <dl><dt><span class="strong">Parameters:</span></dt><dd><code>os</code> - the output stream to use</dd><dd><code>blockSize</code> - the block size to use</dd><dd><code>encoding</code> - name of the encoding to use for file names</dd><dt><span class="strong">Since:</span></dt>
    498. 

  498.   <dd>1.4</dd></dl>
    499. 

  499. </li>
    500. 

  500. </ul>
    501. 

  501. <a name="TarArchiveOutputStream(java.io.OutputStream, int, int)">
    502. 

  502. <!--   -->
    503. 

  503. </a>
    504. 

  504. <ul class="blockList">
    505. 

  505. <li class="blockList">
    506. 

  506. <h4>TarArchiveOutputStream</h4>
    507. 

  507. <pre>public&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/tar/TarArchiveOutputStream.html#line.141">TarArchiveOutputStream</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;os,
    508. 

  508.                       int&nbsp;blockSize,
    509. 

  509.                       int&nbsp;recordSize)</pre>
    510. 

  510. <div class="block">Constructor for TarInputStream.</div>
    511. 

  511. <dl><dt><span class="strong">Parameters:</span></dt><dd><code>os</code> - the output stream to use</dd><dd><code>blockSize</code> - the block size to use</dd><dd><code>recordSize</code> - the record size to use</dd></dl>
    512. 

  512. </li>
    513. 

  513. </ul>
    514. 

  514. <a name="TarArchiveOutputStream(java.io.OutputStream, int, int, java.lang.String)">
    515. 

  515. <!--   -->
    516. 

  516. </a>
    517. 

  517. <ul class="blockListLast">
    518. 

  518. <li class="blockList">
    519. 

  519. <h4>TarArchiveOutputStream</h4>
    520. 

  520. <pre>public&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/tar/TarArchiveOutputStream.html#line.153">TarArchiveOutputStream</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;os,
    521. 

  521.                       int&nbsp;blockSize,
    522. 

  522.                       int&nbsp;recordSize,
    523. 

  523.                       <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>
    524. 

  524. <div class="block">Constructor for TarInputStream.</div>
    525. 

  525. <dl><dt><span class="strong">Parameters:</span></dt><dd><code>os</code> - the output stream to use</dd><dd><code>blockSize</code> - the block size to use</dd><dd><code>recordSize</code> - the record size to use</dd><dd><code>encoding</code> - name of the encoding to use for file names</dd><dt><span class="strong">Since:</span></dt>
    526. 

  526.   <dd>1.4</dd></dl>
    527. 

  527. </li>
    528. 

  528. </ul>
    529. 

  529. </li>
    530. 

  530. </ul>
    531. 

  531. <!-- ============ METHOD DETAIL ========== -->
    532. 

  532. <ul class="blockList">
    533. 

  533. <li class="blockList"><a name="method_detail">
    534. 

  534. <!--   -->
    535. 

  535. </a>
    536. 

  536. <h3>Method Detail</h3>
    537. 

  537. <a name="setLongFileMode(int)">
    538. 

  538. <!--   -->
    539. 

  539. </a>
    540. 

  540. <ul class="blockList">
    541. 

  541. <li class="blockList">
    542. 

  542. <h4>setLongFileMode</h4>
    543. 

  543. <pre>public&nbsp;void&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/tar/TarArchiveOutputStream.html#line.173">setLongFileMode</a>(int&nbsp;longFileMode)</pre>
    544. 

  544. <div class="block">Set the long file mode.
    545. 

  545.  This can be LONGFILE_ERROR(0), LONGFILE_TRUNCATE(1) or LONGFILE_GNU(2).
    546. 

  546.  This specifies the treatment of long file names (names &gt;= TarConstants.NAMELEN).
    547. 

  547.  Default is LONGFILE_ERROR.</div>
    548. 

  548. <dl><dt><span class="strong">Parameters:</span></dt><dd><code>longFileMode</code> - the mode to use</dd></dl>
    549. 

  549. </li>
    550. 

  550. </ul>
    551. 

  551. <a name="setBigNumberMode(int)">
    552. 

  552. <!--   -->
    553. 

  553. </a>
    554. 

  554. <ul class="blockList">
    555. 

  555. <li class="blockList">
    556. 

  556. <h4>setBigNumberMode</h4>
    557. 

  557. <pre>public&nbsp;void&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/tar/TarArchiveOutputStream.html#line.185">setBigNumberMode</a>(int&nbsp;bigNumberMode)</pre>
    558. 

  558. <div class="block">Set the big number mode.
    559. 

  559.  This can be BIGNUMBER_ERROR(0), BIGNUMBER_POSIX(1) or BIGNUMBER_STAR(2).
    560. 

  560.  This specifies the treatment of big files (sizes &gt; TarConstants.MAXSIZE) and other numeric values to big to fit into a traditional tar header.
    561. 

  561.  Default is BIGNUMBER_ERROR.</div>
    562. 

  562. <dl><dt><span class="strong">Parameters:</span></dt><dd><code>bigNumberMode</code> - the mode to use</dd><dt><span class="strong">Since:</span></dt>
    563. 

  563.   <dd>1.4</dd></dl>
    564. 

  564. </li>
    565. 

  565. </ul>
    566. 

  566. <a name="setAddPaxHeadersForNonAsciiNames(boolean)">
    567. 

  567. <!--   -->
    568. 

  568. </a>
    569. 

  569. <ul class="blockList">
    570. 

  570. <li class="blockList">
    571. 

  571. <h4>setAddPaxHeadersForNonAsciiNames</h4>
    572. 

  572. <pre>public&nbsp;void&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/tar/TarArchiveOutputStream.html#line.194">setAddPaxHeadersForNonAsciiNames</a>(boolean&nbsp;b)</pre>
    573. 

  573. <div class="block">Whether to add a PAX extension header for non-ASCII file names.</div>
    574. 

  574. <dl><dt><span class="strong">Parameters:</span></dt><dd><code>b</code> - whether to add a PAX extension header for non-ASCII file names.</dd><dt><span class="strong">Since:</span></dt>
    575. 

  575.   <dd>1.4</dd></dl>
    576. 

  576. </li>
    577. 

  577. </ul>
    578. 

  578. <a name="getCount()">
    579. 

  579. <!--   -->
    580. 

  580. </a>
    581. 

  581. <ul class="blockList">
    582. 

  582. <li class="blockList">
    583. 

  583. <h4>getCount</h4>
    584. 

  584. <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>
    585. 

  585. public&nbsp;int&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/tar/TarArchiveOutputStream.html#line.200">getCount</a>()</pre>
    586. 

  586. <div class="block"><span class="strong">Deprecated.</span>&nbsp;</div>
    587. 

  587. <div class="block"><strong>Description copied from class:&nbsp;<code><a href="../../../../../../org/apache/commons/compress/archivers/ArchiveOutputStream.html#getCount()">ArchiveOutputStream</a></code></strong></div>
    588. 

  588. <div class="block">Returns the current number of bytes written to this stream.</div>
    589. 

  589. <dl>
    590. 

  590. <dt><strong>Overrides:</strong></dt>
    591. 

  591. <dd><code><a href="../../../../../../org/apache/commons/compress/archivers/ArchiveOutputStream.html#getCount()">getCount</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>
    592. 

  592. <dt><span class="strong">Returns:</span></dt><dd>the number of written bytes</dd></dl>
    593. 

  593. </li>
    594. 

  594. </ul>
    595. 

  595. <a name="getBytesWritten()">
    596. 

  596. <!--   -->
    597. 

  597. </a>
    598. 

  598. <ul class="blockList">
    599. 

  599. <li class="blockList">
    600. 

  600. <h4>getBytesWritten</h4>
    601. 

  601. <pre>public&nbsp;long&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/tar/TarArchiveOutputStream.html#line.205">getBytesWritten</a>()</pre>
    602. 

  602. <div class="block"><strong>Description copied from class:&nbsp;<code><a href="../../../../../../org/apache/commons/compress/archivers/ArchiveOutputStream.html#getBytesWritten()">ArchiveOutputStream</a></code></strong></div>
    603. 

  603. <div class="block">Returns the current number of bytes written to this stream.</div>
    604. 

  604. <dl>
    605. 

  605. <dt><strong>Overrides:</strong></dt>
    606. 

  606. <dd><code><a href="../../../../../../org/apache/commons/compress/archivers/ArchiveOutputStream.html#getBytesWritten()">getBytesWritten</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>
    607. 

  607. <dt><span class="strong">Returns:</span></dt><dd>the number of written bytes</dd></dl>
    608. 

  608. </li>
    609. 

  609. </ul>
    610. 

  610. <a name="finish()">
    611. 

  611. <!--   -->
    612. 

  612. </a>
    613. 

  613. <ul class="blockList">
    614. 

  614. <li class="blockList">
    615. 

  615. <h4>finish</h4>
    616. 

  616. <pre>public&nbsp;void&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/tar/TarArchiveOutputStream.html#line.219">finish</a>()
    617. 

  617.             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>
    618. 

  618. <div class="block">Ends the TAR archive without closing the underlying OutputStream.
    619. 

  619.  
    620. 

  620.  An archive consists of a series of file entries terminated by an
    621. 

  621.  end-of-archive entry, which consists of two 512 blocks of zero bytes. 
    622. 

  622.  POSIX.1 requires two EOF records, like some other implementations.</div>
    623. 

  623. <dl>
    624. 

  624. <dt><strong>Specified by:</strong></dt>
    625. 

  625. <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>
    626. 

  626. <dt><span class="strong">Throws:</span></dt>
    627. 

  627. <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> - on error</dd></dl>
    628. 

  628. </li>
    629. 

  629. </ul>
    630. 

  630. <a name="close()">
    631. 

  631. <!--   -->
    632. 

  632. </a>
    633. 

  633. <ul class="blockList">
    634. 

  634. <li class="blockList">
    635. 

  635. <h4>close</h4>
    636. 

  636. <pre>public&nbsp;void&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/tar/TarArchiveOutputStream.html#line.239">close</a>()
    637. 

  637.            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>
    638. 

  638. <div class="block">Closes the underlying OutputStream.</div>
    639. 

  639. <dl>
    640. 

  640. <dt><strong>Specified by:</strong></dt>
    641. 

  641. <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>
    642. 

  642. <dt><strong>Specified by:</strong></dt>
    643. 

  643. <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>
    644. 

  644. <dt><strong>Overrides:</strong></dt>
    645. 

  645. <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>
    646. 

  646. <dt><span class="strong">Throws:</span></dt>
    647. 

  647. <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> - on error</dd></dl>
    648. 

  648. </li>
    649. 

  649. </ul>
    650. 

  650. <a name="getRecordSize()">
    651. 

  651. <!--   -->
    652. 

  652. </a>
    653. 

  653. <ul class="blockList">
    654. 

  654. <li class="blockList">
    655. 

  655. <h4>getRecordSize</h4>
    656. 

  656. <pre>public&nbsp;int&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/tar/TarArchiveOutputStream.html#line.255">getRecordSize</a>()</pre>
    657. 

  657. <div class="block">Get the record size being used by this stream's TarBuffer.</div>
    658. 

  658. <dl><dt><span class="strong">Returns:</span></dt><dd>The TarBuffer record size.</dd></dl>
    659. 

  659. </li>
    660. 

  660. </ul>
    661. 

  661. <a name="putArchiveEntry(org.apache.commons.compress.archivers.ArchiveEntry)">
    662. 

  662. <!--   -->
    663. 

  663. </a>
    664. 

  664. <ul class="blockList">
    665. 

  665. <li class="blockList">
    666. 

  666. <h4>putArchiveEntry</h4>
    667. 

  667. <pre>public&nbsp;void&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/tar/TarArchiveOutputStream.html#line.273">putArchiveEntry</a>(<a href="../../../../../../org/apache/commons/compress/archivers/ArchiveEntry.html" title="interface in org.apache.commons.compress.archivers">ArchiveEntry</a>&nbsp;archiveEntry)
    668. 

  668.                      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>
    669. 

  669. <div class="block">Put an entry on the output stream. This writes the entry's
    670. 

  670.  header record and positions the output stream for writing
    671. 

  671.  the contents of the entry. Once this method is called, the
    672. 

  672.  stream is ready for calls to write() to write the entry's
    673. 

  673.  contents. Once the contents are written, closeArchiveEntry()
    674. 

  674.  <B>MUST</B> be called to ensure that all buffered data
    675. 

  675.  is completely written to the output stream.</div>
    676. 

  676. <dl>
    677. 

  677. <dt><strong>Specified by:</strong></dt>
    678. 

  678. <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>
    679. 

  679. <dt><span class="strong">Parameters:</span></dt><dd><code>archiveEntry</code> - The TarEntry to be written to the archive.</dd>
    680. 

  680. <dt><span class="strong">Throws:</span></dt>
    681. 

  681. <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> - on error</dd>
    682. 

  682. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/ClassCastException.html?is-external=true" title="class or interface in java.lang">ClassCastException</a></code> - if archiveEntry is not an instance of TarArchiveEntry</dd></dl>
    683. 

  683. </li>
    684. 

  684. </ul>
    685. 

  685. <a name="closeArchiveEntry()">
    686. 

  686. <!--   -->
    687. 

  687. </a>
    688. 

  688. <ul class="blockList">
    689. 

  689. <li class="blockList">
    690. 

  690. <h4>closeArchiveEntry</h4>
    691. 

  691. <pre>public&nbsp;void&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/tar/TarArchiveOutputStream.html#line.335">closeArchiveEntry</a>()
    692. 

  692.                        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>
    693. 

  693. <div class="block">Close an entry. This method MUST be called for all file
    694. 

  694.  entries that contain data. The reason is that we must
    695. 

  695.  buffer data written to the stream in order to satisfy
    696. 

  696.  the buffer's record based writes. Thus, there may be
    697. 

  697.  data fragments still being assembled that must be written
    698. 

  698.  to the output stream before this entry is closed and the
    699. 

  699.  next entry written.</div>
    700. 

  700. <dl>
    701. 

  701. <dt><strong>Specified by:</strong></dt>
    702. 

  702. <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>
    703. 

  703. <dt><span class="strong">Throws:</span></dt>
    704. 

  704. <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> - on error</dd></dl>
    705. 

  705. </li>
    706. 

  706. </ul>
    707. 

  707. <a name="write(byte[], int, int)">
    708. 

  708. <!--   -->
    709. 

  709. </a>
    710. 

  710. <ul class="blockList">
    711. 

  711. <li class="blockList">
    712. 

  712. <h4>write</h4>
    713. 

  713. <pre>public&nbsp;void&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/tar/TarArchiveOutputStream.html#line.377">write</a>(byte[]&nbsp;wBuf,
    714. 

  714.          int&nbsp;wOffset,
    715. 

  715.          int&nbsp;numToWrite)
    716. 

  716.            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>
    717. 

  717. <div class="block">Writes bytes to the current tar archive entry. This method
    718. 

  718.  is aware of the current entry and will throw an exception if
    719. 

  719.  you attempt to write bytes past the length specified for the
    720. 

  720.  current entry. The method is also (painfully) aware of the
    721. 

  721.  record buffering required by TarBuffer, and manages buffers
    722. 

  722.  that are not a multiple of recordsize in length, including
    723. 

  723.  assembling records from small buffers.</div>
    724. 

  724. <dl>
    725. 

  725. <dt><strong>Overrides:</strong></dt>
    726. 

  726. <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>
    727. 

  727. <dt><span class="strong">Parameters:</span></dt><dd><code>wBuf</code> - The buffer to write to the archive.</dd><dd><code>wOffset</code> - The offset in the buffer from which to get bytes.</dd><dd><code>numToWrite</code> - The number of bytes to write.</dd>
    728. 

  728. <dt><span class="strong">Throws:</span></dt>
    729. 

  729. <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> - on error</dd></dl>
    730. 

  730. </li>
    731. 

  731. </ul>
    732. 

  732. <a name="flush()">
    733. 

  733. <!--   -->
    734. 

  734. </a>
    735. 

  735. <ul class="blockList">
    736. 

  736. <li class="blockList">
    737. 

  737. <h4>flush</h4>
    738. 

  738. <pre>public&nbsp;void&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/tar/TarArchiveOutputStream.html#line.522">flush</a>()
    739. 

  739.            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>
    740. 

  740. <dl>
    741. 

  741. <dt><strong>Specified by:</strong></dt>
    742. 

  742. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Flushable.html?is-external=true#flush()" title="class or interface in java.io">flush</a></code>&nbsp;in interface&nbsp;<code><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></code></dd>
    743. 

  743. <dt><strong>Overrides:</strong></dt>
    744. 

  744. <dd><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></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>
    745. 

  745. <dt><span class="strong">Throws:</span></dt>
    746. 

  746. <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>
    747. 

  747. </li>
    748. 

  748. </ul>
    749. 

  749. <a name="createArchiveEntry(java.io.File, java.lang.String)">
    750. 

  750. <!--   -->
    751. 

  751. </a>
    752. 

  752. <ul class="blockListLast">
    753. 

  753. <li class="blockList">
    754. 

  754. <h4>createArchiveEntry</h4>
    755. 

  755. <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/tar/TarArchiveOutputStream.html#line.527">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,
    756. 

  756.                               <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)
    757. 

  757.                                 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>
    758. 

  758. <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>
    759. 

  759. <div class="block">Create an archive entry using the inputFile and entryName provided.</div>
    760. 

  760. <dl>
    761. 

  761. <dt><strong>Specified by:</strong></dt>
    762. 

  762. <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>
    763. 

  763. <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>
    764. 

  764. <dt><span class="strong">Returns:</span></dt><dd>the ArchiveEntry set up with details from the file</dd>
    765. 

  765. <dt><span class="strong">Throws:</span></dt>
    766. 

  766. <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>
    767. 

  767. </li>
    768. 

  768. </ul>
    769. 

  769. </li>
    770. 

  770. </ul>
    771. 

  771. </li>
    772. 

  772. </ul>
    773. 

  773. </div>
    774. 

  774. </div>
    775. 

  775. <!-- ========= END OF CLASS DATA ========= -->
    776. 

  776. <!-- ======= START OF BOTTOM NAVBAR ====== -->
    777. 

  777. <div class="bottomNav"><a name="navbar_bottom">
    778. 

  778. <!--   -->
    779. 

  779. </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
    780. 

  780. <!--   -->
    781. 

  781. </a>
    782. 

  782. <ul class="navList" title="Navigation">
    783. 

  783. <li><a href="../../../../../../overview-summary.html">Overview</a></li>
    784. 

  784. <li><a href="package-summary.html">Package</a></li>
    785. 

  785. <li class="navBarCell1Rev">Class</li>
    786. 

  786. <li><a href="class-use/TarArchiveOutputStream.html">Use</a></li>
    787. 

  787. <li><a href="package-tree.html">Tree</a></li>
    788. 

  788. <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
    789. 

  789. <li><a href="../../../../../../index-all.html">Index</a></li>
    790. 

  790. <li><a href="../../../../../../help-doc.html">Help</a></li>
    791. 

  791. </ul>
    792. 

  792. </div>
    793. 

  793. <div class="subNav">
    794. 

  794. <ul class="navList">
    795. 

  795. <li><a href="../../../../../../org/apache/commons/compress/archivers/tar/TarArchiveInputStream.html" title="class in org.apache.commons.compress.archivers.tar"><span class="strong">Prev Class</span></a></li>
    796. 

  796. <li><a href="../../../../../../org/apache/commons/compress/archivers/tar/TarArchiveSparseEntry.html" title="class in org.apache.commons.compress.archivers.tar"><span class="strong">Next Class</span></a></li>
    797. 

  797. </ul>
    798. 

  798. <ul class="navList">
    799. 

  799. <li><a href="../../../../../../index.html?org/apache/commons/compress/archivers/tar/TarArchiveOutputStream.html" target="_top">Frames</a></li>
    800. 

  800. <li><a href="TarArchiveOutputStream.html" target="_top">No Frames</a></li>
    801. 

  801. </ul>
    802. 

  802. <ul class="navList" id="allclasses_navbar_bottom">
    803. 

  803. <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
    804. 

  804. </ul>
    805. 

  805. <div>
    806. 

  806. <script type="text/javascript"><!--
    807. 

  807.   allClassesLink = document.getElementById("allclasses_navbar_bottom");
    808. 

  808.   if(window==top) {
    809. 

  809.     allClassesLink.style.display = "block";
    810. 

  810.   }
    811. 

  811.   else {
    812. 

  812.     allClassesLink.style.display = "none";
    813. 

  813.   }
    814. 

  814.   //-->
    815. 

  815. </script>
    816. 

  816. </div>
    817. 

  817. <div>
    818. 

  818. <ul class="subNavList">
    819. 

  819. <li>Summary:&nbsp;</li>
    820. 

  820. <li>Nested&nbsp;|&nbsp;</li>
    821. 

  821. <li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
    822. 

  822. <li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
    823. 

  823. <li><a href="#method_summary">Method</a></li>
    824. 

  824. </ul>
    825. 

  825. <ul class="subNavList">
    826. 

  826. <li>Detail:&nbsp;</li>
    827. 

  827. <li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li>
    828. 

  828. <li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
    829. 

  829. <li><a href="#method_detail">Method</a></li>
    830. 

  830. </ul>
    831. 

  831. </div>
    832. 

  832. <a name="skip-navbar_bottom">
    833. 

  833. <!--   -->
    834. 

  834. </a></div>
    835. 

  835. <!-- ======== END OF BOTTOM NAVBAR ======= -->
    836. 

  836. <p class="legalCopy"><small>Copyright &#169; 2016 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
    837. 

  837. </body>
    838. 

  838. </html>
    839.