source: release-kits/lirk3/resources/gs3-release-maker/ant/docs/manual/api/org/apache/tools/ant/taskdefs/Tar.html@ 14982

Last change on this file since 14982 was 14982, checked in by oranfry, 16 years ago

initial import of LiRK3
File size: 40.1 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:22 NZST 2007 -->
6<TITLE>
7Tar (Apache Ant API)
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.apache.tools.ant.taskdefs.Tar 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="Tar (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/ant/taskdefs/Sync.MyCopy.html" title="class in org.apache.tools.ant.taskdefs"><B>PREV CLASS</B></A>&nbsp;
53&nbsp;<A HREF="../../../../../org/apache/tools/ant/taskdefs/Tar.TarCompressionMethod.html" title="class in org.apache.tools.ant.taskdefs"><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="Tar.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;<A HREF="#nested_class_summary">NESTED</A>&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.ant.taskdefs</FONT>
85<BR>
86Class Tar</H2>
87<PRE>
88java.lang.Object
89 <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><A HREF="../../../../../org/apache/tools/ant/ProjectComponent.html" title="class in org.apache.tools.ant">org.apache.tools.ant.ProjectComponent</A>
90 <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><A HREF="../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">org.apache.tools.ant.Task</A>
91 <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><A HREF="../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html" title="class in org.apache.tools.ant.taskdefs">org.apache.tools.ant.taskdefs.MatchingTask</A>
92 <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.tools.ant.taskdefs.Tar</B>
93</PRE>
94<DL>
95<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../../org/apache/tools/ant/types/selectors/SelectorContainer.html" title="interface in org.apache.tools.ant.types.selectors">SelectorContainer</A></DD>
96</DL>
97<HR>
98<DL>
99<DT>public class <B>Tar</B><DT>extends <A HREF="../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html" title="class in org.apache.tools.ant.taskdefs">MatchingTask</A></DL>
100
101<P>
102Creates a tar archive.
103<P>
104
105<P>
106<DL>
107<DT><B>Since:</B></DT>
108 <DD>Ant 1.1</DD>
109</DL>
110<HR>
111
112<P>
113<!-- ======== NESTED CLASS SUMMARY ======== -->
114
115<A NAME="nested_class_summary"><!-- --></A>
116<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
117<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
118<TD COLSPAN=2><FONT SIZE="+2">
119<B>Nested Class Summary</B></FONT></TD>
120</TR>
121<TR BGCOLOR="white" CLASS="TableRowColor">
122<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
123<CODE>static&nbsp;class</CODE></FONT></TD>
124<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Tar.TarCompressionMethod.html" title="class in org.apache.tools.ant.taskdefs">Tar.TarCompressionMethod</A></B></CODE>
125
126<BR>
127&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Valid Modes for Compression attribute to Tar Task</TD>
128</TR>
129<TR BGCOLOR="white" CLASS="TableRowColor">
130<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
131<CODE>static&nbsp;class</CODE></FONT></TD>
132<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Tar.TarFileSet.html" title="class in org.apache.tools.ant.taskdefs">Tar.TarFileSet</A></B></CODE>
133
134<BR>
135&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This is a FileSet with the option to specify permissions
136 and other attributes.</TD>
137</TR>
138<TR BGCOLOR="white" CLASS="TableRowColor">
139<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
140<CODE>static&nbsp;class</CODE></FONT></TD>
141<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Tar.TarLongFileMode.html" title="class in org.apache.tools.ant.taskdefs">Tar.TarLongFileMode</A></B></CODE>
142
143<BR>
144&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set of options for long file handling in the task.</TD>
145</TR>
146</TABLE>
147&nbsp;
148<!-- =========== FIELD SUMMARY =========== -->
149
150<A NAME="field_summary"><!-- --></A>
151<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
152<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
153<TD COLSPAN=2><FONT SIZE="+2">
154<B>Field Summary</B></FONT></TD>
155</TR>
156<TR BGCOLOR="white" CLASS="TableRowColor">
157<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
158<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
159<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Tar.html#FAIL">FAIL</A></B></CODE>
160
161<BR>
162&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;<I>Tar.FAIL is deprecated and is replaced with
163 Tar.TarLongFileMode.FAIL</I></TD>
164</TR>
165<TR BGCOLOR="white" CLASS="TableRowColor">
166<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
167<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
168<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Tar.html#GNU">GNU</A></B></CODE>
169
170<BR>
171&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;<I>Tar.GNU is deprecated and is replaced with
172 Tar.TarLongFileMode.GNU</I></TD>
173</TR>
174<TR BGCOLOR="white" CLASS="TableRowColor">
175<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
176<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
177<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Tar.html#OMIT">OMIT</A></B></CODE>
178
179<BR>
180&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;<I>Tar.OMIT is deprecated and is replaced with
181 Tar.TarLongFileMode.OMIT</I></TD>
182</TR>
183<TR BGCOLOR="white" CLASS="TableRowColor">
184<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
185<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
186<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Tar.html#TRUNCATE">TRUNCATE</A></B></CODE>
187
188<BR>
189&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;<I>Tar.TRUNCATE is deprecated and is replaced with
190 Tar.TarLongFileMode.TRUNCATE</I></TD>
191</TR>
192<TR BGCOLOR="white" CLASS="TableRowColor">
193<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
194<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
195<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Tar.html#WARN">WARN</A></B></CODE>
196
197<BR>
198&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;<I>Tar.WARN is deprecated and is replaced with
199 Tar.TarLongFileMode.WARN</I></TD>
200</TR>
201</TABLE>
202&nbsp;<A NAME="fields_inherited_from_class_org.apache.tools.ant.taskdefs.MatchingTask"><!-- --></A>
203<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
204<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
205<TD><B>Fields inherited from class org.apache.tools.ant.taskdefs.<A HREF="../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html" title="class in org.apache.tools.ant.taskdefs">MatchingTask</A></B></TD>
206</TR>
207<TR BGCOLOR="white" CLASS="TableRowColor">
208<TD><CODE><A HREF="../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#fileset">fileset</A></CODE></TD>
209</TR>
210</TABLE>
211&nbsp;<A NAME="fields_inherited_from_class_org.apache.tools.ant.Task"><!-- --></A>
212<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
213<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
214<TD><B>Fields inherited from class org.apache.tools.ant.<A HREF="../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A></B></TD>
215</TR>
216<TR BGCOLOR="white" CLASS="TableRowColor">
217<TD><CODE><A HREF="../../../../../org/apache/tools/ant/Task.html#description">description</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#location">location</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#target">target</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#taskName">taskName</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#taskType">taskType</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#wrapper">wrapper</A></CODE></TD>
218</TR>
219</TABLE>
220&nbsp;<A NAME="fields_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></A>
221<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
222<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
223<TD><B>Fields inherited from class org.apache.tools.ant.<A HREF="../../../../../org/apache/tools/ant/ProjectComponent.html" title="class in org.apache.tools.ant">ProjectComponent</A></B></TD>
224</TR>
225<TR BGCOLOR="white" CLASS="TableRowColor">
226<TD><CODE><A HREF="../../../../../org/apache/tools/ant/ProjectComponent.html#project">project</A></CODE></TD>
227</TR>
228</TABLE>
229&nbsp;
230<!-- ======== CONSTRUCTOR SUMMARY ======== -->
231
232<A NAME="constructor_summary"><!-- --></A>
233<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
234<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
235<TD COLSPAN=2><FONT SIZE="+2">
236<B>Constructor Summary</B></FONT></TD>
237</TR>
238<TR BGCOLOR="white" CLASS="TableRowColor">
239<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Tar.html#Tar()">Tar</A></B>()</CODE>
240
241<BR>
242&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
243</TR>
244</TABLE>
245&nbsp;
246<!-- ========== METHOD SUMMARY =========== -->
247
248<A NAME="method_summary"><!-- --></A>
249<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
250<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
251<TD COLSPAN=2><FONT SIZE="+2">
252<B>Method Summary</B></FONT></TD>
253</TR>
254<TR BGCOLOR="white" CLASS="TableRowColor">
255<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
256<CODE>protected &nbsp;boolean</CODE></FONT></TD>
257<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Tar.html#archiveIsUpToDate(java.lang.String[])">archiveIsUpToDate</A></B>(java.lang.String[]&nbsp;files)</CODE>
258
259<BR>
260&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;<I>use the two-arg version instead.</I></TD>
261</TR>
262<TR BGCOLOR="white" CLASS="TableRowColor">
263<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
264<CODE>protected &nbsp;boolean</CODE></FONT></TD>
265<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Tar.html#archiveIsUpToDate(java.lang.String[], java.io.File)">archiveIsUpToDate</A></B>(java.lang.String[]&nbsp;files,
266 java.io.File&nbsp;dir)</CODE>
267
268<BR>
269&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Is the archive up to date in relationship to a list of files.</TD>
270</TR>
271<TR BGCOLOR="white" CLASS="TableRowColor">
272<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
273<CODE>&nbsp;<A HREF="../../../../../org/apache/tools/ant/taskdefs/Tar.TarFileSet.html" title="class in org.apache.tools.ant.taskdefs">Tar.TarFileSet</A></CODE></FONT></TD>
274<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Tar.html#createTarFileSet()">createTarFileSet</A></B>()</CODE>
275
276<BR>
277&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Add a new fileset with the option to specify permissions</TD>
278</TR>
279<TR BGCOLOR="white" CLASS="TableRowColor">
280<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
281<CODE>&nbsp;void</CODE></FONT></TD>
282<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Tar.html#execute()">execute</A></B>()</CODE>
283
284<BR>
285&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;do the business</TD>
286</TR>
287<TR BGCOLOR="white" CLASS="TableRowColor">
288<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
289<CODE>&nbsp;void</CODE></FONT></TD>
290<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Tar.html#setBasedir(java.io.File)">setBasedir</A></B>(java.io.File&nbsp;baseDir)</CODE>
291
292<BR>
293&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This is the base directory to look in for things to tar.</TD>
294</TR>
295<TR BGCOLOR="white" CLASS="TableRowColor">
296<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
297<CODE>&nbsp;void</CODE></FONT></TD>
298<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Tar.html#setCompression(org.apache.tools.ant.taskdefs.Tar.TarCompressionMethod)">setCompression</A></B>(<A HREF="../../../../../org/apache/tools/ant/taskdefs/Tar.TarCompressionMethod.html" title="class in org.apache.tools.ant.taskdefs">Tar.TarCompressionMethod</A>&nbsp;mode)</CODE>
299
300<BR>
301&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set compression method.</TD>
302</TR>
303<TR BGCOLOR="white" CLASS="TableRowColor">
304<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
305<CODE>&nbsp;void</CODE></FONT></TD>
306<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Tar.html#setDestFile(java.io.File)">setDestFile</A></B>(java.io.File&nbsp;destFile)</CODE>
307
308<BR>
309&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set is the name/location of where to create the tar file.</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/ant/taskdefs/Tar.html#setLongfile(java.lang.String)">setLongfile</A></B>(java.lang.String&nbsp;mode)</CODE>
315
316<BR>
317&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;<I>setLongFile(String) is deprecated and is replaced with
318 setLongFile(Tar.TarLongFileMode) to make Ant's Introspection
319 mechanism do the work and also to encapsulate operations on
320 the mode in its own class.</I></TD>
321</TR>
322<TR BGCOLOR="white" CLASS="TableRowColor">
323<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
324<CODE>&nbsp;void</CODE></FONT></TD>
325<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Tar.html#setLongfile(org.apache.tools.ant.taskdefs.Tar.TarLongFileMode)">setLongfile</A></B>(<A HREF="../../../../../org/apache/tools/ant/taskdefs/Tar.TarLongFileMode.html" title="class in org.apache.tools.ant.taskdefs">Tar.TarLongFileMode</A>&nbsp;mode)</CODE>
326
327<BR>
328&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set how to handle long files, those with a path&gt;100 chars.</TD>
329</TR>
330<TR BGCOLOR="white" CLASS="TableRowColor">
331<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
332<CODE>&nbsp;void</CODE></FONT></TD>
333<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Tar.html#setTarfile(java.io.File)">setTarfile</A></B>(java.io.File&nbsp;tarFile)</CODE>
334
335<BR>
336&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;<I>for consistency with other tasks, please use setDestFile()</I></TD>
337</TR>
338<TR BGCOLOR="white" CLASS="TableRowColor">
339<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
340<CODE>protected &nbsp;void</CODE></FONT></TD>
341<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Tar.html#tarFile(java.io.File, org.apache.tools.tar.TarOutputStream, java.lang.String, org.apache.tools.ant.taskdefs.Tar.TarFileSet)">tarFile</A></B>(java.io.File&nbsp;file,
342 <A HREF="../../../../../org/apache/tools/tar/TarOutputStream.html" title="class in org.apache.tools.tar">TarOutputStream</A>&nbsp;tOut,
343 java.lang.String&nbsp;vPath,
344 <A HREF="../../../../../org/apache/tools/ant/taskdefs/Tar.TarFileSet.html" title="class in org.apache.tools.ant.taskdefs">Tar.TarFileSet</A>&nbsp;tarFileSet)</CODE>
345
346<BR>
347&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;tar a file</TD>
348</TR>
349</TABLE>
350&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.taskdefs.MatchingTask"><!-- --></A>
351<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
352<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
353<TD><B>Methods inherited from class org.apache.tools.ant.taskdefs.<A HREF="../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html" title="class in org.apache.tools.ant.taskdefs">MatchingTask</A></B></TD>
354</TR>
355<TR BGCOLOR="white" CLASS="TableRowColor">
356<TD><CODE><A HREF="../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#add(org.apache.tools.ant.types.selectors.FileSelector)">add</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#addAnd(org.apache.tools.ant.types.selectors.AndSelector)">addAnd</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#addContains(org.apache.tools.ant.types.selectors.ContainsSelector)">addContains</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#addContainsRegexp(org.apache.tools.ant.types.selectors.ContainsRegexpSelector)">addContainsRegexp</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#addCustom(org.apache.tools.ant.types.selectors.ExtendSelector)">addCustom</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#addDate(org.apache.tools.ant.types.selectors.DateSelector)">addDate</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#addDepend(org.apache.tools.ant.types.selectors.DependSelector)">addDepend</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#addDepth(org.apache.tools.ant.types.selectors.DepthSelector)">addDepth</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#addDifferent(org.apache.tools.ant.types.selectors.DifferentSelector)">addDifferent</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#addFilename(org.apache.tools.ant.types.selectors.FilenameSelector)">addFilename</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#addMajority(org.apache.tools.ant.types.selectors.MajoritySelector)">addMajority</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#addModified(org.apache.tools.ant.types.selectors.modifiedselector.ModifiedSelector)">addModified</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#addNone(org.apache.tools.ant.types.selectors.NoneSelector)">addNone</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#addNot(org.apache.tools.ant.types.selectors.NotSelector)">addNot</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#addOr(org.apache.tools.ant.types.selectors.OrSelector)">addOr</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#addPresent(org.apache.tools.ant.types.selectors.PresentSelector)">addPresent</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#addSelector(org.apache.tools.ant.types.selectors.SelectSelector)">addSelector</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#addSize(org.apache.tools.ant.types.selectors.SizeSelector)">addSize</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#addType(org.apache.tools.ant.types.selectors.TypeSelector)">addType</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#appendSelector(org.apache.tools.ant.types.selectors.FileSelector)">appendSelector</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#createExclude()">createExclude</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#createExcludesFile()">createExcludesFile</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#createInclude()">createInclude</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#createIncludesFile()">createIncludesFile</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#createPatternSet()">createPatternSet</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#getDirectoryScanner(java.io.File)">getDirectoryScanner</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#getImplicitFileSet()">getImplicitFileSet</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#getSelectors(org.apache.tools.ant.Project)">getSelectors</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#hasSelectors()">hasSelectors</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#selectorCount()">selectorCount</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#selectorElements()">selectorElements</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#setCaseSensitive(boolean)">setCaseSensitive</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#setDefaultexcludes(boolean)">setDefaultexcludes</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#setExcludes(java.lang.String)">setExcludes</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#setExcludesfile(java.io.File)">setExcludesfile</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#setFollowSymlinks(boolean)">setFollowSymlinks</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#setIncludes(java.lang.String)">setIncludes</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#setIncludesfile(java.io.File)">setIncludesfile</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#setProject(org.apache.tools.ant.Project)">setProject</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#XsetIgnore(java.lang.String)">XsetIgnore</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#XsetItems(java.lang.String)">XsetItems</A></CODE></TD>
357</TR>
358</TABLE>
359&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.Task"><!-- --></A>
360<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
361<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
362<TD><B>Methods inherited from class org.apache.tools.ant.<A HREF="../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A></B></TD>
363</TR>
364<TR BGCOLOR="white" CLASS="TableRowColor">
365<TD><CODE><A HREF="../../../../../org/apache/tools/ant/Task.html#getDescription()">getDescription</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#getLocation()">getLocation</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#getOwningTarget()">getOwningTarget</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#getRuntimeConfigurableWrapper()">getRuntimeConfigurableWrapper</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#getTaskName()">getTaskName</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#getTaskType()">getTaskType</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#getWrapper()">getWrapper</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#handleErrorFlush(java.lang.String)">handleErrorFlush</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#handleErrorOutput(java.lang.String)">handleErrorOutput</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#handleFlush(java.lang.String)">handleFlush</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#handleInput(byte[], int, int)">handleInput</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#handleOutput(java.lang.String)">handleOutput</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#init()">init</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#isInvalid()">isInvalid</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#log(java.lang.String)">log</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#log(java.lang.String, int)">log</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#maybeConfigure()">maybeConfigure</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#perform()">perform</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#reconfigure()">reconfigure</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#setDescription(java.lang.String)">setDescription</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#setLocation(org.apache.tools.ant.Location)">setLocation</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#setOwningTarget(org.apache.tools.ant.Target)">setOwningTarget</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#setRuntimeConfigurableWrapper(org.apache.tools.ant.RuntimeConfigurable)">setRuntimeConfigurableWrapper</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#setTaskName(java.lang.String)">setTaskName</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#setTaskType(java.lang.String)">setTaskType</A></CODE></TD>
366</TR>
367</TABLE>
368&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></A>
369<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
370<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
371<TD><B>Methods inherited from class org.apache.tools.ant.<A HREF="../../../../../org/apache/tools/ant/ProjectComponent.html" title="class in org.apache.tools.ant">ProjectComponent</A></B></TD>
372</TR>
373<TR BGCOLOR="white" CLASS="TableRowColor">
374<TD><CODE><A HREF="../../../../../org/apache/tools/ant/ProjectComponent.html#getProject()">getProject</A></CODE></TD>
375</TR>
376</TABLE>
377&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
378<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
379<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
380<TD><B>Methods inherited from class java.lang.Object</B></TD>
381</TR>
382<TR BGCOLOR="white" CLASS="TableRowColor">
383<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
384</TR>
385</TABLE>
386&nbsp;
387<P>
388
389<!-- ============ FIELD DETAIL =========== -->
390
391<A NAME="field_detail"><!-- --></A>
392<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
393<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
394<TD COLSPAN=1><FONT SIZE="+2">
395<B>Field Detail</B></FONT></TD>
396</TR>
397</TABLE>
398
399<A NAME="WARN"><!-- --></A><H3>
400WARN</H3>
401<PRE>
402public static final java.lang.String <B>WARN</B></PRE>
403<DL>
404<DD><B>Deprecated.</B>&nbsp;<I>Tar.WARN is deprecated and is replaced with
405 Tar.TarLongFileMode.WARN</I>
406<P>
407<DL>
408<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.tools.ant.taskdefs.Tar.WARN">Constant Field Values</A></DL>
409</DL>
410<HR>
411
412<A NAME="FAIL"><!-- --></A><H3>
413FAIL</H3>
414<PRE>
415public static final java.lang.String <B>FAIL</B></PRE>
416<DL>
417<DD><B>Deprecated.</B>&nbsp;<I>Tar.FAIL is deprecated and is replaced with
418 Tar.TarLongFileMode.FAIL</I>
419<P>
420<DL>
421<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.tools.ant.taskdefs.Tar.FAIL">Constant Field Values</A></DL>
422</DL>
423<HR>
424
425<A NAME="TRUNCATE"><!-- --></A><H3>
426TRUNCATE</H3>
427<PRE>
428public static final java.lang.String <B>TRUNCATE</B></PRE>
429<DL>
430<DD><B>Deprecated.</B>&nbsp;<I>Tar.TRUNCATE is deprecated and is replaced with
431 Tar.TarLongFileMode.TRUNCATE</I>
432<P>
433<DL>
434<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.tools.ant.taskdefs.Tar.TRUNCATE">Constant Field Values</A></DL>
435</DL>
436<HR>
437
438<A NAME="GNU"><!-- --></A><H3>
439GNU</H3>
440<PRE>
441public static final java.lang.String <B>GNU</B></PRE>
442<DL>
443<DD><B>Deprecated.</B>&nbsp;<I>Tar.GNU is deprecated and is replaced with
444 Tar.TarLongFileMode.GNU</I>
445<P>
446<DL>
447<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.tools.ant.taskdefs.Tar.GNU">Constant Field Values</A></DL>
448</DL>
449<HR>
450
451<A NAME="OMIT"><!-- --></A><H3>
452OMIT</H3>
453<PRE>
454public static final java.lang.String <B>OMIT</B></PRE>
455<DL>
456<DD><B>Deprecated.</B>&nbsp;<I>Tar.OMIT is deprecated and is replaced with
457 Tar.TarLongFileMode.OMIT</I>
458<P>
459<DL>
460<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.tools.ant.taskdefs.Tar.OMIT">Constant Field Values</A></DL>
461</DL>
462
463<!-- ========= CONSTRUCTOR DETAIL ======== -->
464
465<A NAME="constructor_detail"><!-- --></A>
466<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
467<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
468<TD COLSPAN=1><FONT SIZE="+2">
469<B>Constructor Detail</B></FONT></TD>
470</TR>
471</TABLE>
472
473<A NAME="Tar()"><!-- --></A><H3>
474Tar</H3>
475<PRE>
476public <B>Tar</B>()</PRE>
477<DL>
478</DL>
479
480<!-- ============ METHOD DETAIL ========== -->
481
482<A NAME="method_detail"><!-- --></A>
483<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
484<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
485<TD COLSPAN=1><FONT SIZE="+2">
486<B>Method Detail</B></FONT></TD>
487</TR>
488</TABLE>
489
490<A NAME="createTarFileSet()"><!-- --></A><H3>
491createTarFileSet</H3>
492<PRE>
493public <A HREF="../../../../../org/apache/tools/ant/taskdefs/Tar.TarFileSet.html" title="class in org.apache.tools.ant.taskdefs">Tar.TarFileSet</A> <B>createTarFileSet</B>()</PRE>
494<DL>
495<DD>Add a new fileset with the option to specify permissions
496<P>
497<DD><DL>
498
499<DT><B>Returns:</B><DD>the tar fileset to be used as the nested element.</DL>
500</DD>
501</DL>
502<HR>
503
504<A NAME="setTarfile(java.io.File)"><!-- --></A><H3>
505setTarfile</H3>
506<PRE>
507public void <B>setTarfile</B>(java.io.File&nbsp;tarFile)</PRE>
508<DL>
509<DD><B>Deprecated.</B>&nbsp;<I>for consistency with other tasks, please use setDestFile()</I>
510<P>
511<DD>Set is the name/location of where to create the tar file.
512<P>
513<DD><DL>
514<DT><B>Parameters:</B><DD><CODE>tarFile</CODE> - the location of the tar file.</DL>
515</DD>
516</DL>
517<HR>
518
519<A NAME="setDestFile(java.io.File)"><!-- --></A><H3>
520setDestFile</H3>
521<PRE>
522public void <B>setDestFile</B>(java.io.File&nbsp;destFile)</PRE>
523<DL>
524<DD>Set is the name/location of where to create the tar file.
525<P>
526<DD><DL>
527<DT><B>Parameters:</B><DD><CODE>destFile</CODE> - The output of the tar<DT><B>Since:</B></DT>
528 <DD>Ant 1.5</DD>
529</DL>
530</DD>
531</DL>
532<HR>
533
534<A NAME="setBasedir(java.io.File)"><!-- --></A><H3>
535setBasedir</H3>
536<PRE>
537public void <B>setBasedir</B>(java.io.File&nbsp;baseDir)</PRE>
538<DL>
539<DD>This is the base directory to look in for things to tar.
540<P>
541<DD><DL>
542<DT><B>Parameters:</B><DD><CODE>baseDir</CODE> - the base directory.</DL>
543</DD>
544</DL>
545<HR>
546
547<A NAME="setLongfile(java.lang.String)"><!-- --></A><H3>
548setLongfile</H3>
549<PRE>
550public void <B>setLongfile</B>(java.lang.String&nbsp;mode)</PRE>
551<DL>
552<DD><B>Deprecated.</B>&nbsp;<I>setLongFile(String) is deprecated and is replaced with
553 setLongFile(Tar.TarLongFileMode) to make Ant's Introspection
554 mechanism do the work and also to encapsulate operations on
555 the mode in its own class.</I>
556<P>
557<DD>Set how to handle long files, those with a path&gt;100 chars.
558 Optional, default=warn.
559 <p>
560 Allowable values are
561 <ul>
562 <li> truncate - paths are truncated to the maximum length
563 <li> fail - paths greater than the maximum cause a build exception
564 <li> warn - paths greater than the maximum cause a warning and GNU is used
565 <li> gnu - GNU extensions are used for any paths greater than the maximum.
566 <li> omit - paths greater than the maximum are omitted from the archive
567 </ul>
568<P>
569<DD><DL>
570<DT><B>Parameters:</B><DD><CODE>mode</CODE> - the mode string to handle long files.</DL>
571</DD>
572</DL>
573<HR>
574
575<A NAME="setLongfile(org.apache.tools.ant.taskdefs.Tar.TarLongFileMode)"><!-- --></A><H3>
576setLongfile</H3>
577<PRE>
578public void <B>setLongfile</B>(<A HREF="../../../../../org/apache/tools/ant/taskdefs/Tar.TarLongFileMode.html" title="class in org.apache.tools.ant.taskdefs">Tar.TarLongFileMode</A>&nbsp;mode)</PRE>
579<DL>
580<DD>Set how to handle long files, those with a path&gt;100 chars.
581 Optional, default=warn.
582 <p>
583 Allowable values are
584 <ul>
585 <li> truncate - paths are truncated to the maximum length
586 <li> fail - paths greater than the maximum cause a build exception
587 <li> warn - paths greater than the maximum cause a warning and GNU is used
588 <li> gnu - GNU extensions are used for any paths greater than the maximum.
589 <li> omit - paths greater than the maximum are omitted from the archive
590 </ul>
591<P>
592<DD><DL>
593<DT><B>Parameters:</B><DD><CODE>mode</CODE> - the mode to handle long file names.</DL>
594</DD>
595</DL>
596<HR>
597
598<A NAME="setCompression(org.apache.tools.ant.taskdefs.Tar.TarCompressionMethod)"><!-- --></A><H3>
599setCompression</H3>
600<PRE>
601public void <B>setCompression</B>(<A HREF="../../../../../org/apache/tools/ant/taskdefs/Tar.TarCompressionMethod.html" title="class in org.apache.tools.ant.taskdefs">Tar.TarCompressionMethod</A>&nbsp;mode)</PRE>
602<DL>
603<DD>Set compression method.
604 Allowable values are
605 <ul>
606 <li> none - no compression
607 <li> gzip - Gzip compression
608 <li> bzip2 - Bzip2 compression
609 </ul>
610<P>
611<DD><DL>
612<DT><B>Parameters:</B><DD><CODE>mode</CODE> - the compression method.</DL>
613</DD>
614</DL>
615<HR>
616
617<A NAME="execute()"><!-- --></A><H3>
618execute</H3>
619<PRE>
620public void <B>execute</B>()
621 throws <A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
622<DL>
623<DD>do the business
624<P>
625<DD><DL>
626<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../org/apache/tools/ant/Task.html#execute()">execute</A></CODE> in class <CODE><A HREF="../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A></CODE></DL>
627</DD>
628<DD><DL>
629
630<DT><B>Throws:</B>
631<DD><CODE><A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - on error</DL>
632</DD>
633</DL>
634<HR>
635
636<A NAME="tarFile(java.io.File, org.apache.tools.tar.TarOutputStream, java.lang.String, org.apache.tools.ant.taskdefs.Tar.TarFileSet)"><!-- --></A><H3>
637tarFile</H3>
638<PRE>
639protected void <B>tarFile</B>(java.io.File&nbsp;file,
640 <A HREF="../../../../../org/apache/tools/tar/TarOutputStream.html" title="class in org.apache.tools.tar">TarOutputStream</A>&nbsp;tOut,
641 java.lang.String&nbsp;vPath,
642 <A HREF="../../../../../org/apache/tools/ant/taskdefs/Tar.TarFileSet.html" title="class in org.apache.tools.ant.taskdefs">Tar.TarFileSet</A>&nbsp;tarFileSet)
643 throws java.io.IOException</PRE>
644<DL>
645<DD>tar a file
646<P>
647<DD><DL>
648<DT><B>Parameters:</B><DD><CODE>file</CODE> - the file to tar<DD><CODE>tOut</CODE> - the output stream<DD><CODE>vPath</CODE> - the path name of the file to tar<DD><CODE>tarFileSet</CODE> - the fileset that the file came from.
649<DT><B>Throws:</B>
650<DD><CODE>java.io.IOException</CODE> - on error</DL>
651</DD>
652</DL>
653<HR>
654
655<A NAME="archiveIsUpToDate(java.lang.String[])"><!-- --></A><H3>
656archiveIsUpToDate</H3>
657<PRE>
658protected boolean <B>archiveIsUpToDate</B>(java.lang.String[]&nbsp;files)</PRE>
659<DL>
660<DD><B>Deprecated.</B>&nbsp;<I>use the two-arg version instead.</I>
661<P>
662<DD>Is the archive up to date in relationship to a list of files.
663<P>
664<DD><DL>
665<DT><B>Parameters:</B><DD><CODE>files</CODE> - the files to check
666<DT><B>Returns:</B><DD>true if the archive is up to date.</DL>
667</DD>
668</DL>
669<HR>
670
671<A NAME="archiveIsUpToDate(java.lang.String[], java.io.File)"><!-- --></A><H3>
672archiveIsUpToDate</H3>
673<PRE>
674protected boolean <B>archiveIsUpToDate</B>(java.lang.String[]&nbsp;files,
675 java.io.File&nbsp;dir)</PRE>
676<DL>
677<DD>Is the archive up to date in relationship to a list of files.
678<P>
679<DD><DL>
680<DT><B>Parameters:</B><DD><CODE>files</CODE> - the files to check<DD><CODE>dir</CODE> - the base directory for the files.
681<DT><B>Returns:</B><DD>true if the archive is up to date.<DT><B>Since:</B></DT>
682 <DD>Ant 1.5.2</DD>
683</DL>
684</DD>
685</DL>
686<!-- ========= END OF CLASS DATA ========= -->
687<HR>
688
689
690<!-- ======= START OF BOTTOM NAVBAR ====== -->
691<A NAME="navbar_bottom"><!-- --></A>
692<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
693<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
694<TR>
695<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
696<A NAME="navbar_bottom_firstrow"><!-- --></A>
697<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
698 <TR ALIGN="center" VALIGN="top">
699 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
700 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
701 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
702 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
703 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
704 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
705 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
706 </TR>
707</TABLE>
708</TD>
709<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
710</EM>
711</TD>
712</TR>
713
714<TR>
715<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
716&nbsp;<A HREF="../../../../../org/apache/tools/ant/taskdefs/Sync.MyCopy.html" title="class in org.apache.tools.ant.taskdefs"><B>PREV CLASS</B></A>&nbsp;
717&nbsp;<A HREF="../../../../../org/apache/tools/ant/taskdefs/Tar.TarCompressionMethod.html" title="class in org.apache.tools.ant.taskdefs"><B>NEXT CLASS</B></A></FONT></TD>
718<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
719 <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
720&nbsp;<A HREF="Tar.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
721&nbsp;<SCRIPT type="text/javascript">
722 <!--
723 if(window==top) {
724 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
725 }
726 //-->
727</SCRIPT>
728<NOSCRIPT>
729 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
730</NOSCRIPT>
731
732</FONT></TD>
733</TR>
734<TR>
735<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
736 SUMMARY:&nbsp;<A HREF="#nested_class_summary">NESTED</A>&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>
737<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
738DETAIL:&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>
739</TR>
740</TABLE>
741<A NAME="skip-navbar_bottom"></A>
742<!-- ======== END OF BOTTOM NAVBAR ======= -->
743
744<HR>
745Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.
746</BODY>
747</HTML>
Note: See TracBrowser for help on using the repository browser.