2006-09-11 04:19:00 +00:00
|
|
|
<!--
|
|
|
|
|
Licensed to the Apache Software Foundation (ASF) under one or more
|
|
|
|
|
contributor license agreements. See the NOTICE file distributed with
|
|
|
|
|
this work for additional information regarding copyright ownership.
|
|
|
|
|
The ASF licenses this file to You under the Apache License, Version 2.0
|
|
|
|
|
(the "License"); you may not use this file except in compliance with
|
|
|
|
|
the License. You may obtain a copy of the License at
|
|
|
|
|
|
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
|
|
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
|
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
|
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
|
|
|
See the License for the specific language governing permissions and
|
|
|
|
|
limitations under the License.
|
|
|
|
|
-->
|
2001-02-13 12:32:01 +00:00
|
|
|
<html>
|
|
|
|
|
|
|
|
|
|
<head>
|
|
|
|
|
<meta http-equiv="Content-Language" content="en-us">
|
2005-04-29 18:58:16 +00:00
|
|
|
<link rel="stylesheet" type="text/css" href="../stylesheets/style.css">
|
2002-02-03 22:00:42 +00:00
|
|
|
<title>Touch Task</title>
|
2001-02-13 12:32:01 +00:00
|
|
|
</head>
|
|
|
|
|
|
|
|
|
|
<body>
|
|
|
|
|
|
2018-01-22 23:52:21 +01:00
|
|
|
<h2 id="touch">Touch</h2>
|
2001-02-13 12:32:01 +00:00
|
|
|
<h3>Description</h3>
|
2005-11-29 04:42:55 +00:00
|
|
|
|
2018-02-28 07:58:59 +01:00
|
|
|
<p>Changes the modification time of a resource and possibly creates it at the same time. In addition
|
|
|
|
|
to working with a single file, this Task can also work
|
|
|
|
|
on <a href="../Types/resources.html">resources</a> and resource collections (which also includes
|
|
|
|
|
directories). Prior to Apache Ant 1.7 only FileSet or <a href="../Types/filelist.html">Filelist</a>
|
|
|
|
|
(<em>since Ant 1.6</em>) were supported.</p>
|
|
|
|
|
|
|
|
|
|
<p>Ant uses the API of <code>java.io.File</code> to set the last modification time which has some
|
|
|
|
|
limitations. For example, the timestamp granularity depends on the operating system and sometimes
|
|
|
|
|
the operating system may allow a granularity smaller than milliseconds. If you need more control
|
|
|
|
|
you have to fall back to the <code><exec></code> task and native commands.</p>
|
|
|
|
|
|
|
|
|
|
<p><em>Since Ant 1.8.2</em>, a warning message is logged upon failure to change the file
|
|
|
|
|
modification time. This will happen if you try to change the modification time of a file you do not
|
|
|
|
|
own on many Unix systems, for example.</p>
|
2010-06-24 07:51:34 +00:00
|
|
|
|
2001-02-13 12:32:01 +00:00
|
|
|
<h3>Parameters</h3>
|
2018-02-28 07:58:59 +01:00
|
|
|
<table class="attr">
|
2001-02-13 12:32:01 +00:00
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<th>Attribute</th>
|
|
|
|
|
<th>Description</th>
|
|
|
|
|
<th>Required</th>
|
2001-02-13 12:32:01 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>file</td>
|
|
|
|
|
<td>The name of the file.</td>
|
|
|
|
|
<td>Unless a nested resource collection element has been specified</td>
|
2001-02-13 12:32:01 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>millis</td>
|
|
|
|
|
<td>Specifies the new modification time of the file in milliseconds since midnight Jan 1
|
|
|
|
|
1970.</td>
|
|
|
|
|
<td rowspan="2">No; <var>datetime</var> takes precedence, however if both are omitted then
|
|
|
|
|
current time is assumed</td>
|
2001-02-13 12:32:01 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>datetime</td>
|
|
|
|
|
<td class="left">Specifies the new modification time of the file. <em>Since Ant 1.8</em>, the
|
|
|
|
|
special value <q>now</q> indicates the current time.</td>
|
2004-12-14 17:56:35 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>pattern</td>
|
|
|
|
|
<td>SimpleDateFormat-compatible pattern string using the current locale. <em>Since Ant
|
|
|
|
|
1.6.3</em></td>
|
|
|
|
|
<td>No; defaults to <q>MM/dd/YYYY hh:mm a</q> or <q>MM/dd/yyyy hh:mm:ss a</q> using the US
|
|
|
|
|
locale.</td>
|
2001-02-13 12:32:01 +00:00
|
|
|
</tr>
|
2004-12-14 17:56:35 +00:00
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>mkdirs</td>
|
|
|
|
|
<td>Whether to create nonexistent parent directories when touching new files. <em>Since Ant
|
|
|
|
|
1.6.3</em></td>
|
|
|
|
|
<td>No; default <q>false</q></td>
|
2004-12-14 17:56:35 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>verbose</td>
|
|
|
|
|
<td>Whether to log the creation of new files. <em>Since Ant 1.6.3</em></td>
|
|
|
|
|
<td>No; default <q>true</q></td>
|
2004-12-14 17:56:35 +00:00
|
|
|
</tr>
|
2001-02-13 12:32:01 +00:00
|
|
|
</table>
|
2004-12-14 17:56:35 +00:00
|
|
|
<h3>Parameters specified as nested elements</h3>
|
2005-11-29 04:42:55 +00:00
|
|
|
<h4>any resource collection</h4>
|
|
|
|
|
|
2018-02-28 07:58:59 +01:00
|
|
|
<p>You can use any number of nested resource collection elements to define the resources for this
|
|
|
|
|
task and refer to resources defined elsewhere. <strong>Note</strong>: resources passed to this task
|
|
|
|
|
must implement the <code>org.apache.tools.ant.types.resources.Touchable</code> interface, this is
|
|
|
|
|
true for all filesystem-based resources like those returned by path, fileset ot filelist.</p>
|
2005-11-29 04:42:55 +00:00
|
|
|
|
2018-02-28 07:58:59 +01:00
|
|
|
<p>For backwards compatibility directories matched by nested filesets will be "touched" as well, use
|
|
|
|
|
a <var>type</var> selector to suppress this. This only applies to filesets nested into the task
|
|
|
|
|
directly, not to filesets nested into a path or any other resource collection.</p>
|
2005-01-22 20:08:55 +00:00
|
|
|
|
|
|
|
|
<h4>mapper</h4>
|
2018-03-08 07:43:53 +01:00
|
|
|
<p><em>Since Ant 1.6.3</em>, a nested <a href="../Types/mapper.html">mapper</a> can be specified.
|
2018-02-28 07:58:59 +01:00
|
|
|
Files specified via nested <code>fileset</code>s, <code>filelist</code>s, or the <code>file</code>
|
|
|
|
|
attribute are mapped using the specified mapper. For each file mapped, the resulting files are
|
|
|
|
|
touched. If no time has been specified and the original file exists its timestamp will be used. If
|
|
|
|
|
no time has been specified and the original file does not exist the current time is used. <em>Since
|
|
|
|
|
Ant 1.8</em>, the task settings (<var>millis</var>, and <var>datetime</var>) have priority over the
|
|
|
|
|
timestamp of the original file.</p>
|
2001-02-13 12:32:01 +00:00
|
|
|
<h3>Examples</h3>
|
2018-02-28 07:58:59 +01:00
|
|
|
|
|
|
|
|
<pre><touch file="myfile"/></pre>
|
|
|
|
|
<p>creates <samp>myfile</samp> if it doesn't exist and changes the modification time to the current
|
|
|
|
|
time.</p>
|
|
|
|
|
|
|
|
|
|
<pre><touch file="myfile" datetime="06/28/2000 2:02 pm"/></pre>
|
|
|
|
|
<p>creates <samp>myfile</samp> if it doesn't exist and changes the modification time to Jun, 28 2000
|
|
|
|
|
2:02 pm (14:02 for those used to 24 hour time).</p>
|
|
|
|
|
|
|
|
|
|
<pre>
|
|
|
|
|
<touch datetime="09/10/1974 4:30 pm">
|
2001-03-29 09:37:12 +00:00
|
|
|
<fileset dir="src_dir"/>
|
2018-02-28 07:58:59 +01:00
|
|
|
</touch></pre>
|
|
|
|
|
<p>changes the modification time to Oct, 09 1974 4:30 pm of all files and directories found
|
|
|
|
|
in <samp>src_dir</samp>.</p>
|
|
|
|
|
|
|
|
|
|
<pre><touch file="myfile" datetime="06/28/2000 2:02:17 pm"/></pre>
|
|
|
|
|
<p>creates <samp>myfile</samp> if it doesn't exist and changes the modification time to Jun, 28 2000
|
|
|
|
|
2:02:17 pm (14:02:17 for those used to 24 hour time), if the filesystem allows a precision of one
|
|
|
|
|
second—a time close to it otherwise.</p>
|
|
|
|
|
|
|
|
|
|
<pre>
|
|
|
|
|
<touch file="foo">
|
|
|
|
|
<mapper type="glob" from="foo" to="bar"/>
|
|
|
|
|
</touch></pre>
|
|
|
|
|
<p>creates <samp>bar</samp> if it doesn't exist and changes the modification time to that
|
|
|
|
|
of <samp>foo</samp>.</p>
|
|
|
|
|
|
|
|
|
|
<pre>
|
|
|
|
|
<touch file="foo" datetime="now">
|
|
|
|
|
<mapper type="regexp" from="^src(.*)\.java" to="shadow\1.empty"/>
|
|
|
|
|
</touch></pre>
|
|
|
|
|
<p>creates files in the <samp>shadow</samp> directory for every <samp>.java</samp> file in
|
|
|
|
|
the <samp>src</samp> directory if it doesn't exist and changes the modification time of those files
|
|
|
|
|
to the current time.</p>
|
2007-09-02 12:53:16 +00:00
|
|
|
|
2001-02-13 12:32:01 +00:00
|
|
|
</body>
|
|
|
|
|
</html>
|
