source: other-projects/trunk/gs3-release-maker/apache-ant-1.6.5/build/javadocs/org/apache/tools/tar/TarEntry.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: 39.6 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>
7TarEntry (Apache Ant API)
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.apache.tools.tar.TarEntry 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="TarEntry (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/TarBuffer.html" title="class in org.apache.tools.tar"><B>PREV CLASS</B></A>&nbsp;
53&nbsp;<A HREF="../../../../org/apache/tools/tar/TarInputStream.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="TarEntry.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 TarEntry</H2>
87<PRE>
88java.lang.Object
89 <IMG SRC="../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.tools.tar.TarEntry</B>
90</PRE>
91<DL>
92<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../org/apache/tools/tar/TarConstants.html" title="interface in org.apache.tools.tar">TarConstants</A></DD>
93</DL>
94<HR>
95<DL>
96<DT>public class <B>TarEntry</B><DT>extends java.lang.Object<DT>implements <A HREF="../../../../org/apache/tools/tar/TarConstants.html" title="interface in org.apache.tools.tar">TarConstants</A></DL>
97
98<P>
99This class represents an entry in a Tar archive. It consists
100 of the entry's header, as well as the entry's File. Entries
101 can be instantiated in one of three ways, depending on how
102 they are to be used.
103 <p>
104 TarEntries that are created from the header bytes read from
105 an archive are instantiated with the TarEntry( byte[] )
106 constructor. These entries will be used when extracting from
107 or listing the contents of an archive. These entries have their
108 header filled in using the header bytes. They also set the File
109 to null, since they reference an archive entry not a file.
110 <p>
111 TarEntries that are created from Files that are to be written
112 into an archive are instantiated with the TarEntry( File )
113 constructor. These entries have their header filled in using
114 the File's information. They also keep a reference to the File
115 for convenience when writing entries.
116 <p>
117 Finally, TarEntries can be constructed from nothing but a name.
118 This allows the programmer to construct the entry by hand, for
119 instance when only an InputStream is available for writing to
120 the archive, and the header information is constructed from
121 other information. In this case the header fields are set to
122 defaults and the File is set to null.
123
124 <p>
125 The C structure for a Tar Entry's header is:
126 <pre>
127 struct header {
128 char name[NAMSIZ];
129 char mode[8];
130 char uid[8];
131 char gid[8];
132 char size[12];
133 char mtime[12];
134 char chksum[8];
135 char linkflag;
136 char linkname[NAMSIZ];
137 char magic[8];
138 char uname[TUNMLEN];
139 char gname[TGNMLEN];
140 char devmajor[8];
141 char devminor[8];
142 } header;
143 </pre>
144<P>
145
146<P>
147<HR>
148
149<P>
150<!-- ======== NESTED CLASS SUMMARY ======== -->
151
152
153<!-- =========== FIELD SUMMARY =========== -->
154
155<A NAME="field_summary"><!-- --></A>
156<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
157<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
158<TD COLSPAN=2><FONT SIZE="+2">
159<B>Field Summary</B></FONT></TD>
160</TR>
161<TR BGCOLOR="white" CLASS="TableRowColor">
162<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
163<CODE>static&nbsp;int</CODE></FONT></TD>
164<TD><CODE><B><A HREF="../../../../org/apache/tools/tar/TarEntry.html#DEFAULT_DIR_MODE">DEFAULT_DIR_MODE</A></B></CODE>
165
166<BR>
167&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default permissions bits for directories</TD>
168</TR>
169<TR BGCOLOR="white" CLASS="TableRowColor">
170<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
171<CODE>static&nbsp;int</CODE></FONT></TD>
172<TD><CODE><B><A HREF="../../../../org/apache/tools/tar/TarEntry.html#DEFAULT_FILE_MODE">DEFAULT_FILE_MODE</A></B></CODE>
173
174<BR>
175&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default permissions bits for files</TD>
176</TR>
177<TR BGCOLOR="white" CLASS="TableRowColor">
178<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
179<CODE>static&nbsp;int</CODE></FONT></TD>
180<TD><CODE><B><A HREF="../../../../org/apache/tools/tar/TarEntry.html#MAX_NAMELEN">MAX_NAMELEN</A></B></CODE>
181
182<BR>
183&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Maximum length of a user's name in the tar file</TD>
184</TR>
185<TR BGCOLOR="white" CLASS="TableRowColor">
186<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
187<CODE>static&nbsp;int</CODE></FONT></TD>
188<TD><CODE><B><A HREF="../../../../org/apache/tools/tar/TarEntry.html#MILLIS_PER_SECOND">MILLIS_PER_SECOND</A></B></CODE>
189
190<BR>
191&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Convert millis to seconds</TD>
192</TR>
193</TABLE>
194&nbsp;<A NAME="fields_inherited_from_class_org.apache.tools.tar.TarConstants"><!-- --></A>
195<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
196<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
197<TD><B>Fields inherited from interface org.apache.tools.tar.<A HREF="../../../../org/apache/tools/tar/TarConstants.html" title="interface in org.apache.tools.tar">TarConstants</A></B></TD>
198</TR>
199<TR BGCOLOR="white" CLASS="TableRowColor">
200<TD><CODE><A HREF="../../../../org/apache/tools/tar/TarConstants.html#CHKSUMLEN">CHKSUMLEN</A>, <A HREF="../../../../org/apache/tools/tar/TarConstants.html#DEVLEN">DEVLEN</A>, <A HREF="../../../../org/apache/tools/tar/TarConstants.html#GIDLEN">GIDLEN</A>, <A HREF="../../../../org/apache/tools/tar/TarConstants.html#GNAMELEN">GNAMELEN</A>, <A HREF="../../../../org/apache/tools/tar/TarConstants.html#GNU_LONGLINK">GNU_LONGLINK</A>, <A HREF="../../../../org/apache/tools/tar/TarConstants.html#GNU_TMAGIC">GNU_TMAGIC</A>, <A HREF="../../../../org/apache/tools/tar/TarConstants.html#LF_BLK">LF_BLK</A>, <A HREF="../../../../org/apache/tools/tar/TarConstants.html#LF_CHR">LF_CHR</A>, <A HREF="../../../../org/apache/tools/tar/TarConstants.html#LF_CONTIG">LF_CONTIG</A>, <A HREF="../../../../org/apache/tools/tar/TarConstants.html#LF_DIR">LF_DIR</A>, <A HREF="../../../../org/apache/tools/tar/TarConstants.html#LF_FIFO">LF_FIFO</A>, <A HREF="../../../../org/apache/tools/tar/TarConstants.html#LF_GNUTYPE_LONGNAME">LF_GNUTYPE_LONGNAME</A>, <A HREF="../../../../org/apache/tools/tar/TarConstants.html#LF_LINK">LF_LINK</A>, <A HREF="../../../../org/apache/tools/tar/TarConstants.html#LF_NORMAL">LF_NORMAL</A>, <A HREF="../../../../org/apache/tools/tar/TarConstants.html#LF_OLDNORM">LF_OLDNORM</A>, <A HREF="../../../../org/apache/tools/tar/TarConstants.html#LF_SYMLINK">LF_SYMLINK</A>, <A HREF="../../../../org/apache/tools/tar/TarConstants.html#MAGICLEN">MAGICLEN</A>, <A HREF="../../../../org/apache/tools/tar/TarConstants.html#MODELEN">MODELEN</A>, <A HREF="../../../../org/apache/tools/tar/TarConstants.html#MODTIMELEN">MODTIMELEN</A>, <A HREF="../../../../org/apache/tools/tar/TarConstants.html#NAMELEN">NAMELEN</A>, <A HREF="../../../../org/apache/tools/tar/TarConstants.html#SIZELEN">SIZELEN</A>, <A HREF="../../../../org/apache/tools/tar/TarConstants.html#TMAGIC">TMAGIC</A>, <A HREF="../../../../org/apache/tools/tar/TarConstants.html#UIDLEN">UIDLEN</A>, <A HREF="../../../../org/apache/tools/tar/TarConstants.html#UNAMELEN">UNAMELEN</A></CODE></TD>
201</TR>
202</TABLE>
203&nbsp;
204<!-- ======== CONSTRUCTOR SUMMARY ======== -->
205
206<A NAME="constructor_summary"><!-- --></A>
207<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
208<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
209<TD COLSPAN=2><FONT SIZE="+2">
210<B>Constructor Summary</B></FONT></TD>
211</TR>
212<TR BGCOLOR="white" CLASS="TableRowColor">
213<TD><CODE><B><A HREF="../../../../org/apache/tools/tar/TarEntry.html#TarEntry(byte[])">TarEntry</A></B>(byte[]&nbsp;headerBuf)</CODE>
214
215<BR>
216&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Construct an entry from an archive's header bytes.</TD>
217</TR>
218<TR BGCOLOR="white" CLASS="TableRowColor">
219<TD><CODE><B><A HREF="../../../../org/apache/tools/tar/TarEntry.html#TarEntry(java.io.File)">TarEntry</A></B>(java.io.File&nbsp;file)</CODE>
220
221<BR>
222&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Construct an entry for a file.</TD>
223</TR>
224<TR BGCOLOR="white" CLASS="TableRowColor">
225<TD><CODE><B><A HREF="../../../../org/apache/tools/tar/TarEntry.html#TarEntry(java.lang.String)">TarEntry</A></B>(java.lang.String&nbsp;name)</CODE>
226
227<BR>
228&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Construct an entry with only a name.</TD>
229</TR>
230<TR BGCOLOR="white" CLASS="TableRowColor">
231<TD><CODE><B><A HREF="../../../../org/apache/tools/tar/TarEntry.html#TarEntry(java.lang.String, byte)">TarEntry</A></B>(java.lang.String&nbsp;name,
232 byte&nbsp;linkFlag)</CODE>
233
234<BR>
235&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Construct an entry with a name an a link flag.</TD>
236</TR>
237</TABLE>
238&nbsp;
239<!-- ========== METHOD SUMMARY =========== -->
240
241<A NAME="method_summary"><!-- --></A>
242<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
243<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
244<TD COLSPAN=2><FONT SIZE="+2">
245<B>Method Summary</B></FONT></TD>
246</TR>
247<TR BGCOLOR="white" CLASS="TableRowColor">
248<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
249<CODE>&nbsp;boolean</CODE></FONT></TD>
250<TD><CODE><B><A HREF="../../../../org/apache/tools/tar/TarEntry.html#equals(java.lang.Object)">equals</A></B>(java.lang.Object&nbsp;it)</CODE>
251
252<BR>
253&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Determine if the two entries are equal.</TD>
254</TR>
255<TR BGCOLOR="white" CLASS="TableRowColor">
256<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
257<CODE>&nbsp;boolean</CODE></FONT></TD>
258<TD><CODE><B><A HREF="../../../../org/apache/tools/tar/TarEntry.html#equals(org.apache.tools.tar.TarEntry)">equals</A></B>(<A HREF="../../../../org/apache/tools/tar/TarEntry.html" title="class in org.apache.tools.tar">TarEntry</A>&nbsp;it)</CODE>
259
260<BR>
261&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Determine if the two entries are equal.</TD>
262</TR>
263<TR BGCOLOR="white" CLASS="TableRowColor">
264<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
265<CODE>&nbsp;<A HREF="../../../../org/apache/tools/tar/TarEntry.html" title="class in org.apache.tools.tar">TarEntry</A>[]</CODE></FONT></TD>
266<TD><CODE><B><A HREF="../../../../org/apache/tools/tar/TarEntry.html#getDirectoryEntries()">getDirectoryEntries</A></B>()</CODE>
267
268<BR>
269&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;If this entry represents a file, and the file is a directory, return
270 an array of TarEntries for this entry's children.</TD>
271</TR>
272<TR BGCOLOR="white" CLASS="TableRowColor">
273<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
274<CODE>&nbsp;java.io.File</CODE></FONT></TD>
275<TD><CODE><B><A HREF="../../../../org/apache/tools/tar/TarEntry.html#getFile()">getFile</A></B>()</CODE>
276
277<BR>
278&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get this entry's file.</TD>
279</TR>
280<TR BGCOLOR="white" CLASS="TableRowColor">
281<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
282<CODE>&nbsp;int</CODE></FONT></TD>
283<TD><CODE><B><A HREF="../../../../org/apache/tools/tar/TarEntry.html#getGroupId()">getGroupId</A></B>()</CODE>
284
285<BR>
286&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get this entry's group id.</TD>
287</TR>
288<TR BGCOLOR="white" CLASS="TableRowColor">
289<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
290<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
291<TD><CODE><B><A HREF="../../../../org/apache/tools/tar/TarEntry.html#getGroupName()">getGroupName</A></B>()</CODE>
292
293<BR>
294&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get this entry's group name.</TD>
295</TR>
296<TR BGCOLOR="white" CLASS="TableRowColor">
297<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
298<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
299<TD><CODE><B><A HREF="../../../../org/apache/tools/tar/TarEntry.html#getLinkName()">getLinkName</A></B>()</CODE>
300
301<BR>
302&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get this entry's link name.</TD>
303</TR>
304<TR BGCOLOR="white" CLASS="TableRowColor">
305<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
306<CODE>&nbsp;int</CODE></FONT></TD>
307<TD><CODE><B><A HREF="../../../../org/apache/tools/tar/TarEntry.html#getMode()">getMode</A></B>()</CODE>
308
309<BR>
310&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get this entry's mode.</TD>
311</TR>
312<TR BGCOLOR="white" CLASS="TableRowColor">
313<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
314<CODE>&nbsp;java.util.Date</CODE></FONT></TD>
315<TD><CODE><B><A HREF="../../../../org/apache/tools/tar/TarEntry.html#getModTime()">getModTime</A></B>()</CODE>
316
317<BR>
318&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set this entry's modification time.</TD>
319</TR>
320<TR BGCOLOR="white" CLASS="TableRowColor">
321<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
322<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
323<TD><CODE><B><A HREF="../../../../org/apache/tools/tar/TarEntry.html#getName()">getName</A></B>()</CODE>
324
325<BR>
326&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get this entry's name.</TD>
327</TR>
328<TR BGCOLOR="white" CLASS="TableRowColor">
329<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
330<CODE>&nbsp;long</CODE></FONT></TD>
331<TD><CODE><B><A HREF="../../../../org/apache/tools/tar/TarEntry.html#getSize()">getSize</A></B>()</CODE>
332
333<BR>
334&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get this entry's file size.</TD>
335</TR>
336<TR BGCOLOR="white" CLASS="TableRowColor">
337<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
338<CODE>&nbsp;int</CODE></FONT></TD>
339<TD><CODE><B><A HREF="../../../../org/apache/tools/tar/TarEntry.html#getUserId()">getUserId</A></B>()</CODE>
340
341<BR>
342&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get this entry's user id.</TD>
343</TR>
344<TR BGCOLOR="white" CLASS="TableRowColor">
345<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
346<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
347<TD><CODE><B><A HREF="../../../../org/apache/tools/tar/TarEntry.html#getUserName()">getUserName</A></B>()</CODE>
348
349<BR>
350&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get this entry's user name.</TD>
351</TR>
352<TR BGCOLOR="white" CLASS="TableRowColor">
353<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
354<CODE>&nbsp;int</CODE></FONT></TD>
355<TD><CODE><B><A HREF="../../../../org/apache/tools/tar/TarEntry.html#hashCode()">hashCode</A></B>()</CODE>
356
357<BR>
358&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Hashcodes are based on entry names.</TD>
359</TR>
360<TR BGCOLOR="white" CLASS="TableRowColor">
361<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
362<CODE>&nbsp;boolean</CODE></FONT></TD>
363<TD><CODE><B><A HREF="../../../../org/apache/tools/tar/TarEntry.html#isDescendent(org.apache.tools.tar.TarEntry)">isDescendent</A></B>(<A HREF="../../../../org/apache/tools/tar/TarEntry.html" title="class in org.apache.tools.tar">TarEntry</A>&nbsp;desc)</CODE>
364
365<BR>
366&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Determine if the given entry is a descendant of this entry.</TD>
367</TR>
368<TR BGCOLOR="white" CLASS="TableRowColor">
369<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
370<CODE>&nbsp;boolean</CODE></FONT></TD>
371<TD><CODE><B><A HREF="../../../../org/apache/tools/tar/TarEntry.html#isDirectory()">isDirectory</A></B>()</CODE>
372
373<BR>
374&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return whether or not this entry represents a directory.</TD>
375</TR>
376<TR BGCOLOR="white" CLASS="TableRowColor">
377<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
378<CODE>&nbsp;boolean</CODE></FONT></TD>
379<TD><CODE><B><A HREF="../../../../org/apache/tools/tar/TarEntry.html#isGNULongNameEntry()">isGNULongNameEntry</A></B>()</CODE>
380
381<BR>
382&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Indicate if this entry is a GNU long name block</TD>
383</TR>
384<TR BGCOLOR="white" CLASS="TableRowColor">
385<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
386<CODE>&nbsp;void</CODE></FONT></TD>
387<TD><CODE><B><A HREF="../../../../org/apache/tools/tar/TarEntry.html#parseTarHeader(byte[])">parseTarHeader</A></B>(byte[]&nbsp;header)</CODE>
388
389<BR>
390&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Parse an entry's header information from a header buffer.</TD>
391</TR>
392<TR BGCOLOR="white" CLASS="TableRowColor">
393<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
394<CODE>&nbsp;void</CODE></FONT></TD>
395<TD><CODE><B><A HREF="../../../../org/apache/tools/tar/TarEntry.html#setGroupId(int)">setGroupId</A></B>(int&nbsp;groupId)</CODE>
396
397<BR>
398&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set this entry's group id.</TD>
399</TR>
400<TR BGCOLOR="white" CLASS="TableRowColor">
401<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
402<CODE>&nbsp;void</CODE></FONT></TD>
403<TD><CODE><B><A HREF="../../../../org/apache/tools/tar/TarEntry.html#setGroupName(java.lang.String)">setGroupName</A></B>(java.lang.String&nbsp;groupName)</CODE>
404
405<BR>
406&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set this entry's group name.</TD>
407</TR>
408<TR BGCOLOR="white" CLASS="TableRowColor">
409<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
410<CODE>&nbsp;void</CODE></FONT></TD>
411<TD><CODE><B><A HREF="../../../../org/apache/tools/tar/TarEntry.html#setIds(int, int)">setIds</A></B>(int&nbsp;userId,
412 int&nbsp;groupId)</CODE>
413
414<BR>
415&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Convenience method to set this entry's group and user ids.</TD>
416</TR>
417<TR BGCOLOR="white" CLASS="TableRowColor">
418<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
419<CODE>&nbsp;void</CODE></FONT></TD>
420<TD><CODE><B><A HREF="../../../../org/apache/tools/tar/TarEntry.html#setMode(int)">setMode</A></B>(int&nbsp;mode)</CODE>
421
422<BR>
423&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the mode for this entry</TD>
424</TR>
425<TR BGCOLOR="white" CLASS="TableRowColor">
426<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
427<CODE>&nbsp;void</CODE></FONT></TD>
428<TD><CODE><B><A HREF="../../../../org/apache/tools/tar/TarEntry.html#setModTime(java.util.Date)">setModTime</A></B>(java.util.Date&nbsp;time)</CODE>
429
430<BR>
431&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set this entry's modification time.</TD>
432</TR>
433<TR BGCOLOR="white" CLASS="TableRowColor">
434<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
435<CODE>&nbsp;void</CODE></FONT></TD>
436<TD><CODE><B><A HREF="../../../../org/apache/tools/tar/TarEntry.html#setModTime(long)">setModTime</A></B>(long&nbsp;time)</CODE>
437
438<BR>
439&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set this entry's modification time.</TD>
440</TR>
441<TR BGCOLOR="white" CLASS="TableRowColor">
442<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
443<CODE>&nbsp;void</CODE></FONT></TD>
444<TD><CODE><B><A HREF="../../../../org/apache/tools/tar/TarEntry.html#setName(java.lang.String)">setName</A></B>(java.lang.String&nbsp;name)</CODE>
445
446<BR>
447&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set this entry's name.</TD>
448</TR>
449<TR BGCOLOR="white" CLASS="TableRowColor">
450<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
451<CODE>&nbsp;void</CODE></FONT></TD>
452<TD><CODE><B><A HREF="../../../../org/apache/tools/tar/TarEntry.html#setNames(java.lang.String, java.lang.String)">setNames</A></B>(java.lang.String&nbsp;userName,
453 java.lang.String&nbsp;groupName)</CODE>
454
455<BR>
456&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Convenience method to set this entry's group and user names.</TD>
457</TR>
458<TR BGCOLOR="white" CLASS="TableRowColor">
459<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
460<CODE>&nbsp;void</CODE></FONT></TD>
461<TD><CODE><B><A HREF="../../../../org/apache/tools/tar/TarEntry.html#setSize(long)">setSize</A></B>(long&nbsp;size)</CODE>
462
463<BR>
464&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set this entry's file size.</TD>
465</TR>
466<TR BGCOLOR="white" CLASS="TableRowColor">
467<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
468<CODE>&nbsp;void</CODE></FONT></TD>
469<TD><CODE><B><A HREF="../../../../org/apache/tools/tar/TarEntry.html#setUserId(int)">setUserId</A></B>(int&nbsp;userId)</CODE>
470
471<BR>
472&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set this entry's user id.</TD>
473</TR>
474<TR BGCOLOR="white" CLASS="TableRowColor">
475<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
476<CODE>&nbsp;void</CODE></FONT></TD>
477<TD><CODE><B><A HREF="../../../../org/apache/tools/tar/TarEntry.html#setUserName(java.lang.String)">setUserName</A></B>(java.lang.String&nbsp;userName)</CODE>
478
479<BR>
480&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set this entry's user name.</TD>
481</TR>
482<TR BGCOLOR="white" CLASS="TableRowColor">
483<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
484<CODE>&nbsp;void</CODE></FONT></TD>
485<TD><CODE><B><A HREF="../../../../org/apache/tools/tar/TarEntry.html#writeEntryHeader(byte[])">writeEntryHeader</A></B>(byte[]&nbsp;outbuf)</CODE>
486
487<BR>
488&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Write an entry's header information to a header buffer.</TD>
489</TR>
490</TABLE>
491&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
492<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
493<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
494<TD><B>Methods inherited from class java.lang.Object</B></TD>
495</TR>
496<TR BGCOLOR="white" CLASS="TableRowColor">
497<TD><CODE>clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
498</TR>
499</TABLE>
500&nbsp;
501<P>
502
503<!-- ============ FIELD DETAIL =========== -->
504
505<A NAME="field_detail"><!-- --></A>
506<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
507<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
508<TD COLSPAN=1><FONT SIZE="+2">
509<B>Field Detail</B></FONT></TD>
510</TR>
511</TABLE>
512
513<A NAME="MAX_NAMELEN"><!-- --></A><H3>
514MAX_NAMELEN</H3>
515<PRE>
516public static final int <B>MAX_NAMELEN</B></PRE>
517<DL>
518<DD>Maximum length of a user's name in the tar file
519<P>
520<DL>
521<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.tools.tar.TarEntry.MAX_NAMELEN">Constant Field Values</A></DL>
522</DL>
523<HR>
524
525<A NAME="DEFAULT_DIR_MODE"><!-- --></A><H3>
526DEFAULT_DIR_MODE</H3>
527<PRE>
528public static final int <B>DEFAULT_DIR_MODE</B></PRE>
529<DL>
530<DD>Default permissions bits for directories
531<P>
532<DL>
533<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.tools.tar.TarEntry.DEFAULT_DIR_MODE">Constant Field Values</A></DL>
534</DL>
535<HR>
536
537<A NAME="DEFAULT_FILE_MODE"><!-- --></A><H3>
538DEFAULT_FILE_MODE</H3>
539<PRE>
540public static final int <B>DEFAULT_FILE_MODE</B></PRE>
541<DL>
542<DD>Default permissions bits for files
543<P>
544<DL>
545<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.tools.tar.TarEntry.DEFAULT_FILE_MODE">Constant Field Values</A></DL>
546</DL>
547<HR>
548
549<A NAME="MILLIS_PER_SECOND"><!-- --></A><H3>
550MILLIS_PER_SECOND</H3>
551<PRE>
552public static final int <B>MILLIS_PER_SECOND</B></PRE>
553<DL>
554<DD>Convert millis to seconds
555<P>
556<DL>
557<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.tools.tar.TarEntry.MILLIS_PER_SECOND">Constant Field Values</A></DL>
558</DL>
559
560<!-- ========= CONSTRUCTOR DETAIL ======== -->
561
562<A NAME="constructor_detail"><!-- --></A>
563<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
564<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
565<TD COLSPAN=1><FONT SIZE="+2">
566<B>Constructor Detail</B></FONT></TD>
567</TR>
568</TABLE>
569
570<A NAME="TarEntry(java.lang.String)"><!-- --></A><H3>
571TarEntry</H3>
572<PRE>
573public <B>TarEntry</B>(java.lang.String&nbsp;name)</PRE>
574<DL>
575<DD>Construct an entry with only a name. This allows the programmer
576 to construct the entry's header "by hand". File is set to null.
577<P>
578<DT><B>Parameters:</B><DD><CODE>name</CODE> - the entry name</DL>
579<HR>
580
581<A NAME="TarEntry(java.lang.String, byte)"><!-- --></A><H3>
582TarEntry</H3>
583<PRE>
584public <B>TarEntry</B>(java.lang.String&nbsp;name,
585 byte&nbsp;linkFlag)</PRE>
586<DL>
587<DD>Construct an entry with a name an a link flag.
588<P>
589<DT><B>Parameters:</B><DD><CODE>name</CODE> - the entry name<DD><CODE>linkFlag</CODE> - the entry link flag.</DL>
590<HR>
591
592<A NAME="TarEntry(java.io.File)"><!-- --></A><H3>
593TarEntry</H3>
594<PRE>
595public <B>TarEntry</B>(java.io.File&nbsp;file)</PRE>
596<DL>
597<DD>Construct an entry for a file. File is set to file, and the
598 header is constructed from information from the file.
599<P>
600<DT><B>Parameters:</B><DD><CODE>file</CODE> - The file that the entry represents.</DL>
601<HR>
602
603<A NAME="TarEntry(byte[])"><!-- --></A><H3>
604TarEntry</H3>
605<PRE>
606public <B>TarEntry</B>(byte[]&nbsp;headerBuf)</PRE>
607<DL>
608<DD>Construct an entry from an archive's header bytes. File is set
609 to null.
610<P>
611<DT><B>Parameters:</B><DD><CODE>headerBuf</CODE> - The header bytes from a tar archive entry.</DL>
612
613<!-- ============ METHOD DETAIL ========== -->
614
615<A NAME="method_detail"><!-- --></A>
616<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
617<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
618<TD COLSPAN=1><FONT SIZE="+2">
619<B>Method Detail</B></FONT></TD>
620</TR>
621</TABLE>
622
623<A NAME="equals(org.apache.tools.tar.TarEntry)"><!-- --></A><H3>
624equals</H3>
625<PRE>
626public boolean <B>equals</B>(<A HREF="../../../../org/apache/tools/tar/TarEntry.html" title="class in org.apache.tools.tar">TarEntry</A>&nbsp;it)</PRE>
627<DL>
628<DD>Determine if the two entries are equal. Equality is determined
629 by the header names being equal.
630<P>
631<DD><DL>
632</DL>
633</DD>
634<DD><DL>
635<DT><B>Parameters:</B><DD><CODE>it</CODE> - Entry to be checked for equality.
636<DT><B>Returns:</B><DD>True if the entries are equal.</DL>
637</DD>
638</DL>
639<HR>
640
641<A NAME="equals(java.lang.Object)"><!-- --></A><H3>
642equals</H3>
643<PRE>
644public boolean <B>equals</B>(java.lang.Object&nbsp;it)</PRE>
645<DL>
646<DD>Determine if the two entries are equal. Equality is determined
647 by the header names being equal.
648<P>
649<DD><DL>
650</DL>
651</DD>
652<DD><DL>
653<DT><B>Parameters:</B><DD><CODE>it</CODE> - Entry to be checked for equality.
654<DT><B>Returns:</B><DD>True if the entries are equal.</DL>
655</DD>
656</DL>
657<HR>
658
659<A NAME="hashCode()"><!-- --></A><H3>
660hashCode</H3>
661<PRE>
662public int <B>hashCode</B>()</PRE>
663<DL>
664<DD>Hashcodes are based on entry names.
665<P>
666<DD><DL>
667</DL>
668</DD>
669<DD><DL>
670
671<DT><B>Returns:</B><DD>the entry hashcode</DL>
672</DD>
673</DL>
674<HR>
675
676<A NAME="isDescendent(org.apache.tools.tar.TarEntry)"><!-- --></A><H3>
677isDescendent</H3>
678<PRE>
679public boolean <B>isDescendent</B>(<A HREF="../../../../org/apache/tools/tar/TarEntry.html" title="class in org.apache.tools.tar">TarEntry</A>&nbsp;desc)</PRE>
680<DL>
681<DD>Determine if the given entry is a descendant of this entry.
682 Descendancy is determined by the name of the descendant
683 starting with this entry's name.
684<P>
685<DD><DL>
686</DL>
687</DD>
688<DD><DL>
689<DT><B>Parameters:</B><DD><CODE>desc</CODE> - Entry to be checked as a descendent of this.
690<DT><B>Returns:</B><DD>True if entry is a descendant of this.</DL>
691</DD>
692</DL>
693<HR>
694
695<A NAME="getName()"><!-- --></A><H3>
696getName</H3>
697<PRE>
698public java.lang.String <B>getName</B>()</PRE>
699<DL>
700<DD>Get this entry's name.
701<P>
702<DD><DL>
703</DL>
704</DD>
705<DD><DL>
706
707<DT><B>Returns:</B><DD>This entry's name.</DL>
708</DD>
709</DL>
710<HR>
711
712<A NAME="setName(java.lang.String)"><!-- --></A><H3>
713setName</H3>
714<PRE>
715public void <B>setName</B>(java.lang.String&nbsp;name)</PRE>
716<DL>
717<DD>Set this entry's name.
718<P>
719<DD><DL>
720</DL>
721</DD>
722<DD><DL>
723<DT><B>Parameters:</B><DD><CODE>name</CODE> - This entry's new name.</DL>
724</DD>
725</DL>
726<HR>
727
728<A NAME="setMode(int)"><!-- --></A><H3>
729setMode</H3>
730<PRE>
731public void <B>setMode</B>(int&nbsp;mode)</PRE>
732<DL>
733<DD>Set the mode for this entry
734<P>
735<DD><DL>
736</DL>
737</DD>
738<DD><DL>
739<DT><B>Parameters:</B><DD><CODE>mode</CODE> - the mode for this entry</DL>
740</DD>
741</DL>
742<HR>
743
744<A NAME="getLinkName()"><!-- --></A><H3>
745getLinkName</H3>
746<PRE>
747public java.lang.String <B>getLinkName</B>()</PRE>
748<DL>
749<DD>Get this entry's link name.
750<P>
751<DD><DL>
752</DL>
753</DD>
754<DD><DL>
755
756<DT><B>Returns:</B><DD>This entry's link name.</DL>
757</DD>
758</DL>
759<HR>
760
761<A NAME="getUserId()"><!-- --></A><H3>
762getUserId</H3>
763<PRE>
764public int <B>getUserId</B>()</PRE>
765<DL>
766<DD>Get this entry's user id.
767<P>
768<DD><DL>
769</DL>
770</DD>
771<DD><DL>
772
773<DT><B>Returns:</B><DD>This entry's user id.</DL>
774</DD>
775</DL>
776<HR>
777
778<A NAME="setUserId(int)"><!-- --></A><H3>
779setUserId</H3>
780<PRE>
781public void <B>setUserId</B>(int&nbsp;userId)</PRE>
782<DL>
783<DD>Set this entry's user id.
784<P>
785<DD><DL>
786</DL>
787</DD>
788<DD><DL>
789<DT><B>Parameters:</B><DD><CODE>userId</CODE> - This entry's new user id.</DL>
790</DD>
791</DL>
792<HR>
793
794<A NAME="getGroupId()"><!-- --></A><H3>
795getGroupId</H3>
796<PRE>
797public int <B>getGroupId</B>()</PRE>
798<DL>
799<DD>Get this entry's group id.
800<P>
801<DD><DL>
802</DL>
803</DD>
804<DD><DL>
805
806<DT><B>Returns:</B><DD>This entry's group id.</DL>
807</DD>
808</DL>
809<HR>
810
811<A NAME="setGroupId(int)"><!-- --></A><H3>
812setGroupId</H3>
813<PRE>
814public void <B>setGroupId</B>(int&nbsp;groupId)</PRE>
815<DL>
816<DD>Set this entry's group id.
817<P>
818<DD><DL>
819</DL>
820</DD>
821<DD><DL>
822<DT><B>Parameters:</B><DD><CODE>groupId</CODE> - This entry's new group id.</DL>
823</DD>
824</DL>
825<HR>
826
827<A NAME="getUserName()"><!-- --></A><H3>
828getUserName</H3>
829<PRE>
830public java.lang.String <B>getUserName</B>()</PRE>
831<DL>
832<DD>Get this entry's user name.
833<P>
834<DD><DL>
835</DL>
836</DD>
837<DD><DL>
838
839<DT><B>Returns:</B><DD>This entry's user name.</DL>
840</DD>
841</DL>
842<HR>
843
844<A NAME="setUserName(java.lang.String)"><!-- --></A><H3>
845setUserName</H3>
846<PRE>
847public void <B>setUserName</B>(java.lang.String&nbsp;userName)</PRE>
848<DL>
849<DD>Set this entry's user name.
850<P>
851<DD><DL>
852</DL>
853</DD>
854<DD><DL>
855<DT><B>Parameters:</B><DD><CODE>userName</CODE> - This entry's new user name.</DL>
856</DD>
857</DL>
858<HR>
859
860<A NAME="getGroupName()"><!-- --></A><H3>
861getGroupName</H3>
862<PRE>
863public java.lang.String <B>getGroupName</B>()</PRE>
864<DL>
865<DD>Get this entry's group name.
866<P>
867<DD><DL>
868</DL>
869</DD>
870<DD><DL>
871
872<DT><B>Returns:</B><DD>This entry's group name.</DL>
873</DD>
874</DL>
875<HR>
876
877<A NAME="setGroupName(java.lang.String)"><!-- --></A><H3>
878setGroupName</H3>
879<PRE>
880public void <B>setGroupName</B>(java.lang.String&nbsp;groupName)</PRE>
881<DL>
882<DD>Set this entry's group name.
883<P>
884<DD><DL>
885</DL>
886</DD>
887<DD><DL>
888<DT><B>Parameters:</B><DD><CODE>groupName</CODE> - This entry's new group name.</DL>
889</DD>
890</DL>
891<HR>
892
893<A NAME="setIds(int, int)"><!-- --></A><H3>
894setIds</H3>
895<PRE>
896public void <B>setIds</B>(int&nbsp;userId,
897 int&nbsp;groupId)</PRE>
898<DL>
899<DD>Convenience method to set this entry's group and user ids.
900<P>
901<DD><DL>
902</DL>
903</DD>
904<DD><DL>
905<DT><B>Parameters:</B><DD><CODE>userId</CODE> - This entry's new user id.<DD><CODE>groupId</CODE> - This entry's new group id.</DL>
906</DD>
907</DL>
908<HR>
909
910<A NAME="setNames(java.lang.String, java.lang.String)"><!-- --></A><H3>
911setNames</H3>
912<PRE>
913public void <B>setNames</B>(java.lang.String&nbsp;userName,
914 java.lang.String&nbsp;groupName)</PRE>
915<DL>
916<DD>Convenience method to set this entry's group and user names.
917<P>
918<DD><DL>
919</DL>
920</DD>
921<DD><DL>
922<DT><B>Parameters:</B><DD><CODE>userName</CODE> - This entry's new user name.<DD><CODE>groupName</CODE> - This entry's new group name.</DL>
923</DD>
924</DL>
925<HR>
926
927<A NAME="setModTime(long)"><!-- --></A><H3>
928setModTime</H3>
929<PRE>
930public void <B>setModTime</B>(long&nbsp;time)</PRE>
931<DL>
932<DD>Set this entry's modification time. The parameter passed
933 to this method is in "Java time".
934<P>
935<DD><DL>
936</DL>
937</DD>
938<DD><DL>
939<DT><B>Parameters:</B><DD><CODE>time</CODE> - This entry's new modification time.</DL>
940</DD>
941</DL>
942<HR>
943
944<A NAME="setModTime(java.util.Date)"><!-- --></A><H3>
945setModTime</H3>
946<PRE>
947public void <B>setModTime</B>(java.util.Date&nbsp;time)</PRE>
948<DL>
949<DD>Set this entry's modification time.
950<P>
951<DD><DL>
952</DL>
953</DD>
954<DD><DL>
955<DT><B>Parameters:</B><DD><CODE>time</CODE> - This entry's new modification time.</DL>
956</DD>
957</DL>
958<HR>
959
960<A NAME="getModTime()"><!-- --></A><H3>
961getModTime</H3>
962<PRE>
963public java.util.Date <B>getModTime</B>()</PRE>
964<DL>
965<DD>Set this entry's modification time.
966<P>
967<DD><DL>
968</DL>
969</DD>
970<DD><DL>
971
972<DT><B>Returns:</B><DD>time This entry's new modification time.</DL>
973</DD>
974</DL>
975<HR>
976
977<A NAME="getFile()"><!-- --></A><H3>
978getFile</H3>
979<PRE>
980public java.io.File <B>getFile</B>()</PRE>
981<DL>
982<DD>Get this entry's file.
983<P>
984<DD><DL>
985</DL>
986</DD>
987<DD><DL>
988
989<DT><B>Returns:</B><DD>This entry's file.</DL>
990</DD>
991</DL>
992<HR>
993
994<A NAME="getMode()"><!-- --></A><H3>
995getMode</H3>
996<PRE>
997public int <B>getMode</B>()</PRE>
998<DL>
999<DD>Get this entry's mode.
1000<P>
1001<DD><DL>
1002</DL>
1003</DD>
1004<DD><DL>
1005
1006<DT><B>Returns:</B><DD>This entry's mode.</DL>
1007</DD>
1008</DL>
1009<HR>
1010
1011<A NAME="getSize()"><!-- --></A><H3>
1012getSize</H3>
1013<PRE>
1014public long <B>getSize</B>()</PRE>
1015<DL>
1016<DD>Get this entry's file size.
1017<P>
1018<DD><DL>
1019</DL>
1020</DD>
1021<DD><DL>
1022
1023<DT><B>Returns:</B><DD>This entry's file size.</DL>
1024</DD>
1025</DL>
1026<HR>
1027
1028<A NAME="setSize(long)"><!-- --></A><H3>
1029setSize</H3>
1030<PRE>
1031public void <B>setSize</B>(long&nbsp;size)</PRE>
1032<DL>
1033<DD>Set this entry's file size.
1034<P>
1035<DD><DL>
1036</DL>
1037</DD>
1038<DD><DL>
1039<DT><B>Parameters:</B><DD><CODE>size</CODE> - This entry's new file size.</DL>
1040</DD>
1041</DL>
1042<HR>
1043
1044<A NAME="isGNULongNameEntry()"><!-- --></A><H3>
1045isGNULongNameEntry</H3>
1046<PRE>
1047public boolean <B>isGNULongNameEntry</B>()</PRE>
1048<DL>
1049<DD>Indicate if this entry is a GNU long name block
1050<P>
1051<DD><DL>
1052</DL>
1053</DD>
1054<DD><DL>
1055
1056<DT><B>Returns:</B><DD>true if this is a long name extension provided by GNU tar</DL>
1057</DD>
1058</DL>
1059<HR>
1060
1061<A NAME="isDirectory()"><!-- --></A><H3>
1062isDirectory</H3>
1063<PRE>
1064public boolean <B>isDirectory</B>()</PRE>
1065<DL>
1066<DD>Return whether or not this entry represents a directory.
1067<P>
1068<DD><DL>
1069</DL>
1070</DD>
1071<DD><DL>
1072
1073<DT><B>Returns:</B><DD>True if this entry is a directory.</DL>
1074</DD>
1075</DL>
1076<HR>
1077
1078<A NAME="getDirectoryEntries()"><!-- --></A><H3>
1079getDirectoryEntries</H3>
1080<PRE>
1081public <A HREF="../../../../org/apache/tools/tar/TarEntry.html" title="class in org.apache.tools.tar">TarEntry</A>[] <B>getDirectoryEntries</B>()</PRE>
1082<DL>
1083<DD>If this entry represents a file, and the file is a directory, return
1084 an array of TarEntries for this entry's children.
1085<P>
1086<DD><DL>
1087</DL>
1088</DD>
1089<DD><DL>
1090
1091<DT><B>Returns:</B><DD>An array of TarEntry's for this entry's children.</DL>
1092</DD>
1093</DL>
1094<HR>
1095
1096<A NAME="writeEntryHeader(byte[])"><!-- --></A><H3>
1097writeEntryHeader</H3>
1098<PRE>
1099public void <B>writeEntryHeader</B>(byte[]&nbsp;outbuf)</PRE>
1100<DL>
1101<DD>Write an entry's header information to a header buffer.
1102<P>
1103<DD><DL>
1104</DL>
1105</DD>
1106<DD><DL>
1107<DT><B>Parameters:</B><DD><CODE>outbuf</CODE> - The tar entry header buffer to fill in.</DL>
1108</DD>
1109</DL>
1110<HR>
1111
1112<A NAME="parseTarHeader(byte[])"><!-- --></A><H3>
1113parseTarHeader</H3>
1114<PRE>
1115public void <B>parseTarHeader</B>(byte[]&nbsp;header)</PRE>
1116<DL>
1117<DD>Parse an entry's header information from a header buffer.
1118<P>
1119<DD><DL>
1120</DL>
1121</DD>
1122<DD><DL>
1123<DT><B>Parameters:</B><DD><CODE>header</CODE> - The tar entry header buffer to get information from.</DL>
1124</DD>
1125</DL>
1126<!-- ========= END OF CLASS DATA ========= -->
1127<HR>
1128
1129
1130<!-- ======= START OF BOTTOM NAVBAR ====== -->
1131<A NAME="navbar_bottom"><!-- --></A>
1132<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
1133<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
1134<TR>
1135<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
1136<A NAME="navbar_bottom_firstrow"><!-- --></A>
1137<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
1138 <TR ALIGN="center" VALIGN="top">
1139 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
1140 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
1141 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
1142 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
1143 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
1144 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
1145 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
1146 </TR>
1147</TABLE>
1148</TD>
1149<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
1150</EM>
1151</TD>
1152</TR>
1153
1154<TR>
1155<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
1156&nbsp;<A HREF="../../../../org/apache/tools/tar/TarBuffer.html" title="class in org.apache.tools.tar"><B>PREV CLASS</B></A>&nbsp;
1157&nbsp;<A HREF="../../../../org/apache/tools/tar/TarInputStream.html" title="class in org.apache.tools.tar"><B>NEXT CLASS</B></A></FONT></TD>
1158<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
1159 <A HREF="../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
1160&nbsp;<A HREF="TarEntry.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
1161&nbsp;<SCRIPT type="text/javascript">
1162 <!--
1163 if(window==top) {
1164 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
1165 }
1166 //-->
1167</SCRIPT>
1168<NOSCRIPT>
1169 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
1170</NOSCRIPT>
1171
1172</FONT></TD>
1173</TR>
1174<TR>
1175<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
1176 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>
1177<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
1178DETAIL:&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>
1179</TR>
1180</TABLE>
1181<A NAME="skip-navbar_bottom"></A>
1182<!-- ======== END OF BOTTOM NAVBAR ======= -->
1183
1184<HR>
1185Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.
1186</BODY>
1187</HTML>
Note: See TracBrowser for help on using the repository browser.