mirror of
https://github.com/apache/ant.git
synced 2025-05-17 13:35:43 +00:00
93ee07ad35
git-svn-id: https://svn.apache.org/repos/asf/ant/core/trunk@269839 13f79535-47bb-0310-9956-ffa450edef68
129 lines
4.3 KiB
HTML
129 lines
4.3 KiB
HTML
<html>
|
|
|
|
<head>
|
|
<meta http-equiv="Content-Language" content="en-us">
|
|
<title>Apache Ant User Manual</title>
|
|
</head>
|
|
|
|
<body>
|
|
|
|
<h2><a name="tstamp">Tstamp</a></h2>
|
|
|
|
<h3>Description</h3>
|
|
<p>Sets the <code>DSTAMP</code>, <code>TSTAMP</code>, and <code>TODAY</code>
|
|
properties in the current project. The <code>DSTAMP</code> property is in the
|
|
format "yyyymmdd", <code>TSTAMP</code> is in the
|
|
format "hhmm", and <code>TODAY</code> is in the
|
|
format "month day year".</p>
|
|
|
|
<p>These properties can be used in the build-file, for instance, to create
|
|
time-stamped filenames, or used to replace placeholder tags inside documents
|
|
to indicate, for example, the release date. The best place for this task is
|
|
probably in an initialization target.</p>
|
|
|
|
<h3>Parameters</h3>
|
|
<table border="1" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td valign="top"><b>Attribute</b></td>
|
|
<td valign="top"><b>Description</b></td>
|
|
<td align="center" valign="top"><b>Required</b></td>
|
|
</tr>
|
|
<tr> <td colspan="3"> No parameters</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Nested Elements</h3>
|
|
The Tstamp task supports a <code><format></code> nested element that
|
|
allows a property to be set to the current date and time in a given format.
|
|
The date/time patterns are as defined in the Java
|
|
<a href="http://java.sun.com/products/jdk/1.2/docs/api/java/text/SimpleDateFormat.html">SimpleDateFormat</a> class.
|
|
The format element also allows offsets to be applied to the time to generate different time values.
|
|
<br><br>
|
|
<table width="60%" border="1" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td valign="top"><b>Attribute</b></td>
|
|
<td valign="top"><b>Description</b></td>
|
|
<td align="center" valign="top"><b>Required</b></td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top">property</td>
|
|
<td valign="top">
|
|
The property to receive the date/time string in the given pattern.
|
|
</td>
|
|
<td align="center" valign="top">Yes</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top">pattern</td>
|
|
<td valign="top">The date/time pattern to be used. The values are as defined by the Java SimpleDateFormat class.</td>
|
|
<td align="center" valign="top">Yes</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top">offset</td>
|
|
<td valign="top">The numeric offset to the current time</td>
|
|
<td align="center" valign="top">No</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top">unit</td>
|
|
<td valign="top">The unit of the offset to be applied to the current time.
|
|
Valid Values are
|
|
<ul>
|
|
<li>millisecond</li>
|
|
<li>second</li>
|
|
<li>minute</li>
|
|
<li>hour</li>
|
|
<li>day</li>
|
|
<li>week</li>
|
|
<li>month</li>
|
|
<li>year</li>
|
|
</ul>
|
|
</td>
|
|
<td align="center" valign="top">No</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top">locale</td>
|
|
<td valign="top">The locale used to create date/time string. The general
|
|
form is "language, country, variant" but either variant or variant and
|
|
country may be omitted. For more information please refer to documentation
|
|
for the
|
|
<a href="http://java.sun.com/j2se/1.3/docs/api/java/util/Locale.html">Locale</a>
|
|
class.</td>
|
|
<td align="center" valign="top">No</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Examples</h3>
|
|
|
|
<pre>
|
|
<tstamp/>
|
|
</pre>
|
|
|
|
<p>
|
|
sets the standard <code>DSTAMP</code>, <code>TSTAMP</code>,
|
|
and <code>TODAY</code> properties according to the default formats.</p>
|
|
<pre>
|
|
<tstamp>
|
|
<format property="TODAY_UK" pattern="d-MMMM-yyyy" locale="en"/>
|
|
</tstamp>
|
|
</pre>
|
|
<p>
|
|
sets the standard properties as well as the property
|
|
<code>TODAY_UK</code> with the date/time pattern "d-MMMM-yyyy"
|
|
using English locale (eg. 21-May-2001).</p>
|
|
|
|
<pre>
|
|
<tstamp>
|
|
<format property="touch.time" pattern="MM/dd/yyyy hh:mm aa"
|
|
offset="-5" unit="hour"/>
|
|
</tstamp>
|
|
</pre>
|
|
<p>
|
|
Creates a timestamp, in the property touch.time, 5 hours before the current time. The format in this example
|
|
is suitable for use with the <touch> task</p>
|
|
|
|
<hr>
|
|
<p align="center">Copyright © 2000,2001 Apache Software Foundation. All rights Reserved.</p>
|
|
|
|
</body>
|
|
</html>
|
|
|