source: other-projects/trunk/gs3-release-maker/apache-ant-1.6.5/build/javadocs/org/apache/tools/tar/TarInputStream.html@ 14627

Last change on this file since 14627 was 14627, checked in by oranfry, 17 years ago

initial import of the gs3-release-maker

File size: 26.5 KB
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<!--NewPage-->
3<HTML>
4<HEAD>
5<!-- Generated by javadoc (build 1.4.2_13) on Mon Oct 01 14:33:35 NZST 2007 -->
6<TITLE>
7TarInputStream (Apache Ant API)
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.apache.tools.tar.TarInputStream class">
11
12<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
13
14<SCRIPT type="text/javascript">
15function windowTitle()
16{
17 parent.document.title="TarInputStream (Apache Ant API)";
18}
19</SCRIPT>
20
21</HEAD>
22
23<BODY BGCOLOR="white" onload="windowTitle();">
24
25
26<!-- ========= START OF TOP NAVBAR ======= -->
27<A NAME="navbar_top"><!-- --></A>
28<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
29<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
30<TR>
31<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
32<A NAME="navbar_top_firstrow"><!-- --></A>
33<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
34 <TR ALIGN="center" VALIGN="top">
35 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
36 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
37 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
38 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
39 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
40 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
42 </TR>
43</TABLE>
44</TD>
45<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
46</EM>
47</TD>
48</TR>
49
50<TR>
51<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
52&nbsp;<A HREF="../../../../org/apache/tools/tar/TarEntry.html" title="class in org.apache.tools.tar"><B>PREV CLASS</B></A>&nbsp;
53&nbsp;<A HREF="../../../../org/apache/tools/tar/TarOutputStream.html" title="class in org.apache.tools.tar"><B>NEXT CLASS</B></A></FONT></TD>
54<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
55 <A HREF="../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
56&nbsp;<A HREF="TarInputStream.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
57&nbsp;<SCRIPT type="text/javascript">
58 <!--
59 if(window==top) {
60 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
61 }
62 //-->
63</SCRIPT>
64<NOSCRIPT>
65 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
66</NOSCRIPT>
67
68</FONT></TD>
69</TR>
70<TR>
71<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
72 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
73<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
74DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
75</TR>
76</TABLE>
77<A NAME="skip-navbar_top"></A>
78<!-- ========= END OF TOP NAVBAR ========= -->
79
80<HR>
81<!-- ======== START OF CLASS DATA ======== -->
82<H2>
83<FONT SIZE="-1">
84org.apache.tools.tar</FONT>
85<BR>
86Class TarInputStream</H2>
87<PRE>
88java.lang.Object
89 <IMG SRC="../../../../resources/inherit.gif" ALT="extended by">java.io.InputStream
90 <IMG SRC="../../../../resources/inherit.gif" ALT="extended by">java.io.FilterInputStream
91 <IMG SRC="../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.tools.tar.TarInputStream</B>
92</PRE>
93<HR>
94<DL>
95<DT>public class <B>TarInputStream</B><DT>extends java.io.FilterInputStream</DL>
96
97<P>
98The TarInputStream reads a UNIX tar archive as an InputStream.
99 methods are provided to position at each successive entry in
100 the archive, and the read each entry as a normal input stream
101 using read().
102<P>
103
104<P>
105<HR>
106
107<P>
108<!-- ======== NESTED CLASS SUMMARY ======== -->
109
110
111<!-- =========== FIELD SUMMARY =========== -->
112
113<A NAME="field_summary"><!-- --></A>
114<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
115<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
116<TD COLSPAN=2><FONT SIZE="+2">
117<B>Field Summary</B></FONT></TD>
118</TR>
119<TR BGCOLOR="white" CLASS="TableRowColor">
120<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
121<CODE>protected &nbsp;<A HREF="../../../../org/apache/tools/tar/TarBuffer.html" title="class in org.apache.tools.tar">TarBuffer</A></CODE></FONT></TD>
122<TD><CODE><B><A HREF="../../../../org/apache/tools/tar/TarInputStream.html#buffer">buffer</A></B></CODE>
123
124<BR>
125&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
126</TR>
127<TR BGCOLOR="white" CLASS="TableRowColor">
128<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
129<CODE>protected &nbsp;<A HREF="../../../../org/apache/tools/tar/TarEntry.html" title="class in org.apache.tools.tar">TarEntry</A></CODE></FONT></TD>
130<TD><CODE><B><A HREF="../../../../org/apache/tools/tar/TarInputStream.html#currEntry">currEntry</A></B></CODE>
131
132<BR>
133&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
134</TR>
135<TR BGCOLOR="white" CLASS="TableRowColor">
136<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
137<CODE>protected &nbsp;boolean</CODE></FONT></TD>
138<TD><CODE><B><A HREF="../../../../org/apache/tools/tar/TarInputStream.html#debug">debug</A></B></CODE>
139
140<BR>
141&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
142</TR>
143<TR BGCOLOR="white" CLASS="TableRowColor">
144<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
145<CODE>protected &nbsp;int</CODE></FONT></TD>
146<TD><CODE><B><A HREF="../../../../org/apache/tools/tar/TarInputStream.html#entryOffset">entryOffset</A></B></CODE>
147
148<BR>
149&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
150</TR>
151<TR BGCOLOR="white" CLASS="TableRowColor">
152<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
153<CODE>protected &nbsp;int</CODE></FONT></TD>
154<TD><CODE><B><A HREF="../../../../org/apache/tools/tar/TarInputStream.html#entrySize">entrySize</A></B></CODE>
155
156<BR>
157&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
158</TR>
159<TR BGCOLOR="white" CLASS="TableRowColor">
160<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
161<CODE>protected &nbsp;boolean</CODE></FONT></TD>
162<TD><CODE><B><A HREF="../../../../org/apache/tools/tar/TarInputStream.html#hasHitEOF">hasHitEOF</A></B></CODE>
163
164<BR>
165&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
166</TR>
167<TR BGCOLOR="white" CLASS="TableRowColor">
168<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
169<CODE>protected &nbsp;byte[]</CODE></FONT></TD>
170<TD><CODE><B><A HREF="../../../../org/apache/tools/tar/TarInputStream.html#oneBuf">oneBuf</A></B></CODE>
171
172<BR>
173&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This contents of this array is not used at all in this class,
174 it is only here to avoid repreated object creation during calls
175 to the no-arg read method.</TD>
176</TR>
177<TR BGCOLOR="white" CLASS="TableRowColor">
178<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
179<CODE>protected &nbsp;byte[]</CODE></FONT></TD>
180<TD><CODE><B><A HREF="../../../../org/apache/tools/tar/TarInputStream.html#readBuf">readBuf</A></B></CODE>
181
182<BR>
183&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
184</TR>
185</TABLE>
186&nbsp;<A NAME="fields_inherited_from_class_java.io.FilterInputStream"><!-- --></A>
187<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
188<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
189<TD><B>Fields inherited from class java.io.FilterInputStream</B></TD>
190</TR>
191<TR BGCOLOR="white" CLASS="TableRowColor">
192<TD><CODE>in</CODE></TD>
193</TR>
194</TABLE>
195&nbsp;
196<!-- ======== CONSTRUCTOR SUMMARY ======== -->
197
198<A NAME="constructor_summary"><!-- --></A>
199<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
200<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
201<TD COLSPAN=2><FONT SIZE="+2">
202<B>Constructor Summary</B></FONT></TD>
203</TR>
204<TR BGCOLOR="white" CLASS="TableRowColor">
205<TD><CODE><B><A HREF="../../../../org/apache/tools/tar/TarInputStream.html#TarInputStream(java.io.InputStream)">TarInputStream</A></B>(java.io.InputStream&nbsp;is)</CODE>
206
207<BR>
208&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructor for TarInputStream.</TD>
209</TR>
210<TR BGCOLOR="white" CLASS="TableRowColor">
211<TD><CODE><B><A HREF="../../../../org/apache/tools/tar/TarInputStream.html#TarInputStream(java.io.InputStream, int)">TarInputStream</A></B>(java.io.InputStream&nbsp;is,
212 int&nbsp;blockSize)</CODE>
213
214<BR>
215&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructor for TarInputStream.</TD>
216</TR>
217<TR BGCOLOR="white" CLASS="TableRowColor">
218<TD><CODE><B><A HREF="../../../../org/apache/tools/tar/TarInputStream.html#TarInputStream(java.io.InputStream, int, int)">TarInputStream</A></B>(java.io.InputStream&nbsp;is,
219 int&nbsp;blockSize,
220 int&nbsp;recordSize)</CODE>
221
222<BR>
223&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructor for TarInputStream.</TD>
224</TR>
225</TABLE>
226&nbsp;
227<!-- ========== METHOD SUMMARY =========== -->
228
229<A NAME="method_summary"><!-- --></A>
230<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
231<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
232<TD COLSPAN=2><FONT SIZE="+2">
233<B>Method Summary</B></FONT></TD>
234</TR>
235<TR BGCOLOR="white" CLASS="TableRowColor">
236<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
237<CODE>&nbsp;int</CODE></FONT></TD>
238<TD><CODE><B><A HREF="../../../../org/apache/tools/tar/TarInputStream.html#available()">available</A></B>()</CODE>
239
240<BR>
241&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the available data that can be read from the current
242 entry in the archive.</TD>
243</TR>
244<TR BGCOLOR="white" CLASS="TableRowColor">
245<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
246<CODE>&nbsp;void</CODE></FONT></TD>
247<TD><CODE><B><A HREF="../../../../org/apache/tools/tar/TarInputStream.html#close()">close</A></B>()</CODE>
248
249<BR>
250&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Closes this stream.</TD>
251</TR>
252<TR BGCOLOR="white" CLASS="TableRowColor">
253<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
254<CODE>&nbsp;void</CODE></FONT></TD>
255<TD><CODE><B><A HREF="../../../../org/apache/tools/tar/TarInputStream.html#copyEntryContents(java.io.OutputStream)">copyEntryContents</A></B>(java.io.OutputStream&nbsp;out)</CODE>
256
257<BR>
258&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Copies the contents of the current tar archive entry directly into
259 an output stream.</TD>
260</TR>
261<TR BGCOLOR="white" CLASS="TableRowColor">
262<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
263<CODE>&nbsp;<A HREF="../../../../org/apache/tools/tar/TarEntry.html" title="class in org.apache.tools.tar">TarEntry</A></CODE></FONT></TD>
264<TD><CODE><B><A HREF="../../../../org/apache/tools/tar/TarInputStream.html#getNextEntry()">getNextEntry</A></B>()</CODE>
265
266<BR>
267&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the next entry in this tar archive.</TD>
268</TR>
269<TR BGCOLOR="white" CLASS="TableRowColor">
270<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
271<CODE>&nbsp;int</CODE></FONT></TD>
272<TD><CODE><B><A HREF="../../../../org/apache/tools/tar/TarInputStream.html#getRecordSize()">getRecordSize</A></B>()</CODE>
273
274<BR>
275&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the record size being used by this stream's TarBuffer.</TD>
276</TR>
277<TR BGCOLOR="white" CLASS="TableRowColor">
278<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
279<CODE>&nbsp;void</CODE></FONT></TD>
280<TD><CODE><B><A HREF="../../../../org/apache/tools/tar/TarInputStream.html#mark(int)">mark</A></B>(int&nbsp;markLimit)</CODE>
281
282<BR>
283&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Since we do not support marking just yet, we do nothing.</TD>
284</TR>
285<TR BGCOLOR="white" CLASS="TableRowColor">
286<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
287<CODE>&nbsp;boolean</CODE></FONT></TD>
288<TD><CODE><B><A HREF="../../../../org/apache/tools/tar/TarInputStream.html#markSupported()">markSupported</A></B>()</CODE>
289
290<BR>
291&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Since we do not support marking just yet, we return false.</TD>
292</TR>
293<TR BGCOLOR="white" CLASS="TableRowColor">
294<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
295<CODE>&nbsp;int</CODE></FONT></TD>
296<TD><CODE><B><A HREF="../../../../org/apache/tools/tar/TarInputStream.html#read()">read</A></B>()</CODE>
297
298<BR>
299&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Reads a byte from the current tar archive entry.</TD>
300</TR>
301<TR BGCOLOR="white" CLASS="TableRowColor">
302<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
303<CODE>&nbsp;int</CODE></FONT></TD>
304<TD><CODE><B><A HREF="../../../../org/apache/tools/tar/TarInputStream.html#read(byte[], int, int)">read</A></B>(byte[]&nbsp;buf,
305 int&nbsp;offset,
306 int&nbsp;numToRead)</CODE>
307
308<BR>
309&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Reads bytes from the current tar archive entry.</TD>
310</TR>
311<TR BGCOLOR="white" CLASS="TableRowColor">
312<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
313<CODE>&nbsp;void</CODE></FONT></TD>
314<TD><CODE><B><A HREF="../../../../org/apache/tools/tar/TarInputStream.html#reset()">reset</A></B>()</CODE>
315
316<BR>
317&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Since we do not support marking just yet, we do nothing.</TD>
318</TR>
319<TR BGCOLOR="white" CLASS="TableRowColor">
320<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
321<CODE>&nbsp;void</CODE></FONT></TD>
322<TD><CODE><B><A HREF="../../../../org/apache/tools/tar/TarInputStream.html#setDebug(boolean)">setDebug</A></B>(boolean&nbsp;debug)</CODE>
323
324<BR>
325&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the debugging flag.</TD>
326</TR>
327<TR BGCOLOR="white" CLASS="TableRowColor">
328<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
329<CODE>&nbsp;long</CODE></FONT></TD>
330<TD><CODE><B><A HREF="../../../../org/apache/tools/tar/TarInputStream.html#skip(long)">skip</A></B>(long&nbsp;numToSkip)</CODE>
331
332<BR>
333&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Skip bytes in the input buffer.</TD>
334</TR>
335</TABLE>
336&nbsp;<A NAME="methods_inherited_from_class_java.io.FilterInputStream"><!-- --></A>
337<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
338<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
339<TD><B>Methods inherited from class java.io.FilterInputStream</B></TD>
340</TR>
341<TR BGCOLOR="white" CLASS="TableRowColor">
342<TD><CODE>read</CODE></TD>
343</TR>
344</TABLE>
345&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
346<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
347<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
348<TD><B>Methods inherited from class java.lang.Object</B></TD>
349</TR>
350<TR BGCOLOR="white" CLASS="TableRowColor">
351<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
352</TR>
353</TABLE>
354&nbsp;
355<P>
356
357<!-- ============ FIELD DETAIL =========== -->
358
359<A NAME="field_detail"><!-- --></A>
360<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
361<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
362<TD COLSPAN=1><FONT SIZE="+2">
363<B>Field Detail</B></FONT></TD>
364</TR>
365</TABLE>
366
367<A NAME="debug"><!-- --></A><H3>
368debug</H3>
369<PRE>
370protected boolean <B>debug</B></PRE>
371<DL>
372<DL>
373</DL>
374</DL>
375<HR>
376
377<A NAME="hasHitEOF"><!-- --></A><H3>
378hasHitEOF</H3>
379<PRE>
380protected boolean <B>hasHitEOF</B></PRE>
381<DL>
382<DL>
383</DL>
384</DL>
385<HR>
386
387<A NAME="entrySize"><!-- --></A><H3>
388entrySize</H3>
389<PRE>
390protected int <B>entrySize</B></PRE>
391<DL>
392<DL>
393</DL>
394</DL>
395<HR>
396
397<A NAME="entryOffset"><!-- --></A><H3>
398entryOffset</H3>
399<PRE>
400protected int <B>entryOffset</B></PRE>
401<DL>
402<DL>
403</DL>
404</DL>
405<HR>
406
407<A NAME="readBuf"><!-- --></A><H3>
408readBuf</H3>
409<PRE>
410protected byte[] <B>readBuf</B></PRE>
411<DL>
412<DL>
413</DL>
414</DL>
415<HR>
416
417<A NAME="buffer"><!-- --></A><H3>
418buffer</H3>
419<PRE>
420protected <A HREF="../../../../org/apache/tools/tar/TarBuffer.html" title="class in org.apache.tools.tar">TarBuffer</A> <B>buffer</B></PRE>
421<DL>
422<DL>
423</DL>
424</DL>
425<HR>
426
427<A NAME="currEntry"><!-- --></A><H3>
428currEntry</H3>
429<PRE>
430protected <A HREF="../../../../org/apache/tools/tar/TarEntry.html" title="class in org.apache.tools.tar">TarEntry</A> <B>currEntry</B></PRE>
431<DL>
432<DL>
433</DL>
434</DL>
435<HR>
436
437<A NAME="oneBuf"><!-- --></A><H3>
438oneBuf</H3>
439<PRE>
440protected byte[] <B>oneBuf</B></PRE>
441<DL>
442<DD>This contents of this array is not used at all in this class,
443 it is only here to avoid repreated object creation during calls
444 to the no-arg read method.
445<P>
446<DL>
447</DL>
448</DL>
449
450<!-- ========= CONSTRUCTOR DETAIL ======== -->
451
452<A NAME="constructor_detail"><!-- --></A>
453<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
454<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
455<TD COLSPAN=1><FONT SIZE="+2">
456<B>Constructor Detail</B></FONT></TD>
457</TR>
458</TABLE>
459
460<A NAME="TarInputStream(java.io.InputStream)"><!-- --></A><H3>
461TarInputStream</H3>
462<PRE>
463public <B>TarInputStream</B>(java.io.InputStream&nbsp;is)</PRE>
464<DL>
465<DD>Constructor for TarInputStream.
466<P>
467<DT><B>Parameters:</B><DD><CODE>is</CODE> - the input stream to use</DL>
468<HR>
469
470<A NAME="TarInputStream(java.io.InputStream, int)"><!-- --></A><H3>
471TarInputStream</H3>
472<PRE>
473public <B>TarInputStream</B>(java.io.InputStream&nbsp;is,
474 int&nbsp;blockSize)</PRE>
475<DL>
476<DD>Constructor for TarInputStream.
477<P>
478<DT><B>Parameters:</B><DD><CODE>is</CODE> - the input stream to use<DD><CODE>blockSize</CODE> - the block size to use</DL>
479<HR>
480
481<A NAME="TarInputStream(java.io.InputStream, int, int)"><!-- --></A><H3>
482TarInputStream</H3>
483<PRE>
484public <B>TarInputStream</B>(java.io.InputStream&nbsp;is,
485 int&nbsp;blockSize,
486 int&nbsp;recordSize)</PRE>
487<DL>
488<DD>Constructor for TarInputStream.
489<P>
490<DT><B>Parameters:</B><DD><CODE>is</CODE> - the input stream to use<DD><CODE>blockSize</CODE> - the block size to use<DD><CODE>recordSize</CODE> - the record size to use</DL>
491
492<!-- ============ METHOD DETAIL ========== -->
493
494<A NAME="method_detail"><!-- --></A>
495<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
496<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
497<TD COLSPAN=1><FONT SIZE="+2">
498<B>Method Detail</B></FONT></TD>
499</TR>
500</TABLE>
501
502<A NAME="setDebug(boolean)"><!-- --></A><H3>
503setDebug</H3>
504<PRE>
505public void <B>setDebug</B>(boolean&nbsp;debug)</PRE>
506<DL>
507<DD>Sets the debugging flag.
508<P>
509<DD><DL>
510<DT><B>Parameters:</B><DD><CODE>debug</CODE> - True to turn on debugging.</DL>
511</DD>
512</DL>
513<HR>
514
515<A NAME="close()"><!-- --></A><H3>
516close</H3>
517<PRE>
518public void <B>close</B>()
519 throws java.io.IOException</PRE>
520<DL>
521<DD>Closes this stream. Calls the TarBuffer's close() method.
522<P>
523<DD><DL>
524
525<DT><B>Throws:</B>
526<DD><CODE>java.io.IOException</CODE> - on error</DL>
527</DD>
528</DL>
529<HR>
530
531<A NAME="getRecordSize()"><!-- --></A><H3>
532getRecordSize</H3>
533<PRE>
534public int <B>getRecordSize</B>()</PRE>
535<DL>
536<DD>Get the record size being used by this stream's TarBuffer.
537<P>
538<DD><DL>
539
540<DT><B>Returns:</B><DD>The TarBuffer record size.</DL>
541</DD>
542</DL>
543<HR>
544
545<A NAME="available()"><!-- --></A><H3>
546available</H3>
547<PRE>
548public int <B>available</B>()
549 throws java.io.IOException</PRE>
550<DL>
551<DD>Get the available data that can be read from the current
552 entry in the archive. This does not indicate how much data
553 is left in the entire archive, only in the current entry.
554 This value is determined from the entry's size header field
555 and the amount of data already read from the current entry.
556<P>
557<DD><DL>
558
559<DT><B>Returns:</B><DD>The number of available bytes for the current entry.
560<DT><B>Throws:</B>
561<DD><CODE>java.io.IOException</CODE> - for signature</DL>
562</DD>
563</DL>
564<HR>
565
566<A NAME="skip(long)"><!-- --></A><H3>
567skip</H3>
568<PRE>
569public long <B>skip</B>(long&nbsp;numToSkip)
570 throws java.io.IOException</PRE>
571<DL>
572<DD>Skip bytes in the input buffer. This skips bytes in the
573 current entry's data, not the entire archive, and will
574 stop at the end of the current entry's data if the number
575 to skip extends beyond that point.
576<P>
577<DD><DL>
578<DT><B>Parameters:</B><DD><CODE>numToSkip</CODE> - The number of bytes to skip.
579<DT><B>Returns:</B><DD>the number actually skipped
580<DT><B>Throws:</B>
581<DD><CODE>java.io.IOException</CODE> - on error</DL>
582</DD>
583</DL>
584<HR>
585
586<A NAME="markSupported()"><!-- --></A><H3>
587markSupported</H3>
588<PRE>
589public boolean <B>markSupported</B>()</PRE>
590<DL>
591<DD>Since we do not support marking just yet, we return false.
592<P>
593<DD><DL>
594
595<DT><B>Returns:</B><DD>False.</DL>
596</DD>
597</DL>
598<HR>
599
600<A NAME="mark(int)"><!-- --></A><H3>
601mark</H3>
602<PRE>
603public void <B>mark</B>(int&nbsp;markLimit)</PRE>
604<DL>
605<DD>Since we do not support marking just yet, we do nothing.
606<P>
607<DD><DL>
608<DT><B>Parameters:</B><DD><CODE>markLimit</CODE> - The limit to mark.</DL>
609</DD>
610</DL>
611<HR>
612
613<A NAME="reset()"><!-- --></A><H3>
614reset</H3>
615<PRE>
616public void <B>reset</B>()</PRE>
617<DL>
618<DD>Since we do not support marking just yet, we do nothing.
619<P>
620<DD><DL>
621</DL>
622</DD>
623</DL>
624<HR>
625
626<A NAME="getNextEntry()"><!-- --></A><H3>
627getNextEntry</H3>
628<PRE>
629public <A HREF="../../../../org/apache/tools/tar/TarEntry.html" title="class in org.apache.tools.tar">TarEntry</A> <B>getNextEntry</B>()
630 throws java.io.IOException</PRE>
631<DL>
632<DD>Get the next entry in this tar archive. This will skip
633 over any remaining data in the current entry, if there
634 is one, and place the input stream at the header of the
635 next entry, and read the header and instantiate a new
636 TarEntry from the header bytes and return that entry.
637 If there are no more entries in the archive, null will
638 be returned to indicate that the end of the archive has
639 been reached.
640<P>
641<DD><DL>
642
643<DT><B>Returns:</B><DD>The next TarEntry in the archive, or null.
644<DT><B>Throws:</B>
645<DD><CODE>java.io.IOException</CODE> - on error</DL>
646</DD>
647</DL>
648<HR>
649
650<A NAME="read()"><!-- --></A><H3>
651read</H3>
652<PRE>
653public int <B>read</B>()
654 throws java.io.IOException</PRE>
655<DL>
656<DD>Reads a byte from the current tar archive entry.
657
658 This method simply calls read( byte[], int, int ).
659<P>
660<DD><DL>
661
662<DT><B>Returns:</B><DD>The byte read, or -1 at EOF.
663<DT><B>Throws:</B>
664<DD><CODE>java.io.IOException</CODE> - on error</DL>
665</DD>
666</DL>
667<HR>
668
669<A NAME="read(byte[], int, int)"><!-- --></A><H3>
670read</H3>
671<PRE>
672public int <B>read</B>(byte[]&nbsp;buf,
673 int&nbsp;offset,
674 int&nbsp;numToRead)
675 throws java.io.IOException</PRE>
676<DL>
677<DD>Reads bytes from the current tar archive entry.
678
679 This method is aware of the boundaries of the current
680 entry in the archive and will deal with them as if they
681 were this stream's start and EOF.
682<P>
683<DD><DL>
684<DT><B>Parameters:</B><DD><CODE>buf</CODE> - The buffer into which to place bytes read.<DD><CODE>offset</CODE> - The offset at which to place bytes read.<DD><CODE>numToRead</CODE> - The number of bytes to read.
685<DT><B>Returns:</B><DD>The number of bytes read, or -1 at EOF.
686<DT><B>Throws:</B>
687<DD><CODE>java.io.IOException</CODE> - on error</DL>
688</DD>
689</DL>
690<HR>
691
692<A NAME="copyEntryContents(java.io.OutputStream)"><!-- --></A><H3>
693copyEntryContents</H3>
694<PRE>
695public void <B>copyEntryContents</B>(java.io.OutputStream&nbsp;out)
696 throws java.io.IOException</PRE>
697<DL>
698<DD>Copies the contents of the current tar archive entry directly into
699 an output stream.
700<P>
701<DD><DL>
702<DT><B>Parameters:</B><DD><CODE>out</CODE> - The OutputStream into which to write the entry's data.
703<DT><B>Throws:</B>
704<DD><CODE>java.io.IOException</CODE> - on error</DL>
705</DD>
706</DL>
707<!-- ========= END OF CLASS DATA ========= -->
708<HR>
709
710
711<!-- ======= START OF BOTTOM NAVBAR ====== -->
712<A NAME="navbar_bottom"><!-- --></A>
713<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
714<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
715<TR>
716<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
717<A NAME="navbar_bottom_firstrow"><!-- --></A>
718<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
719 <TR ALIGN="center" VALIGN="top">
720 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
721 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
722 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
723 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
724 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
725 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
726 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
727 </TR>
728</TABLE>
729</TD>
730<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
731</EM>
732</TD>
733</TR>
734
735<TR>
736<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
737&nbsp;<A HREF="../../../../org/apache/tools/tar/TarEntry.html" title="class in org.apache.tools.tar"><B>PREV CLASS</B></A>&nbsp;
738&nbsp;<A HREF="../../../../org/apache/tools/tar/TarOutputStream.html" title="class in org.apache.tools.tar"><B>NEXT CLASS</B></A></FONT></TD>
739<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
740 <A HREF="../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
741&nbsp;<A HREF="TarInputStream.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
742&nbsp;<SCRIPT type="text/javascript">
743 <!--
744 if(window==top) {
745 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
746 }
747 //-->
748</SCRIPT>
749<NOSCRIPT>
750 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
751</NOSCRIPT>
752
753</FONT></TD>
754</TR>
755<TR>
756<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
757 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
758<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
759DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
760</TR>
761</TABLE>
762<A NAME="skip-navbar_bottom"></A>
763<!-- ======== END OF BOTTOM NAVBAR ======= -->
764
765<HR>
766Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.
767</BODY>
768</HTML>
Note: See TracBrowser for help on using the repository browser.