From 3b2f961a606c16c1b60d265a8edd687beed5471d Mon Sep 17 00:00:00 2001 From: Stephane Bailliez Date: Sun, 25 Nov 2001 16:01:57 +0000 Subject: [PATCH] tstamp now supports a timezone attribute for a custom format. PR: 5000 Reported by: max@eos.dk (Max Rydahl Andersen) git-svn-id: https://svn.apache.org/repos/asf/ant/core/trunk@270005 13f79535-47bb-0310-9956-ffa450edef68 --- docs/manual/CoreTasks/tstamp.html | 17 ++- .../org/apache/tools/ant/taskdefs/Tstamp.java | 20 +++- .../apache/tools/ant/taskdefs/TStampTest.java | 103 ++++++++++++++++++ 3 files changed, 128 insertions(+), 12 deletions(-) create mode 100644 src/testcases/org/apache/tools/ant/taskdefs/TStampTest.java diff --git a/docs/manual/CoreTasks/tstamp.html b/docs/manual/CoreTasks/tstamp.html index d98855aa7..4e01fa813 100644 --- a/docs/manual/CoreTasks/tstamp.html +++ b/docs/manual/CoreTasks/tstamp.html @@ -35,8 +35,8 @@ probably in an initialization target.

Nested Elements

The Tstamp task supports a <format> 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 -SimpleDateFormat class. +The date/time patterns are as defined in the Java +SimpleDateFormat class. The format element also allows offsets to be applied to the time to generate different time values.

@@ -57,6 +57,11 @@ The format element also allows offsets to be applied to the time to generate dif + + + + + @@ -84,7 +89,7 @@ The format element also allows offsets to be applied to the time to generate dif @@ -112,10 +117,10 @@ using English locale (eg. 21-May-2001).

   <tstamp>
-      <format property="touch.time" pattern="MM/dd/yyyy hh:mm aa" 
+      <format property="touch.time" pattern="MM/dd/yyyy hh:mm aa"
               offset="-5" unit="hour"/>
-  </tstamp> 
-
+ </tstamp> +

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

diff --git a/src/main/org/apache/tools/ant/taskdefs/Tstamp.java b/src/main/org/apache/tools/ant/taskdefs/Tstamp.java index df38a3e21..dd887a6bf 100644 --- a/src/main/org/apache/tools/ant/taskdefs/Tstamp.java +++ b/src/main/org/apache/tools/ant/taskdefs/Tstamp.java @@ -66,6 +66,7 @@ import java.util.Enumeration; import java.util.Calendar; import java.util.StringTokenizer; import java.util.NoSuchElementException; +import java.util.TimeZone; import java.text.SimpleDateFormat; /** @@ -77,7 +78,7 @@ import java.text.SimpleDateFormat; * @author conor@cognet.com.au */ public class Tstamp extends Task { - + private Vector customFormats = new Vector(); public void execute() throws BuildException { @@ -92,18 +93,18 @@ public class Tstamp extends Task { SimpleDateFormat today = new SimpleDateFormat ("MMMM d yyyy", Locale.US); project.setProperty("TODAY", today.format(d)); - + Enumeration i = customFormats.elements(); while(i.hasMoreElements()) { CustomFormat cts = (CustomFormat)i.nextElement(); cts.execute(project,d, location); } - + } catch (Exception e) { throw new BuildException(e); } } - + public CustomFormat createFormat() { CustomFormat cts = new CustomFormat(); @@ -113,6 +114,7 @@ public class Tstamp extends Task { public class CustomFormat { + private TimeZone timeZone; private String propertyName; private String pattern; private String language; @@ -157,7 +159,11 @@ public class Tstamp extends Task { throw new BuildException( "bad locale format", e, getLocation()); } } - + + public void setTimezone(String id){ + timeZone = TimeZone.getTimeZone(id); + } + public void setOffset(int offset) { this.offset = offset; } @@ -218,7 +224,9 @@ public class Tstamp extends Task { calendar.add(field, offset); date = calendar.getTime(); } - + if (timeZone != null){ + sdf.setTimeZone(timeZone); + } project.setProperty(propertyName, sdf.format(date)); } } diff --git a/src/testcases/org/apache/tools/ant/taskdefs/TStampTest.java b/src/testcases/org/apache/tools/ant/taskdefs/TStampTest.java new file mode 100644 index 000000000..f9317814c --- /dev/null +++ b/src/testcases/org/apache/tools/ant/taskdefs/TStampTest.java @@ -0,0 +1,103 @@ +/* + * The Apache Software License, Version 1.1 + * + * Copyright (c) 2001 The Apache Software Foundation. All rights + * reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in + * the documentation and/or other materials provided with the + * distribution. + * + * 3. The end-user documentation included with the redistribution, if + * any, must include the following acknowlegement: + * "This product includes software developed by the + * Apache Software Foundation (http://www.apache.org/)." + * Alternately, this acknowlegement may appear in the software itself, + * if and wherever such third-party acknowlegements normally appear. + * + * 4. The names "The Jakarta Project", "Ant", and "Apache Software + * Foundation" must not be used to endorse or promote products derived + * from this software without prior written permission. For written + * permission, please contact apache@apache.org. + * + * 5. Products derived from this software may not be called "Apache" + * nor may "Apache" appear in their names without prior written + * permission of the Apache Group. + * + * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED + * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE + * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR + * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT + * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF + * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND + * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, + * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT + * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + * ==================================================================== + * + * This software consists of voluntary contributions made by many + * individuals on behalf of the Apache Software Foundation. For more + * information on the Apache Software Foundation, please see + * . + */ +package org.apache.tools.ant.taskdefs; + +import java.util.Calendar; +import java.util.TimeZone; +import java.util.Date; +import java.text.SimpleDateFormat; + +import junit.framework.TestCase; +import org.apache.tools.ant.Project; +import org.apache.tools.ant.Location; + +/** + * + * @author Stephane Bailliez + */ +public class TStampTest extends TestCase { + + protected Tstamp tstamp; + protected Project project; + protected Location location; + + public TStampTest(String s) { + super(s); + } + + protected void setUp() throws Exception { + location = new Location("test.xml"); + project = new Project(); + tstamp = new Tstamp(); + tstamp.setLocation(location); + tstamp.setProject(project); + } + + public void testTimeZone() throws Exception { + Tstamp.CustomFormat format = tstamp.createFormat(); + format.setProperty("today"); + format.setPattern("HH:mm:ss z"); + format.setTimezone("GMT"); + Date date = Calendar.getInstance().getTime(); + format.execute(project, date, location); + String today = project.getProperty("today"); + + SimpleDateFormat sdf = new SimpleDateFormat("HH:mm:ss z"); + sdf.setTimeZone( TimeZone.getTimeZone("GMT") ); + String expected = sdf.format(date); + + assertEquals(expected, today); + } + +}
The date/time pattern to be used. The values are as defined by the Java SimpleDateFormat class. Yes
timezoneThe timezone to use for displaying time. The values are as defined by the Java TimeZone class.No
offset The numeric offset to the current timeThe 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 + for the Locale class. No