sbailliez 02/02/05 13:14:28
Added: src/main/org/apache/tools/ant/util DateUtils.java
src/testcases/org/apache/tools/ant/util DateUtilsTest.java
Log:
Helper class to deal with simple ISO8601 time formatting.
Moved elapsed time formatting (minutes/seconds) from DefaultLogger.
Revision Changes Path
1.1
jakarta-ant/src/main/org/apache/tools/ant/util/DateUtils.java
Index: DateUtils.java
===================================================================
/*
* The Apache Software License, Version 1.1
*
* Copyright (c) 2002 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 [EMAIL PROTECTED]
*
* 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
* <http://www.apache.org/>.
*/
package org.apache.tools.ant.util;
import java.text.ChoiceFormat;
import java.text.DateFormat;
import java.text.MessageFormat;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.TimeZone;
/**
* Helper methods to deal with date/time formatting with a specific
* defined format (<a href="http://www.w3.org/TR/NOTE-datetime";>ISO8601</a>)
* or a plurialization correct elapsed time in minutes and seconds.
*
* @author <a href="mailto:[EMAIL PROTECTED]">Stephane Bailliez</a>
*/
public final class DateUtils {
/**
* ISO8601-like pattern for date-time. It does not support timezone.
* <tt>yyyy-MM-ddTHH:mm:ss</tt>
*/
public final static String ISO8601_DATETIME_PATTERN
= "yyyy-MM-dd'T'HH:mm:ss";
/**
* ISO8601-like pattern for date. <tt>yyyy-MM-dd</tt>
*/
public final static String ISO8601_DATE_PATTERN
= "yyyy-MM-dd";
/**
* ISO8601-like pattern for time. <tt>HH:mm:ss</tt>
*/
public final static String ISO8601_TIME_PATTERN
= "HH:mm:ss";
// code from Magesh moved from DefaultLogger and slightly modified
private final static MessageFormat MINUTE_SECONDS
= new MessageFormat("{0}{1}");
private final static double[] LIMITS = {0, 1, 2};
private final static String[] MINUTES_PART =
{"", "1 minute ", "{0,number} minutes "};
private final static String[] SECONDS_PART =
{"0 seconds", "1 second", "{1,number} seconds"};
private final static ChoiceFormat MINUTES_FORMAT =
new ChoiceFormat(LIMITS, MINUTES_PART);
private final static ChoiceFormat SECONDS_FORMAT =
new ChoiceFormat(LIMITS, SECONDS_PART);
static {
MINUTE_SECONDS.setFormat(0, MINUTES_FORMAT);
MINUTE_SECONDS.setFormat(1, SECONDS_FORMAT);
}
/** private constructor */
private DateUtils() {
}
/**
* Format a date/time into a specific pattern.
* @param date the date to format expressed in milliseconds.
* @param pattern the pattern to use to format the date.
* @return the formatted date.
*/
public static String format(long date, String pattern) {
return format(new Date(date), pattern);
}
/**
* Format a date/time into a specific pattern.
* @param date the date to format expressed in milliseconds.
* @param pattern the pattern to use to format the date.
* @return the formatted date.
*/
public static String format(Date date, String pattern) {
DateFormat df = createDateFormat(pattern);
return df.format(date);
}
/**
* Format an elapsed time into a plurialization correct string.
* It is limited only to report elapsed time in minutes and
* seconds and has the following behavior.
* <ul>
* <li>minutes are not displayed when 0. (ie: "45 seconds")</li>
* <li>seconds are always displayed in plural form (ie "0 seconds" or
* "10 seconds") except for 1 (ie "1 second")</li>
* </ul>
* @param time the elapsed time to report in milliseconds.
* @return the formatted text in minutes/seconds.
*/
public static String formatElapsedTime(long millis) {
long seconds = millis / 1000;
long minutes = seconds / 60;
Object[] args = {new Long(minutes), new Long(seconds % 60)};
return MINUTE_SECONDS.format(args);
}
/**
* return a lenient date format set to GMT time zone.
* @param pattern the pattern used for date/time formatting.
* @return the configured format for this pattern.
*/
private static DateFormat createDateFormat(String pattern) {
SimpleDateFormat sdf = new SimpleDateFormat(pattern);
TimeZone gmt = TimeZone.getTimeZone("GMT");
sdf.setTimeZone(gmt);
sdf.setLenient(true);
return sdf;
}
}
1.1
jakarta-ant/src/testcases/org/apache/tools/ant/util/DateUtilsTest.java
Index: DateUtilsTest.java
===================================================================
/*
* The Apache Software License, Version 1.1
*
* Copyright (c) 2002 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 [EMAIL PROTECTED]
*
* 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
* <http://www.apache.org/>.
*/
package org.apache.tools.ant.util;
import java.util.Date;
import java.util.Calendar;
import junit.framework.TestCase;
/**
* TestCase for DateUtils.
*
* @author <a href="mailto:[EMAIL PROTECTED]">Stephane Bailliez</a>
*/
public class DateUtilsTest extends TestCase {
public DateUtilsTest(String s) {
super(s);
}
public void testElapsedTime(){
String text = DateUtils.formatElapsedTime(50*1000);
assertEquals("50 seconds", text);
text = DateUtils.formatElapsedTime(65*1000);
assertEquals("1 minute 5 seconds", text);
text = DateUtils.formatElapsedTime(120*1000);
assertEquals("2 minutes 0 seconds", text);
text = DateUtils.formatElapsedTime(121*1000);
assertEquals("2 minutes 1 second", text);
}
public void testDateTimeISO(){
Calendar cal = Calendar.getInstance();
cal.set(2002,1,23,10,11,12);
String text = DateUtils.format(cal.getTime(),
DateUtils.ISO8601_DATETIME_PATTERN);
assertEquals("2002-02-23T09:11:12", text);
}
public void testDateISO(){
Calendar cal = Calendar.getInstance();
cal.set(2002,1,23);
String text = DateUtils.format(cal.getTime(),
DateUtils.ISO8601_DATE_PATTERN);
assertEquals("2002-02-23", text);
}
public void testTimeISODate(){
// make sure that elapsed time in set via date works
Calendar cal = Calendar.getInstance();
cal.set(2002,1,23, 21, 11, 12);
String text = DateUtils.format(cal.getTime(),
DateUtils.ISO8601_TIME_PATTERN);
assertEquals("20:11:12", text);
}
public void testTimeISO(){
// make sure that elapsed time in ms works
long ms = (20*3600 + 11*60 + 12)*1000;
String text = DateUtils.format(ms,
DateUtils.ISO8601_TIME_PATTERN);
assertEquals("20:11:12", text);
}
}
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
