TarArchiveInputStream.html 49 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791
  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>TarArchiveInputStream (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="TarArchiveInputStream (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/TarArchiveInputStream.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/tar/TarArchiveEntry.html" title="class in org.apache.commons.compress.archivers.tar"><span class="strong">Prev Class</span></a></li>
  43. <li><a href="../../../../../../org/apache/commons/compress/archivers/tar/TarArchiveOutputStream.html" title="class in org.apache.commons.compress.archivers.tar"><span class="strong">Next Class</span></a></li>
  44. </ul>
  45. <ul class="navList">
  46. <li><a href="../../../../../../index.html?org/apache/commons/compress/archivers/tar/TarArchiveInputStream.html" target="_top">Frames</a></li>
  47. <li><a href="TarArchiveInputStream.html" target="_top">No Frames</a></li>
  48. </ul>
  49. <ul class="navList" id="allclasses_navbar_top">
  50. <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
  51. </ul>
  52. <div>
  53. <script type="text/javascript"><!--
  54. allClassesLink = document.getElementById("allclasses_navbar_top");
  55. if(window==top) {
  56. allClassesLink.style.display = "block";
  57. }
  58. else {
  59. allClassesLink.style.display = "none";
  60. }
  61. //-->
  62. </script>
  63. </div>
  64. <div>
  65. <ul class="subNavList">
  66. <li>Summary:&nbsp;</li>
  67. <li>Nested&nbsp;|&nbsp;</li>
  68. <li>Field&nbsp;|&nbsp;</li>
  69. <li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
  70. <li><a href="#method_summary">Method</a></li>
  71. </ul>
  72. <ul class="subNavList">
  73. <li>Detail:&nbsp;</li>
  74. <li>Field&nbsp;|&nbsp;</li>
  75. <li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
  76. <li><a href="#method_detail">Method</a></li>
  77. </ul>
  78. </div>
  79. <a name="skip-navbar_top">
  80. <!-- -->
  81. </a></div>
  82. <!-- ========= END OF TOP NAVBAR ========= -->
  83. <!-- ======== START OF CLASS DATA ======== -->
  84. <div class="header">
  85. <div class="subTitle">org.apache.commons.compress.archivers.tar</div>
  86. <h2 title="Class TarArchiveInputStream" class="title">Class TarArchiveInputStream</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/InputStream.html?is-external=true" title="class or interface in java.io">java.io.InputStream</a></li>
  94. <li>
  95. <ul class="inheritance">
  96. <li><a href="../../../../../../org/apache/commons/compress/archivers/ArchiveInputStream.html" title="class in org.apache.commons.compress.archivers">org.apache.commons.compress.archivers.ArchiveInputStream</a></li>
  97. <li>
  98. <ul class="inheritance">
  99. <li>org.apache.commons.compress.archivers.tar.TarArchiveInputStream</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/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/tar/TarArchiveInputStream.html#line.48">TarArchiveInputStream</a>
  117. extends <a href="../../../../../../org/apache/commons/compress/archivers/ArchiveInputStream.html" title="class in org.apache.commons.compress.archivers">ArchiveInputStream</a></pre>
  118. <div class="block">The TarInputStream reads a UNIX tar archive as an InputStream.
  119. methods are provided to position at each successive entry in
  120. the archive, and the read each entry as a normal input stream
  121. using read().</div>
  122. <dl><dt><span class="strong">This class is not thread-safe</span></dt>
  123. <dd></dd></dl>
  124. </li>
  125. </ul>
  126. </div>
  127. <div class="summary">
  128. <ul class="blockList">
  129. <li class="blockList">
  130. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  131. <ul class="blockList">
  132. <li class="blockList"><a name="constructor_summary">
  133. <!-- -->
  134. </a>
  135. <h3>Constructor Summary</h3>
  136. <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  137. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  138. <tr>
  139. <th class="colOne" scope="col">Constructor and Description</th>
  140. </tr>
  141. <tr class="altColor">
  142. <td class="colOne"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/tar/TarArchiveInputStream.html#TarArchiveInputStream(java.io.InputStream)">TarArchiveInputStream</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a>&nbsp;is)</code>
  143. <div class="block">Constructor for TarInputStream.</div>
  144. </td>
  145. </tr>
  146. <tr class="rowColor">
  147. <td class="colOne"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/tar/TarArchiveInputStream.html#TarArchiveInputStream(java.io.InputStream,%20int)">TarArchiveInputStream</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a>&nbsp;is,
  148. int&nbsp;blockSize)</code>
  149. <div class="block">Constructor for TarInputStream.</div>
  150. </td>
  151. </tr>
  152. <tr class="altColor">
  153. <td class="colOne"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/tar/TarArchiveInputStream.html#TarArchiveInputStream(java.io.InputStream,%20int,%20int)">TarArchiveInputStream</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a>&nbsp;is,
  154. int&nbsp;blockSize,
  155. int&nbsp;recordSize)</code>
  156. <div class="block">Constructor for TarInputStream.</div>
  157. </td>
  158. </tr>
  159. <tr class="rowColor">
  160. <td class="colOne"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/tar/TarArchiveInputStream.html#TarArchiveInputStream(java.io.InputStream,%20int,%20int,%20java.lang.String)">TarArchiveInputStream</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a>&nbsp;is,
  161. int&nbsp;blockSize,
  162. int&nbsp;recordSize,
  163. <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>
  164. <div class="block">Constructor for TarInputStream.</div>
  165. </td>
  166. </tr>
  167. <tr class="altColor">
  168. <td class="colOne"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/tar/TarArchiveInputStream.html#TarArchiveInputStream(java.io.InputStream,%20int,%20java.lang.String)">TarArchiveInputStream</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a>&nbsp;is,
  169. int&nbsp;blockSize,
  170. <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>
  171. <div class="block">Constructor for TarInputStream.</div>
  172. </td>
  173. </tr>
  174. <tr class="rowColor">
  175. <td class="colOne"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/tar/TarArchiveInputStream.html#TarArchiveInputStream(java.io.InputStream,%20java.lang.String)">TarArchiveInputStream</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a>&nbsp;is,
  176. <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>
  177. <div class="block">Constructor for TarInputStream.</div>
  178. </td>
  179. </tr>
  180. </table>
  181. </li>
  182. </ul>
  183. <!-- ========== METHOD SUMMARY =========== -->
  184. <ul class="blockList">
  185. <li class="blockList"><a name="method_summary">
  186. <!-- -->
  187. </a>
  188. <h3>Method Summary</h3>
  189. <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  190. <caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
  191. <tr>
  192. <th class="colFirst" scope="col">Modifier and Type</th>
  193. <th class="colLast" scope="col">Method and Description</th>
  194. </tr>
  195. <tr class="altColor">
  196. <td class="colFirst"><code>int</code></td>
  197. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/tar/TarArchiveInputStream.html#available()">available</a></strong>()</code>
  198. <div class="block">Get the available data that can be read from the current
  199. entry in the archive.</div>
  200. </td>
  201. </tr>
  202. <tr class="rowColor">
  203. <td class="colFirst"><code>boolean</code></td>
  204. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/tar/TarArchiveInputStream.html#canReadEntryData(org.apache.commons.compress.archivers.ArchiveEntry)">canReadEntryData</a></strong>(<a href="../../../../../../org/apache/commons/compress/archivers/ArchiveEntry.html" title="interface in org.apache.commons.compress.archivers">ArchiveEntry</a>&nbsp;ae)</code>
  205. <div class="block">Whether this class is able to read the given entry.</div>
  206. </td>
  207. </tr>
  208. <tr class="altColor">
  209. <td class="colFirst"><code>void</code></td>
  210. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/tar/TarArchiveInputStream.html#close()">close</a></strong>()</code>
  211. <div class="block">Closes this stream.</div>
  212. </td>
  213. </tr>
  214. <tr class="rowColor">
  215. <td class="colFirst"><code><a href="../../../../../../org/apache/commons/compress/archivers/tar/TarArchiveEntry.html" title="class in org.apache.commons.compress.archivers.tar">TarArchiveEntry</a></code></td>
  216. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/tar/TarArchiveInputStream.html#getCurrentEntry()">getCurrentEntry</a></strong>()</code>
  217. <div class="block">Get the current TAR Archive Entry that this input stream is processing</div>
  218. </td>
  219. </tr>
  220. <tr class="altColor">
  221. <td class="colFirst"><code>protected byte[]</code></td>
  222. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/tar/TarArchiveInputStream.html#getLongNameData()">getLongNameData</a></strong>()</code>
  223. <div class="block">Get the next entry in this tar archive as longname data.</div>
  224. </td>
  225. </tr>
  226. <tr class="rowColor">
  227. <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>
  228. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/tar/TarArchiveInputStream.html#getNextEntry()">getNextEntry</a></strong>()</code>
  229. <div class="block">Returns the next Archive Entry in this Stream.</div>
  230. </td>
  231. </tr>
  232. <tr class="altColor">
  233. <td class="colFirst"><code><a href="../../../../../../org/apache/commons/compress/archivers/tar/TarArchiveEntry.html" title="class in org.apache.commons.compress.archivers.tar">TarArchiveEntry</a></code></td>
  234. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/tar/TarArchiveInputStream.html#getNextTarEntry()">getNextTarEntry</a></strong>()</code>
  235. <div class="block">Get the next entry in this tar archive.</div>
  236. </td>
  237. </tr>
  238. <tr class="rowColor">
  239. <td class="colFirst"><code>int</code></td>
  240. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/tar/TarArchiveInputStream.html#getRecordSize()">getRecordSize</a></strong>()</code>
  241. <div class="block">Get the record size being used by this stream's buffer.</div>
  242. </td>
  243. </tr>
  244. <tr class="altColor">
  245. <td class="colFirst"><code>protected boolean</code></td>
  246. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/tar/TarArchiveInputStream.html#isAtEOF()">isAtEOF</a></strong>()</code>&nbsp;</td>
  247. </tr>
  248. <tr class="rowColor">
  249. <td class="colFirst"><code>protected boolean</code></td>
  250. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/tar/TarArchiveInputStream.html#isEOFRecord(byte[])">isEOFRecord</a></strong>(byte[]&nbsp;record)</code>
  251. <div class="block">Determine if an archive record indicate End of Archive.</div>
  252. </td>
  253. </tr>
  254. <tr class="altColor">
  255. <td class="colFirst"><code>void</code></td>
  256. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/tar/TarArchiveInputStream.html#mark(int)">mark</a></strong>(int&nbsp;markLimit)</code>
  257. <div class="block">Since we do not support marking just yet, we do nothing.</div>
  258. </td>
  259. </tr>
  260. <tr class="rowColor">
  261. <td class="colFirst"><code>boolean</code></td>
  262. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/tar/TarArchiveInputStream.html#markSupported()">markSupported</a></strong>()</code>
  263. <div class="block">Since we do not support marking just yet, we return false.</div>
  264. </td>
  265. </tr>
  266. <tr class="altColor">
  267. <td class="colFirst"><code>static boolean</code></td>
  268. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/tar/TarArchiveInputStream.html#matches(byte[],%20int)">matches</a></strong>(byte[]&nbsp;signature,
  269. int&nbsp;length)</code>
  270. <div class="block">Checks if the signature matches what is expected for a tar file.</div>
  271. </td>
  272. </tr>
  273. <tr class="rowColor">
  274. <td class="colFirst"><code>int</code></td>
  275. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/tar/TarArchiveInputStream.html#read(byte[],%20int,%20int)">read</a></strong>(byte[]&nbsp;buf,
  276. int&nbsp;offset,
  277. int&nbsp;numToRead)</code>
  278. <div class="block">Reads bytes from the current tar archive entry.</div>
  279. </td>
  280. </tr>
  281. <tr class="altColor">
  282. <td class="colFirst"><code>protected byte[]</code></td>
  283. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/tar/TarArchiveInputStream.html#readRecord()">readRecord</a></strong>()</code>
  284. <div class="block">Read a record from the input stream and return the data.</div>
  285. </td>
  286. </tr>
  287. <tr class="rowColor">
  288. <td class="colFirst"><code>void</code></td>
  289. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/tar/TarArchiveInputStream.html#reset()">reset</a></strong>()</code>
  290. <div class="block">Since we do not support marking just yet, we do nothing.</div>
  291. </td>
  292. </tr>
  293. <tr class="altColor">
  294. <td class="colFirst"><code>protected void</code></td>
  295. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/tar/TarArchiveInputStream.html#setAtEOF(boolean)">setAtEOF</a></strong>(boolean&nbsp;b)</code>&nbsp;</td>
  296. </tr>
  297. <tr class="rowColor">
  298. <td class="colFirst"><code>protected void</code></td>
  299. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/tar/TarArchiveInputStream.html#setCurrentEntry(org.apache.commons.compress.archivers.tar.TarArchiveEntry)">setCurrentEntry</a></strong>(<a href="../../../../../../org/apache/commons/compress/archivers/tar/TarArchiveEntry.html" title="class in org.apache.commons.compress.archivers.tar">TarArchiveEntry</a>&nbsp;e)</code>&nbsp;</td>
  300. </tr>
  301. <tr class="altColor">
  302. <td class="colFirst"><code>long</code></td>
  303. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/tar/TarArchiveInputStream.html#skip(long)">skip</a></strong>(long&nbsp;n)</code>
  304. <div class="block">Skips over and discards <code>n</code> bytes of data from this input
  305. stream.</div>
  306. </td>
  307. </tr>
  308. </table>
  309. <ul class="blockList">
  310. <li class="blockList"><a name="methods_inherited_from_class_org.apache.commons.compress.archivers.ArchiveInputStream">
  311. <!-- -->
  312. </a>
  313. <h3>Methods inherited from class&nbsp;org.apache.commons.compress.archivers.<a href="../../../../../../org/apache/commons/compress/archivers/ArchiveInputStream.html" title="class in org.apache.commons.compress.archivers">ArchiveInputStream</a></h3>
  314. <code><a href="../../../../../../org/apache/commons/compress/archivers/ArchiveInputStream.html#count(int)">count</a>, <a href="../../../../../../org/apache/commons/compress/archivers/ArchiveInputStream.html#count(long)">count</a>, <a href="../../../../../../org/apache/commons/compress/archivers/ArchiveInputStream.html#getBytesRead()">getBytesRead</a>, <a href="../../../../../../org/apache/commons/compress/archivers/ArchiveInputStream.html#getCount()">getCount</a>, <a href="../../../../../../org/apache/commons/compress/archivers/ArchiveInputStream.html#pushedBackBytes(long)">pushedBackBytes</a>, <a href="../../../../../../org/apache/commons/compress/archivers/ArchiveInputStream.html#read()">read</a></code></li>
  315. </ul>
  316. <ul class="blockList">
  317. <li class="blockList"><a name="methods_inherited_from_class_java.io.InputStream">
  318. <!-- -->
  319. </a>
  320. <h3>Methods inherited from class&nbsp;java.io.<a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a></h3>
  321. <code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true#read(byte[])" title="class or interface in java.io">read</a></code></li>
  322. </ul>
  323. <ul class="blockList">
  324. <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
  325. <!-- -->
  326. </a>
  327. <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>
  328. <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>
  329. </ul>
  330. </li>
  331. </ul>
  332. </li>
  333. </ul>
  334. </div>
  335. <div class="details">
  336. <ul class="blockList">
  337. <li class="blockList">
  338. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  339. <ul class="blockList">
  340. <li class="blockList"><a name="constructor_detail">
  341. <!-- -->
  342. </a>
  343. <h3>Constructor Detail</h3>
  344. <a name="TarArchiveInputStream(java.io.InputStream)">
  345. <!-- -->
  346. </a>
  347. <ul class="blockList">
  348. <li class="blockList">
  349. <h4>TarArchiveInputStream</h4>
  350. <pre>public&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/tar/TarArchiveInputStream.html#line.88">TarArchiveInputStream</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a>&nbsp;is)</pre>
  351. <div class="block">Constructor for TarInputStream.</div>
  352. <dl><dt><span class="strong">Parameters:</span></dt><dd><code>is</code> - the input stream to use</dd></dl>
  353. </li>
  354. </ul>
  355. <a name="TarArchiveInputStream(java.io.InputStream, java.lang.String)">
  356. <!-- -->
  357. </a>
  358. <ul class="blockList">
  359. <li class="blockList">
  360. <h4>TarArchiveInputStream</h4>
  361. <pre>public&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/tar/TarArchiveInputStream.html#line.98">TarArchiveInputStream</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a>&nbsp;is,
  362. <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>
  363. <div class="block">Constructor for TarInputStream.</div>
  364. <dl><dt><span class="strong">Parameters:</span></dt><dd><code>is</code> - the input 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>
  365. <dd>1.4</dd></dl>
  366. </li>
  367. </ul>
  368. <a name="TarArchiveInputStream(java.io.InputStream, int)">
  369. <!-- -->
  370. </a>
  371. <ul class="blockList">
  372. <li class="blockList">
  373. <h4>TarArchiveInputStream</h4>
  374. <pre>public&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/tar/TarArchiveInputStream.html#line.108">TarArchiveInputStream</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a>&nbsp;is,
  375. int&nbsp;blockSize)</pre>
  376. <div class="block">Constructor for TarInputStream.</div>
  377. <dl><dt><span class="strong">Parameters:</span></dt><dd><code>is</code> - the input stream to use</dd><dd><code>blockSize</code> - the block size to use</dd></dl>
  378. </li>
  379. </ul>
  380. <a name="TarArchiveInputStream(java.io.InputStream, int, java.lang.String)">
  381. <!-- -->
  382. </a>
  383. <ul class="blockList">
  384. <li class="blockList">
  385. <h4>TarArchiveInputStream</h4>
  386. <pre>public&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/tar/TarArchiveInputStream.html#line.119">TarArchiveInputStream</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a>&nbsp;is,
  387. int&nbsp;blockSize,
  388. <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>
  389. <div class="block">Constructor for TarInputStream.</div>
  390. <dl><dt><span class="strong">Parameters:</span></dt><dd><code>is</code> - the input 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>
  391. <dd>1.4</dd></dl>
  392. </li>
  393. </ul>
  394. <a name="TarArchiveInputStream(java.io.InputStream, int, int)">
  395. <!-- -->
  396. </a>
  397. <ul class="blockList">
  398. <li class="blockList">
  399. <h4>TarArchiveInputStream</h4>
  400. <pre>public&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/tar/TarArchiveInputStream.html#line.130">TarArchiveInputStream</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a>&nbsp;is,
  401. int&nbsp;blockSize,
  402. int&nbsp;recordSize)</pre>
  403. <div class="block">Constructor for TarInputStream.</div>
  404. <dl><dt><span class="strong">Parameters:</span></dt><dd><code>is</code> - the input 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>
  405. </li>
  406. </ul>
  407. <a name="TarArchiveInputStream(java.io.InputStream, int, int, java.lang.String)">
  408. <!-- -->
  409. </a>
  410. <ul class="blockListLast">
  411. <li class="blockList">
  412. <h4>TarArchiveInputStream</h4>
  413. <pre>public&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/tar/TarArchiveInputStream.html#line.142">TarArchiveInputStream</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a>&nbsp;is,
  414. int&nbsp;blockSize,
  415. int&nbsp;recordSize,
  416. <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>
  417. <div class="block">Constructor for TarInputStream.</div>
  418. <dl><dt><span class="strong">Parameters:</span></dt><dd><code>is</code> - the input 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>
  419. <dd>1.4</dd></dl>
  420. </li>
  421. </ul>
  422. </li>
  423. </ul>
  424. <!-- ============ METHOD DETAIL ========== -->
  425. <ul class="blockList">
  426. <li class="blockList"><a name="method_detail">
  427. <!-- -->
  428. </a>
  429. <h3>Method Detail</h3>
  430. <a name="close()">
  431. <!-- -->
  432. </a>
  433. <ul class="blockList">
  434. <li class="blockList">
  435. <h4>close</h4>
  436. <pre>public&nbsp;void&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/tar/TarArchiveInputStream.html#line.157">close</a>()
  437. 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>
  438. <div class="block">Closes this stream. Calls the TarBuffer's close() method.</div>
  439. <dl>
  440. <dt><strong>Specified by:</strong></dt>
  441. <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>
  442. <dt><strong>Specified by:</strong></dt>
  443. <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>
  444. <dt><strong>Overrides:</strong></dt>
  445. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.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/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a></code></dd>
  446. <dt><span class="strong">Throws:</span></dt>
  447. <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>
  448. </li>
  449. </ul>
  450. <a name="getRecordSize()">
  451. <!-- -->
  452. </a>
  453. <ul class="blockList">
  454. <li class="blockList">
  455. <h4>getRecordSize</h4>
  456. <pre>public&nbsp;int&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/tar/TarArchiveInputStream.html#line.166">getRecordSize</a>()</pre>
  457. <div class="block">Get the record size being used by this stream's buffer.</div>
  458. <dl><dt><span class="strong">Returns:</span></dt><dd>The TarBuffer record size.</dd></dl>
  459. </li>
  460. </ul>
  461. <a name="available()">
  462. <!-- -->
  463. </a>
  464. <ul class="blockList">
  465. <li class="blockList">
  466. <h4>available</h4>
  467. <pre>public&nbsp;int&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/tar/TarArchiveInputStream.html#line.183">available</a>()
  468. 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>
  469. <div class="block">Get the available data that can be read from the current
  470. entry in the archive. This does not indicate how much data
  471. is left in the entire archive, only in the current entry.
  472. This value is determined from the entry's size header field
  473. and the amount of data already read from the current entry.
  474. Integer.MAX_VALUE is returned in case more than Integer.MAX_VALUE
  475. bytes are left in the current entry in the archive.</div>
  476. <dl>
  477. <dt><strong>Overrides:</strong></dt>
  478. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true#available()" title="class or interface in java.io">available</a></code>&nbsp;in class&nbsp;<code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a></code></dd>
  479. <dt><span class="strong">Returns:</span></dt><dd>The number of available bytes for the current entry.</dd>
  480. <dt><span class="strong">Throws:</span></dt>
  481. <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> - for signature</dd></dl>
  482. </li>
  483. </ul>
  484. <a name="skip(long)">
  485. <!-- -->
  486. </a>
  487. <ul class="blockList">
  488. <li class="blockList">
  489. <h4>skip</h4>
  490. <pre>public&nbsp;long&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/tar/TarArchiveInputStream.html#line.211">skip</a>(long&nbsp;n)
  491. 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>
  492. <div class="block">Skips over and discards <code>n</code> bytes of data from this input
  493. stream. The <code>skip</code> method may, for a variety of reasons, end
  494. up skipping over some smaller number of bytes, possibly <code>0</code>.
  495. This may result from any of a number of conditions; reaching end of file
  496. or end of entry before <code>n</code> bytes have been skipped; are only
  497. two possibilities. The actual number of bytes skipped is returned. If
  498. <code>n</code> is negative, no bytes are skipped.</div>
  499. <dl>
  500. <dt><strong>Overrides:</strong></dt>
  501. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true#skip(long)" title="class or interface in java.io">skip</a></code>&nbsp;in class&nbsp;<code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a></code></dd>
  502. <dt><span class="strong">Parameters:</span></dt><dd><code>n</code> - the number of bytes to be skipped.</dd>
  503. <dt><span class="strong">Returns:</span></dt><dd>the actual number of bytes skipped.</dd>
  504. <dt><span class="strong">Throws:</span></dt>
  505. <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 some other I/O error occurs.</dd></dl>
  506. </li>
  507. </ul>
  508. <a name="markSupported()">
  509. <!-- -->
  510. </a>
  511. <ul class="blockList">
  512. <li class="blockList">
  513. <h4>markSupported</h4>
  514. <pre>public&nbsp;boolean&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/tar/TarArchiveInputStream.html#line.229">markSupported</a>()</pre>
  515. <div class="block">Since we do not support marking just yet, we return false.</div>
  516. <dl>
  517. <dt><strong>Overrides:</strong></dt>
  518. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true#markSupported()" title="class or interface in java.io">markSupported</a></code>&nbsp;in class&nbsp;<code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a></code></dd>
  519. <dt><span class="strong">Returns:</span></dt><dd>False.</dd></dl>
  520. </li>
  521. </ul>
  522. <a name="mark(int)">
  523. <!-- -->
  524. </a>
  525. <ul class="blockList">
  526. <li class="blockList">
  527. <h4>mark</h4>
  528. <pre>public&nbsp;void&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/tar/TarArchiveInputStream.html#line.239">mark</a>(int&nbsp;markLimit)</pre>
  529. <div class="block">Since we do not support marking just yet, we do nothing.</div>
  530. <dl>
  531. <dt><strong>Overrides:</strong></dt>
  532. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true#mark(int)" title="class or interface in java.io">mark</a></code>&nbsp;in class&nbsp;<code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a></code></dd>
  533. <dt><span class="strong">Parameters:</span></dt><dd><code>markLimit</code> - The limit to mark.</dd></dl>
  534. </li>
  535. </ul>
  536. <a name="reset()">
  537. <!-- -->
  538. </a>
  539. <ul class="blockList">
  540. <li class="blockList">
  541. <h4>reset</h4>
  542. <pre>public&nbsp;void&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/tar/TarArchiveInputStream.html#line.246">reset</a>()</pre>
  543. <div class="block">Since we do not support marking just yet, we do nothing.</div>
  544. <dl>
  545. <dt><strong>Overrides:</strong></dt>
  546. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true#reset()" title="class or interface in java.io">reset</a></code>&nbsp;in class&nbsp;<code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a></code></dd>
  547. </dl>
  548. </li>
  549. </ul>
  550. <a name="getNextTarEntry()">
  551. <!-- -->
  552. </a>
  553. <ul class="blockList">
  554. <li class="blockList">
  555. <h4>getNextTarEntry</h4>
  556. <pre>public&nbsp;<a href="../../../../../../org/apache/commons/compress/archivers/tar/TarArchiveEntry.html" title="class in org.apache.commons.compress.archivers.tar">TarArchiveEntry</a>&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/tar/TarArchiveInputStream.html#line.262">getNextTarEntry</a>()
  557. 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>
  558. <div class="block">Get the next entry in this tar archive. This will skip
  559. over any remaining data in the current entry, if there
  560. is one, and place the input stream at the header of the
  561. next entry, and read the header and instantiate a new
  562. TarEntry from the header bytes and return that entry.
  563. If there are no more entries in the archive, null will
  564. be returned to indicate that the end of the archive has
  565. been reached.</div>
  566. <dl><dt><span class="strong">Returns:</span></dt><dd>The next TarEntry in the archive, or null.</dd>
  567. <dt><span class="strong">Throws:</span></dt>
  568. <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>
  569. </li>
  570. </ul>
  571. <a name="getLongNameData()">
  572. <!-- -->
  573. </a>
  574. <ul class="blockList">
  575. <li class="blockList">
  576. <h4>getLongNameData</h4>
  577. <pre>protected&nbsp;byte[]&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/tar/TarArchiveInputStream.html#line.356">getLongNameData</a>()
  578. 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>
  579. <div class="block">Get the next entry in this tar archive as longname data.</div>
  580. <dl><dt><span class="strong">Returns:</span></dt><dd>The next entry in the archive as longname data, or null.</dd>
  581. <dt><span class="strong">Throws:</span></dt>
  582. <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>
  583. </li>
  584. </ul>
  585. <a name="isEOFRecord(byte[])">
  586. <!-- -->
  587. </a>
  588. <ul class="blockList">
  589. <li class="blockList">
  590. <h4>isEOFRecord</h4>
  591. <pre>protected&nbsp;boolean&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/tar/TarArchiveInputStream.html#line.415">isEOFRecord</a>(byte[]&nbsp;record)</pre>
  592. <div class="block">Determine if an archive record indicate End of Archive. End of
  593. archive is indicated by a record that consists entirely of null bytes.</div>
  594. <dl><dt><span class="strong">Parameters:</span></dt><dd><code>record</code> - The record data to check.</dd>
  595. <dt><span class="strong">Returns:</span></dt><dd>true if the record data is an End of Archive</dd></dl>
  596. </li>
  597. </ul>
  598. <a name="readRecord()">
  599. <!-- -->
  600. </a>
  601. <ul class="blockList">
  602. <li class="blockList">
  603. <h4>readRecord</h4>
  604. <pre>protected&nbsp;byte[]&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/tar/TarArchiveInputStream.html#line.425">readRecord</a>()
  605. 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>
  606. <div class="block">Read a record from the input stream and return the data.</div>
  607. <dl><dt><span class="strong">Returns:</span></dt><dd>The record data or null if EOF has been hit.</dd>
  608. <dt><span class="strong">Throws:</span></dt>
  609. <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>
  610. </li>
  611. </ul>
  612. <a name="getNextEntry()">
  613. <!-- -->
  614. </a>
  615. <ul class="blockList">
  616. <li class="blockList">
  617. <h4>getNextEntry</h4>
  618. <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/TarArchiveInputStream.html#line.599">getNextEntry</a>()
  619. 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>
  620. <div class="block">Returns the next Archive Entry in this Stream.</div>
  621. <dl>
  622. <dt><strong>Specified by:</strong></dt>
  623. <dd><code><a href="../../../../../../org/apache/commons/compress/archivers/ArchiveInputStream.html#getNextEntry()">getNextEntry</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../org/apache/commons/compress/archivers/ArchiveInputStream.html" title="class in org.apache.commons.compress.archivers">ArchiveInputStream</a></code></dd>
  624. <dt><span class="strong">Returns:</span></dt><dd>the next entry,
  625. or <code>null</code> if there are no more entries</dd>
  626. <dt><span class="strong">Throws:</span></dt>
  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> - if the next entry could not be read</dd></dl>
  628. </li>
  629. </ul>
  630. <a name="read(byte[], int, int)">
  631. <!-- -->
  632. </a>
  633. <ul class="blockList">
  634. <li class="blockList">
  635. <h4>read</h4>
  636. <pre>public&nbsp;int&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/tar/TarArchiveInputStream.html#line.643">read</a>(byte[]&nbsp;buf,
  637. int&nbsp;offset,
  638. int&nbsp;numToRead)
  639. 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>
  640. <div class="block">Reads bytes from the current tar archive entry.
  641. This method is aware of the boundaries of the current
  642. entry in the archive and will deal with them as if they
  643. were this stream's start and EOF.</div>
  644. <dl>
  645. <dt><strong>Overrides:</strong></dt>
  646. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true#read(byte[],%20int,%20int)" title="class or interface in java.io">read</a></code>&nbsp;in class&nbsp;<code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a></code></dd>
  647. <dt><span class="strong">Parameters:</span></dt><dd><code>buf</code> - The buffer into which to place bytes read.</dd><dd><code>offset</code> - The offset at which to place bytes read.</dd><dd><code>numToRead</code> - The number of bytes to read.</dd>
  648. <dt><span class="strong">Returns:</span></dt><dd>The number of bytes read, or -1 at EOF.</dd>
  649. <dt><span class="strong">Throws:</span></dt>
  650. <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>
  651. </li>
  652. </ul>
  653. <a name="canReadEntryData(org.apache.commons.compress.archivers.ArchiveEntry)">
  654. <!-- -->
  655. </a>
  656. <ul class="blockList">
  657. <li class="blockList">
  658. <h4>canReadEntryData</h4>
  659. <pre>public&nbsp;boolean&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/tar/TarArchiveInputStream.html#line.677">canReadEntryData</a>(<a href="../../../../../../org/apache/commons/compress/archivers/ArchiveEntry.html" title="interface in org.apache.commons.compress.archivers">ArchiveEntry</a>&nbsp;ae)</pre>
  660. <div class="block">Whether this class is able to read the given entry.
  661. <p>May return false if the current entry is a sparse file.</p></div>
  662. <dl>
  663. <dt><strong>Overrides:</strong></dt>
  664. <dd><code><a href="../../../../../../org/apache/commons/compress/archivers/ArchiveInputStream.html#canReadEntryData(org.apache.commons.compress.archivers.ArchiveEntry)">canReadEntryData</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../org/apache/commons/compress/archivers/ArchiveInputStream.html" title="class in org.apache.commons.compress.archivers">ArchiveInputStream</a></code></dd>
  665. <dt><span class="strong">Parameters:</span></dt><dd><code>ae</code> - the entry to test</dd>
  666. <dt><span class="strong">Returns:</span></dt><dd>This implementation always returns true.</dd></dl>
  667. </li>
  668. </ul>
  669. <a name="getCurrentEntry()">
  670. <!-- -->
  671. </a>
  672. <ul class="blockList">
  673. <li class="blockList">
  674. <h4>getCurrentEntry</h4>
  675. <pre>public&nbsp;<a href="../../../../../../org/apache/commons/compress/archivers/tar/TarArchiveEntry.html" title="class in org.apache.commons.compress.archivers.tar">TarArchiveEntry</a>&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/tar/TarArchiveInputStream.html#line.690">getCurrentEntry</a>()</pre>
  676. <div class="block">Get the current TAR Archive Entry that this input stream is processing</div>
  677. <dl><dt><span class="strong">Returns:</span></dt><dd>The current Archive Entry</dd></dl>
  678. </li>
  679. </ul>
  680. <a name="setCurrentEntry(org.apache.commons.compress.archivers.tar.TarArchiveEntry)">
  681. <!-- -->
  682. </a>
  683. <ul class="blockList">
  684. <li class="blockList">
  685. <h4>setCurrentEntry</h4>
  686. <pre>protected final&nbsp;void&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/tar/TarArchiveInputStream.html#line.694">setCurrentEntry</a>(<a href="../../../../../../org/apache/commons/compress/archivers/tar/TarArchiveEntry.html" title="class in org.apache.commons.compress.archivers.tar">TarArchiveEntry</a>&nbsp;e)</pre>
  687. </li>
  688. </ul>
  689. <a name="isAtEOF()">
  690. <!-- -->
  691. </a>
  692. <ul class="blockList">
  693. <li class="blockList">
  694. <h4>isAtEOF</h4>
  695. <pre>protected final&nbsp;boolean&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/tar/TarArchiveInputStream.html#line.698">isAtEOF</a>()</pre>
  696. </li>
  697. </ul>
  698. <a name="setAtEOF(boolean)">
  699. <!-- -->
  700. </a>
  701. <ul class="blockList">
  702. <li class="blockList">
  703. <h4>setAtEOF</h4>
  704. <pre>protected final&nbsp;void&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/tar/TarArchiveInputStream.html#line.702">setAtEOF</a>(boolean&nbsp;b)</pre>
  705. </li>
  706. </ul>
  707. <a name="matches(byte[], int)">
  708. <!-- -->
  709. </a>
  710. <ul class="blockListLast">
  711. <li class="blockList">
  712. <h4>matches</h4>
  713. <pre>public static&nbsp;boolean&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/tar/TarArchiveInputStream.html#line.728">matches</a>(byte[]&nbsp;signature,
  714. int&nbsp;length)</pre>
  715. <div class="block">Checks if the signature matches what is expected for a tar file.</div>
  716. <dl><dt><span class="strong">Parameters:</span></dt><dd><code>signature</code> - the bytes to check</dd><dd><code>length</code> - the number of bytes to check</dd>
  717. <dt><span class="strong">Returns:</span></dt><dd>true, if this stream is a tar archive stream, false otherwise</dd></dl>
  718. </li>
  719. </ul>
  720. </li>
  721. </ul>
  722. </li>
  723. </ul>
  724. </div>
  725. </div>
  726. <!-- ========= END OF CLASS DATA ========= -->
  727. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  728. <div class="bottomNav"><a name="navbar_bottom">
  729. <!-- -->
  730. </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
  731. <!-- -->
  732. </a>
  733. <ul class="navList" title="Navigation">
  734. <li><a href="../../../../../../overview-summary.html">Overview</a></li>
  735. <li><a href="package-summary.html">Package</a></li>
  736. <li class="navBarCell1Rev">Class</li>
  737. <li><a href="class-use/TarArchiveInputStream.html">Use</a></li>
  738. <li><a href="package-tree.html">Tree</a></li>
  739. <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
  740. <li><a href="../../../../../../index-all.html">Index</a></li>
  741. <li><a href="../../../../../../help-doc.html">Help</a></li>
  742. </ul>
  743. </div>
  744. <div class="subNav">
  745. <ul class="navList">
  746. <li><a href="../../../../../../org/apache/commons/compress/archivers/tar/TarArchiveEntry.html" title="class in org.apache.commons.compress.archivers.tar"><span class="strong">Prev Class</span></a></li>
  747. <li><a href="../../../../../../org/apache/commons/compress/archivers/tar/TarArchiveOutputStream.html" title="class in org.apache.commons.compress.archivers.tar"><span class="strong">Next Class</span></a></li>
  748. </ul>
  749. <ul class="navList">
  750. <li><a href="../../../../../../index.html?org/apache/commons/compress/archivers/tar/TarArchiveInputStream.html" target="_top">Frames</a></li>
  751. <li><a href="TarArchiveInputStream.html" target="_top">No Frames</a></li>
  752. </ul>
  753. <ul class="navList" id="allclasses_navbar_bottom">
  754. <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
  755. </ul>
  756. <div>
  757. <script type="text/javascript"><!--
  758. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  759. if(window==top) {
  760. allClassesLink.style.display = "block";
  761. }
  762. else {
  763. allClassesLink.style.display = "none";
  764. }
  765. //-->
  766. </script>
  767. </div>
  768. <div>
  769. <ul class="subNavList">
  770. <li>Summary:&nbsp;</li>
  771. <li>Nested&nbsp;|&nbsp;</li>
  772. <li>Field&nbsp;|&nbsp;</li>
  773. <li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
  774. <li><a href="#method_summary">Method</a></li>
  775. </ul>
  776. <ul class="subNavList">
  777. <li>Detail:&nbsp;</li>
  778. <li>Field&nbsp;|&nbsp;</li>
  779. <li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
  780. <li><a href="#method_detail">Method</a></li>
  781. </ul>
  782. </div>
  783. <a name="skip-navbar_bottom">
  784. <!-- -->
  785. </a></div>
  786. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  787. <p class="legalCopy"><small>Copyright &#169; 2016 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
  788. </body>
  789. </html>