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

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

initial import of LiRK3
File size: 28.2 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>
7Touch (Apache Ant API)
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.apache.tools.ant.taskdefs.Touch 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="Touch (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/TempFile.html" title="class in org.apache.tools.ant.taskdefs"><B>PREV CLASS</B></A>&nbsp;
53&nbsp;<A HREF="../../../../../org/apache/tools/ant/taskdefs/Transform.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="Touch.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="#fields_inherited_from_class_org.apache.tools.ant.Task">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;FIELD&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 Touch</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"><B>org.apache.tools.ant.taskdefs.Touch</B>
92</PRE>
93<HR>
94<DL>
95<DT>public class <B>Touch</B><DT>extends <A HREF="../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A></DL>
96
97<P>
98Touch a file and/or fileset(s) and/or filelist(s);
99 corresponds to the Unix touch command.
100
101 <p>If the file to touch doesn't exist, an empty one is created.</p>
102<P>
103
104<P>
105<DL>
106<DT><B>Since:</B></DT>
107 <DD>Ant 1.1</DD>
108</DL>
109<HR>
110
111<P>
112<!-- ======== NESTED CLASS SUMMARY ======== -->
113
114
115<!-- =========== FIELD SUMMARY =========== -->
116
117<A NAME="field_summary"><!-- --></A>
118<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
119<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
120<TD COLSPAN=2><FONT SIZE="+2">
121<B>Field Summary</B></FONT></TD>
122</TR>
123</TABLE>
124&nbsp;<A NAME="fields_inherited_from_class_org.apache.tools.ant.Task"><!-- --></A>
125<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
126<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
127<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>
128</TR>
129<TR BGCOLOR="white" CLASS="TableRowColor">
130<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>
131</TR>
132</TABLE>
133&nbsp;<A NAME="fields_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></A>
134<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
135<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
136<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>
137</TR>
138<TR BGCOLOR="white" CLASS="TableRowColor">
139<TD><CODE><A HREF="../../../../../org/apache/tools/ant/ProjectComponent.html#project">project</A></CODE></TD>
140</TR>
141</TABLE>
142&nbsp;
143<!-- ======== CONSTRUCTOR SUMMARY ======== -->
144
145<A NAME="constructor_summary"><!-- --></A>
146<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
147<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
148<TD COLSPAN=2><FONT SIZE="+2">
149<B>Constructor Summary</B></FONT></TD>
150</TR>
151<TR BGCOLOR="white" CLASS="TableRowColor">
152<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Touch.html#Touch()">Touch</A></B>()</CODE>
153
154<BR>
155&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Construct a new <code>Touch</code> task.</TD>
156</TR>
157</TABLE>
158&nbsp;
159<!-- ========== METHOD SUMMARY =========== -->
160
161<A NAME="method_summary"><!-- --></A>
162<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
163<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
164<TD COLSPAN=2><FONT SIZE="+2">
165<B>Method Summary</B></FONT></TD>
166</TR>
167<TR BGCOLOR="white" CLASS="TableRowColor">
168<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
169<CODE>&nbsp;void</CODE></FONT></TD>
170<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Touch.html#add(org.apache.tools.ant.util.FileNameMapper)">add</A></B>(<A HREF="../../../../../org/apache/tools/ant/util/FileNameMapper.html" title="interface in org.apache.tools.ant.util">FileNameMapper</A>&nbsp;fileNameMapper)</CODE>
171
172<BR>
173&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Add a <code>FileNameMapper</code>.</TD>
174</TR>
175<TR BGCOLOR="white" CLASS="TableRowColor">
176<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
177<CODE>&nbsp;void</CODE></FONT></TD>
178<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Touch.html#addConfiguredMapper(org.apache.tools.ant.types.Mapper)">addConfiguredMapper</A></B>(<A HREF="../../../../../org/apache/tools/ant/types/Mapper.html" title="class in org.apache.tools.ant.types">Mapper</A>&nbsp;mapper)</CODE>
179
180<BR>
181&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Add a <code>Mapper</code>.</TD>
182</TR>
183<TR BGCOLOR="white" CLASS="TableRowColor">
184<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
185<CODE>&nbsp;void</CODE></FONT></TD>
186<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Touch.html#addFilelist(org.apache.tools.ant.types.FileList)">addFilelist</A></B>(<A HREF="../../../../../org/apache/tools/ant/types/FileList.html" title="class in org.apache.tools.ant.types">FileList</A>&nbsp;list)</CODE>
187
188<BR>
189&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Add a filelist to touch.</TD>
190</TR>
191<TR BGCOLOR="white" CLASS="TableRowColor">
192<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
193<CODE>&nbsp;void</CODE></FONT></TD>
194<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Touch.html#addFileset(org.apache.tools.ant.types.FileSet)">addFileset</A></B>(<A HREF="../../../../../org/apache/tools/ant/types/FileSet.html" title="class in org.apache.tools.ant.types">FileSet</A>&nbsp;set)</CODE>
195
196<BR>
197&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Add a set of files to touch.</TD>
198</TR>
199<TR BGCOLOR="white" CLASS="TableRowColor">
200<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
201<CODE>protected &nbsp;void</CODE></FONT></TD>
202<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Touch.html#checkConfiguration()">checkConfiguration</A></B>()</CODE>
203
204<BR>
205&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Check that this task has been configured properly.</TD>
206</TR>
207<TR BGCOLOR="white" CLASS="TableRowColor">
208<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
209<CODE>&nbsp;void</CODE></FONT></TD>
210<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Touch.html#execute()">execute</A></B>()</CODE>
211
212<BR>
213&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Execute the touch operation.</TD>
214</TR>
215<TR BGCOLOR="white" CLASS="TableRowColor">
216<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
217<CODE>&nbsp;void</CODE></FONT></TD>
218<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Touch.html#setDatetime(java.lang.String)">setDatetime</A></B>(java.lang.String&nbsp;dateTime)</CODE>
219
220<BR>
221&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the new modification time of file(s) touched
222 in the format &quot;MM/DD/YYYY HH:MM AM <i>or</i> PM&quot;
223 or &quot;MM/DD/YYYY HH:MM:SS AM <i>or</i> PM&quot;.</TD>
224</TR>
225<TR BGCOLOR="white" CLASS="TableRowColor">
226<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
227<CODE>&nbsp;void</CODE></FONT></TD>
228<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Touch.html#setFile(java.io.File)">setFile</A></B>(java.io.File&nbsp;file)</CODE>
229
230<BR>
231&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets a single source file to touch.</TD>
232</TR>
233<TR BGCOLOR="white" CLASS="TableRowColor">
234<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
235<CODE>&nbsp;void</CODE></FONT></TD>
236<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Touch.html#setMillis(long)">setMillis</A></B>(long&nbsp;millis)</CODE>
237
238<BR>
239&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the new modification time of file(s) touched
240 in milliseconds since midnight Jan 1 1970.</TD>
241</TR>
242<TR BGCOLOR="white" CLASS="TableRowColor">
243<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
244<CODE>&nbsp;void</CODE></FONT></TD>
245<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Touch.html#setMkdirs(boolean)">setMkdirs</A></B>(boolean&nbsp;mkdirs)</CODE>
246
247<BR>
248&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set whether nonexistent parent directories should be created
249 when touching new files.</TD>
250</TR>
251<TR BGCOLOR="white" CLASS="TableRowColor">
252<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
253<CODE>&nbsp;void</CODE></FONT></TD>
254<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Touch.html#setPattern(java.lang.String)">setPattern</A></B>(java.lang.String&nbsp;pattern)</CODE>
255
256<BR>
257&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the format of the datetime attribute.</TD>
258</TR>
259<TR BGCOLOR="white" CLASS="TableRowColor">
260<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
261<CODE>&nbsp;void</CODE></FONT></TD>
262<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Touch.html#setVerbose(boolean)">setVerbose</A></B>(boolean&nbsp;verbose)</CODE>
263
264<BR>
265&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set whether the touch task will report every file it creates;
266 defaults to <code>true</code>.</TD>
267</TR>
268<TR BGCOLOR="white" CLASS="TableRowColor">
269<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
270<CODE>protected &nbsp;void</CODE></FONT></TD>
271<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Touch.html#touch()">touch</A></B>()</CODE>
272
273<BR>
274&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Does the actual work; assumes everything has been checked by now.</TD>
275</TR>
276<TR BGCOLOR="white" CLASS="TableRowColor">
277<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
278<CODE>protected &nbsp;void</CODE></FONT></TD>
279<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Touch.html#touch(java.io.File)">touch</A></B>(java.io.File&nbsp;file)</CODE>
280
281<BR>
282&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;<I></I>&nbsp;</TD>
283</TR>
284</TABLE>
285&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.Task"><!-- --></A>
286<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
287<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
288<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>
289</TR>
290<TR BGCOLOR="white" CLASS="TableRowColor">
291<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>
292</TR>
293</TABLE>
294&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></A>
295<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
296<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
297<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>
298</TR>
299<TR BGCOLOR="white" CLASS="TableRowColor">
300<TD><CODE><A HREF="../../../../../org/apache/tools/ant/ProjectComponent.html#getProject()">getProject</A>, <A HREF="../../../../../org/apache/tools/ant/ProjectComponent.html#setProject(org.apache.tools.ant.Project)">setProject</A></CODE></TD>
301</TR>
302</TABLE>
303&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
304<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
305<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
306<TD><B>Methods inherited from class java.lang.Object</B></TD>
307</TR>
308<TR BGCOLOR="white" CLASS="TableRowColor">
309<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
310</TR>
311</TABLE>
312&nbsp;
313<P>
314
315<!-- ============ FIELD DETAIL =========== -->
316
317
318<!-- ========= CONSTRUCTOR DETAIL ======== -->
319
320<A NAME="constructor_detail"><!-- --></A>
321<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
322<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
323<TD COLSPAN=1><FONT SIZE="+2">
324<B>Constructor Detail</B></FONT></TD>
325</TR>
326</TABLE>
327
328<A NAME="Touch()"><!-- --></A><H3>
329Touch</H3>
330<PRE>
331public <B>Touch</B>()</PRE>
332<DL>
333<DD>Construct a new <code>Touch</code> task.
334<P>
335</DL>
336
337<!-- ============ METHOD DETAIL ========== -->
338
339<A NAME="method_detail"><!-- --></A>
340<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
341<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
342<TD COLSPAN=1><FONT SIZE="+2">
343<B>Method Detail</B></FONT></TD>
344</TR>
345</TABLE>
346
347<A NAME="setFile(java.io.File)"><!-- --></A><H3>
348setFile</H3>
349<PRE>
350public void <B>setFile</B>(java.io.File&nbsp;file)</PRE>
351<DL>
352<DD>Sets a single source file to touch. If the file does not exist
353 an empty file will be created.
354<P>
355<DD><DL>
356<DT><B>Parameters:</B><DD><CODE>file</CODE> - the <code>File</code> to touch.</DL>
357</DD>
358</DL>
359<HR>
360
361<A NAME="setMillis(long)"><!-- --></A><H3>
362setMillis</H3>
363<PRE>
364public void <B>setMillis</B>(long&nbsp;millis)</PRE>
365<DL>
366<DD>Set the new modification time of file(s) touched
367 in milliseconds since midnight Jan 1 1970. Optional, default=now.
368<P>
369<DD><DL>
370<DT><B>Parameters:</B><DD><CODE>millis</CODE> - the <code>long</code> timestamp to use.</DL>
371</DD>
372</DL>
373<HR>
374
375<A NAME="setDatetime(java.lang.String)"><!-- --></A><H3>
376setDatetime</H3>
377<PRE>
378public void <B>setDatetime</B>(java.lang.String&nbsp;dateTime)</PRE>
379<DL>
380<DD>Set the new modification time of file(s) touched
381 in the format &quot;MM/DD/YYYY HH:MM AM <i>or</i> PM&quot;
382 or &quot;MM/DD/YYYY HH:MM:SS AM <i>or</i> PM&quot;.
383 Optional, default=now.
384<P>
385<DD><DL>
386<DT><B>Parameters:</B><DD><CODE>dateTime</CODE> - the <code>String</code> date in the specified format.</DL>
387</DD>
388</DL>
389<HR>
390
391<A NAME="setMkdirs(boolean)"><!-- --></A><H3>
392setMkdirs</H3>
393<PRE>
394public void <B>setMkdirs</B>(boolean&nbsp;mkdirs)</PRE>
395<DL>
396<DD>Set whether nonexistent parent directories should be created
397 when touching new files.
398<P>
399<DD><DL>
400<DT><B>Parameters:</B><DD><CODE>mkdirs</CODE> - <code>boolean</code> whether to create parent directories.<DT><B>Since:</B></DT>
401 <DD>Ant 1.6.3</DD>
402</DL>
403</DD>
404</DL>
405<HR>
406
407<A NAME="setVerbose(boolean)"><!-- --></A><H3>
408setVerbose</H3>
409<PRE>
410public void <B>setVerbose</B>(boolean&nbsp;verbose)</PRE>
411<DL>
412<DD>Set whether the touch task will report every file it creates;
413 defaults to <code>true</code>.
414<P>
415<DD><DL>
416<DT><B>Parameters:</B><DD><CODE>verbose</CODE> - <code>boolean</code> flag.<DT><B>Since:</B></DT>
417 <DD>Ant 1.6.3</DD>
418</DL>
419</DD>
420</DL>
421<HR>
422
423<A NAME="setPattern(java.lang.String)"><!-- --></A><H3>
424setPattern</H3>
425<PRE>
426public void <B>setPattern</B>(java.lang.String&nbsp;pattern)</PRE>
427<DL>
428<DD>Set the format of the datetime attribute.
429<P>
430<DD><DL>
431<DT><B>Parameters:</B><DD><CODE>pattern</CODE> - the <code>SimpleDateFormat</code>-compatible format pattern.<DT><B>Since:</B></DT>
432 <DD>Ant 1.6.3</DD>
433</DL>
434</DD>
435</DL>
436<HR>
437
438<A NAME="addConfiguredMapper(org.apache.tools.ant.types.Mapper)"><!-- --></A><H3>
439addConfiguredMapper</H3>
440<PRE>
441public void <B>addConfiguredMapper</B>(<A HREF="../../../../../org/apache/tools/ant/types/Mapper.html" title="class in org.apache.tools.ant.types">Mapper</A>&nbsp;mapper)</PRE>
442<DL>
443<DD>Add a <code>Mapper</code>.
444<P>
445<DD><DL>
446<DT><B>Parameters:</B><DD><CODE>mapper</CODE> - the <code>Mapper</code> to add.<DT><B>Since:</B></DT>
447 <DD>Ant 1.6.3</DD>
448</DL>
449</DD>
450</DL>
451<HR>
452
453<A NAME="add(org.apache.tools.ant.util.FileNameMapper)"><!-- --></A><H3>
454add</H3>
455<PRE>
456public void <B>add</B>(<A HREF="../../../../../org/apache/tools/ant/util/FileNameMapper.html" title="interface in org.apache.tools.ant.util">FileNameMapper</A>&nbsp;fileNameMapper)
457 throws <A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
458<DL>
459<DD>Add a <code>FileNameMapper</code>.
460<P>
461<DD><DL>
462<DT><B>Parameters:</B><DD><CODE>fileNameMapper</CODE> - the <code>FileNameMapper</code> to add.
463<DT><B>Throws:</B>
464<DD><CODE><A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - if multiple mappers are added.<DT><B>Since:</B></DT>
465 <DD>Ant 1.6.3</DD>
466</DL>
467</DD>
468</DL>
469<HR>
470
471<A NAME="addFileset(org.apache.tools.ant.types.FileSet)"><!-- --></A><H3>
472addFileset</H3>
473<PRE>
474public void <B>addFileset</B>(<A HREF="../../../../../org/apache/tools/ant/types/FileSet.html" title="class in org.apache.tools.ant.types">FileSet</A>&nbsp;set)</PRE>
475<DL>
476<DD>Add a set of files to touch.
477<P>
478<DD><DL>
479<DT><B>Parameters:</B><DD><CODE>set</CODE> - the <code>Fileset</code> to add.</DL>
480</DD>
481</DL>
482<HR>
483
484<A NAME="addFilelist(org.apache.tools.ant.types.FileList)"><!-- --></A><H3>
485addFilelist</H3>
486<PRE>
487public void <B>addFilelist</B>(<A HREF="../../../../../org/apache/tools/ant/types/FileList.html" title="class in org.apache.tools.ant.types">FileList</A>&nbsp;list)</PRE>
488<DL>
489<DD>Add a filelist to touch.
490<P>
491<DD><DL>
492<DT><B>Parameters:</B><DD><CODE>list</CODE> - the <code>Filelist</code> to add.</DL>
493</DD>
494</DL>
495<HR>
496
497<A NAME="checkConfiguration()"><!-- --></A><H3>
498checkConfiguration</H3>
499<PRE>
500protected void <B>checkConfiguration</B>()
501 throws <A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
502<DL>
503<DD>Check that this task has been configured properly.
504<P>
505<DD><DL>
506
507<DT><B>Throws:</B>
508<DD><CODE><A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - if configuration errors are detected.<DT><B>Since:</B></DT>
509 <DD>Ant 1.6.3</DD>
510</DL>
511</DD>
512</DL>
513<HR>
514
515<A NAME="execute()"><!-- --></A><H3>
516execute</H3>
517<PRE>
518public void <B>execute</B>()
519 throws <A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
520<DL>
521<DD>Execute the touch operation.
522<P>
523<DD><DL>
524<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>
525</DD>
526<DD><DL>
527
528<DT><B>Throws:</B>
529<DD><CODE><A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - if an error occurs.</DL>
530</DD>
531</DL>
532<HR>
533
534<A NAME="touch()"><!-- --></A><H3>
535touch</H3>
536<PRE>
537protected void <B>touch</B>()
538 throws <A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
539<DL>
540<DD>Does the actual work; assumes everything has been checked by now.
541<P>
542<DD><DL>
543
544<DT><B>Throws:</B>
545<DD><CODE><A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - if an error occurs.</DL>
546</DD>
547</DL>
548<HR>
549
550<A NAME="touch(java.io.File)"><!-- --></A><H3>
551touch</H3>
552<PRE>
553protected void <B>touch</B>(java.io.File&nbsp;file)</PRE>
554<DL>
555<DD><B>Deprecated.</B>&nbsp;<I></I>&nbsp;
556<P>
557<DD>Touch a single file with the current timestamp (this.millis). This method
558 does not interact with any nested mappers and remains for reasons of
559 backwards-compatibility only.
560<P>
561<DD><DL>
562<DT><B>Parameters:</B><DD><CODE>file</CODE> - file to touch
563<DT><B>Throws:</B>
564<DD><CODE><A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE></DL>
565</DD>
566</DL>
567<!-- ========= END OF CLASS DATA ========= -->
568<HR>
569
570
571<!-- ======= START OF BOTTOM NAVBAR ====== -->
572<A NAME="navbar_bottom"><!-- --></A>
573<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
574<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
575<TR>
576<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
577<A NAME="navbar_bottom_firstrow"><!-- --></A>
578<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
579 <TR ALIGN="center" VALIGN="top">
580 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
581 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
582 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
583 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
584 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
585 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
586 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
587 </TR>
588</TABLE>
589</TD>
590<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
591</EM>
592</TD>
593</TR>
594
595<TR>
596<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
597&nbsp;<A HREF="../../../../../org/apache/tools/ant/taskdefs/TempFile.html" title="class in org.apache.tools.ant.taskdefs"><B>PREV CLASS</B></A>&nbsp;
598&nbsp;<A HREF="../../../../../org/apache/tools/ant/taskdefs/Transform.html" title="class in org.apache.tools.ant.taskdefs"><B>NEXT CLASS</B></A></FONT></TD>
599<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
600 <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
601&nbsp;<A HREF="Touch.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
602&nbsp;<SCRIPT type="text/javascript">
603 <!--
604 if(window==top) {
605 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
606 }
607 //-->
608</SCRIPT>
609<NOSCRIPT>
610 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
611</NOSCRIPT>
612
613</FONT></TD>
614</TR>
615<TR>
616<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
617 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#fields_inherited_from_class_org.apache.tools.ant.Task">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
618<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
619DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
620</TR>
621</TABLE>
622<A NAME="skip-navbar_bottom"></A>
623<!-- ======== END OF BOTTOM NAVBAR ======= -->
624
625<HR>
626Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.
627</BODY>
628</HTML>
Note: See TracBrowser for help on using the repository browser.