Author: scolebourne
Date: Sun Apr 16 13:29:57 2006
New Revision: 394553
URL: http://svn.apache.org/viewcvs?rev=394553&view=rev
Log:
Add methods that operate on a Date object
rfe 33102, from David Bowers
Modified:
jakarta/commons/proper/lang/trunk/src/java/org/apache/commons/lang/time/DateUtils.java
jakarta/commons/proper/lang/trunk/src/test/org/apache/commons/lang/time/DateUtilsTest.java
Modified:
jakarta/commons/proper/lang/trunk/src/java/org/apache/commons/lang/time/DateUtils.java
URL:
http://svn.apache.org/viewcvs/jakarta/commons/proper/lang/trunk/src/java/org/apache/commons/lang/time/DateUtils.java?rev=394553&r1=394552&r2=394553&view=diff
==============================================================================
---
jakarta/commons/proper/lang/trunk/src/java/org/apache/commons/lang/time/DateUtils.java
(original)
+++
jakarta/commons/proper/lang/trunk/src/java/org/apache/commons/lang/time/DateUtils.java
Sun Apr 16 13:29:57 2006
@@ -272,6 +272,139 @@
//-----------------------------------------------------------------------
/**
+ * Adds a number of years to a date returning a new object.
+ * The original date object is unchanged.
+ *
+ * @param date the date, not null
+ * @param amount the amount to add, may be negative
+ * @return the new date object with the amount added
+ * @throws IllegalArgumentException if the date is null
+ */
+ public static Date addYears(Date date, int amount) {
+ return add(date, Calendar.YEAR, amount);
+ }
+
+ //-----------------------------------------------------------------------
+ /**
+ * Adds a number of months to a date returning a new object.
+ * The original date object is unchanged.
+ *
+ * @param date the date, not null
+ * @param amount the amount to add, may be negative
+ * @return the new date object with the amount added
+ * @throws IllegalArgumentException if the date is null
+ */
+ public static Date addMonths(Date date, int amount) {
+ return add(date, Calendar.MONTH, amount);
+ }
+
+ //-----------------------------------------------------------------------
+ /**
+ * Adds a number of weeks to a date returning a new object.
+ * The original date object is unchanged.
+ *
+ * @param date the date, not null
+ * @param amount the amount to add, may be negative
+ * @return the new date object with the amount added
+ * @throws IllegalArgumentException if the date is null
+ */
+ public static Date addWeeks(Date date, int amount) {
+ return add(date, Calendar.WEEK_OF_YEAR, amount);
+ }
+
+ //-----------------------------------------------------------------------
+ /**
+ * Adds a number of days to a date returning a new object.
+ * The original date object is unchanged.
+ *
+ * @param date the date, not null
+ * @param amount the amount to add, may be negative
+ * @return the new date object with the amount added
+ * @throws IllegalArgumentException if the date is null
+ */
+ public static Date addDays(Date date, int amount) {
+ return add(date, Calendar.DAY_OF_MONTH, amount);
+ }
+
+ //-----------------------------------------------------------------------
+ /**
+ * Adds a number of hours to a date returning a new object.
+ * The original date object is unchanged.
+ *
+ * @param date the date, not null
+ * @param amount the amount to add, may be negative
+ * @return the new date object with the amount added
+ * @throws IllegalArgumentException if the date is null
+ */
+ public static Date addHours(Date date, int amount) {
+ return add(date, Calendar.HOUR_OF_DAY, amount);
+ }
+
+ //-----------------------------------------------------------------------
+ /**
+ * Adds a number of minutes to a date returning a new object.
+ * The original date object is unchanged.
+ *
+ * @param date the date, not null
+ * @param amount the amount to add, may be negative
+ * @return the new date object with the amount added
+ * @throws IllegalArgumentException if the date is null
+ */
+ public static Date addMinutes(Date date, int amount) {
+ return add(date, Calendar.MINUTE, amount);
+ }
+
+ //-----------------------------------------------------------------------
+ /**
+ * Adds a number of seconds to a date returning a new object.
+ * The original date object is unchanged.
+ *
+ * @param date the date, not null
+ * @param amount the amount to add, may be negative
+ * @return the new date object with the amount added
+ * @throws IllegalArgumentException if the date is null
+ */
+ public static Date addSeconds(Date date, int amount) {
+ return add(date, Calendar.SECOND, amount);
+ }
+
+ //-----------------------------------------------------------------------
+ /**
+ * Adds a number of milliseconds to a date returning a new object.
+ * The original date object is unchanged.
+ *
+ * @param date the date, not null
+ * @param amount the amount to add, may be negative
+ * @return the new date object with the amount added
+ * @throws IllegalArgumentException if the date is null
+ */
+ public static Date addMilliseconds(Date date, int amount) {
+ return add(date, Calendar.MILLISECOND, amount);
+ }
+
+ //-----------------------------------------------------------------------
+ /**
+ * Adds to a date returning a new object.
+ * The original date object is unchanged.
+ *
+ * @param date the date, not null
+ * @param calendarField the calendar field to add to
+ * @param amount the amount to add, may be negative
+ * @return the new date object with the amount added
+ * @throws IllegalArgumentException if the date is null
+ */
+ public static Date add(Date date, int calendarField, int amount) {
+ if (date == null) {
+ throw new IllegalArgumentException("The date must not be null");
+ }
+ Calendar c = Calendar.getInstance();
+ c.setTime(date);
+ c.add(calendarField, amount);
+ return c.getTime();
+ }
+
+ //-----------------------------------------------------------------------
+ /**
* <p>Round this date, leaving the field specified as the most
* significant field.</p>
*
Modified:
jakarta/commons/proper/lang/trunk/src/test/org/apache/commons/lang/time/DateUtilsTest.java
URL:
http://svn.apache.org/viewcvs/jakarta/commons/proper/lang/trunk/src/test/org/apache/commons/lang/time/DateUtilsTest.java?rev=394553&r1=394552&r2=394553&view=diff
==============================================================================
---
jakarta/commons/proper/lang/trunk/src/test/org/apache/commons/lang/time/DateUtilsTest.java
(original)
+++
jakarta/commons/proper/lang/trunk/src/test/org/apache/commons/lang/time/DateUtilsTest.java
Sun Apr 16 13:29:57 2006
@@ -43,6 +43,14 @@
* @author <a href="mailto:[EMAIL PROTECTED]">Steven Caswell</a>
*/
public class DateUtilsTest extends TestCase {
+
+ private static final long MILLIS_TEST;
+ static {
+ GregorianCalendar cal = new GregorianCalendar(2000, 6, 5, 4, 3, 2);
+ cal.set(Calendar.MILLISECOND, 1);
+ MILLIS_TEST = cal.getTime().getTime();
+ }
+
DateFormat dateParser = null;
DateFormat dateTimeParser = null;
DateFormat timeZoneDateParser = null;
@@ -275,7 +283,191 @@
fail();
} catch (IllegalArgumentException ex) {}
}
-
+
+ //-----------------------------------------------------------------------
+ public void testAddYears() throws Exception {
+ Date base = new Date(MILLIS_TEST);
+ Date result = DateUtils.addYears(base, 0);
+ assertNotSame(base, result);
+ assertDate(base, 2000, 6, 5, 4, 3, 2, 1);
+ assertDate(result, 2000, 6, 5, 4, 3, 2, 1);
+
+ result = DateUtils.addYears(base, 1);
+ assertNotSame(base, result);
+ assertDate(base, 2000, 6, 5, 4, 3, 2, 1);
+ assertDate(result, 2001, 6, 5, 4, 3, 2, 1);
+
+ result = DateUtils.addYears(base, -1);
+ assertNotSame(base, result);
+ assertDate(base, 2000, 6, 5, 4, 3, 2, 1);
+ assertDate(result, 1999, 6, 5, 4, 3, 2, 1);
+ }
+
+ //-----------------------------------------------------------------------
+ public void testAddMonths() throws Exception {
+ Date base = new Date(MILLIS_TEST);
+ Date result = DateUtils.addMonths(base, 0);
+ assertNotSame(base, result);
+ assertDate(base, 2000, 6, 5, 4, 3, 2, 1);
+ assertDate(result, 2000, 6, 5, 4, 3, 2, 1);
+
+ result = DateUtils.addMonths(base, 1);
+ assertNotSame(base, result);
+ assertDate(base, 2000, 6, 5, 4, 3, 2, 1);
+ assertDate(result, 2000, 7, 5, 4, 3, 2, 1);
+
+ result = DateUtils.addMonths(base, -1);
+ assertNotSame(base, result);
+ assertDate(base, 2000, 6, 5, 4, 3, 2, 1);
+ assertDate(result, 2000, 5, 5, 4, 3, 2, 1);
+ }
+
+ //-----------------------------------------------------------------------
+ public void testAddWeeks() throws Exception {
+ Date base = new Date(MILLIS_TEST);
+ Date result = DateUtils.addWeeks(base, 0);
+ assertNotSame(base, result);
+ assertDate(base, 2000, 6, 5, 4, 3, 2, 1);
+ assertDate(result, 2000, 6, 5, 4, 3, 2, 1);
+
+ result = DateUtils.addWeeks(base, 1);
+ assertNotSame(base, result);
+ assertDate(base, 2000, 6, 5, 4, 3, 2, 1);
+ assertDate(result, 2000, 6, 12, 4, 3, 2, 1);
+
+ result = DateUtils.addWeeks(base, -1);
+ assertNotSame(base, result);
+ assertDate(base, 2000, 6, 5, 4, 3, 2, 1); // july
+ assertDate(result, 2000, 5, 28, 4, 3, 2, 1); // june
+ }
+
+ //-----------------------------------------------------------------------
+ public void testAddDays() throws Exception {
+ Date base = new Date(MILLIS_TEST);
+ Date result = DateUtils.addDays(base, 0);
+ assertNotSame(base, result);
+ assertDate(base, 2000, 6, 5, 4, 3, 2, 1);
+ assertDate(result, 2000, 6, 5, 4, 3, 2, 1);
+
+ result = DateUtils.addDays(base, 1);
+ assertNotSame(base, result);
+ assertDate(base, 2000, 6, 5, 4, 3, 2, 1);
+ assertDate(result, 2000, 6, 6, 4, 3, 2, 1);
+
+ result = DateUtils.addDays(base, -1);
+ assertNotSame(base, result);
+ assertDate(base, 2000, 6, 5, 4, 3, 2, 1);
+ assertDate(result, 2000, 6, 4, 4, 3, 2, 1);
+ }
+
+ //-----------------------------------------------------------------------
+ public void testAddHours() throws Exception {
+ Date base = new Date(MILLIS_TEST);
+ Date result = DateUtils.addHours(base, 0);
+ assertNotSame(base, result);
+ assertDate(base, 2000, 6, 5, 4, 3, 2, 1);
+ assertDate(result, 2000, 6, 5, 4, 3, 2, 1);
+
+ result = DateUtils.addHours(base, 1);
+ assertNotSame(base, result);
+ assertDate(base, 2000, 6, 5, 4, 3, 2, 1);
+ assertDate(result, 2000, 6, 5, 5, 3, 2, 1);
+
+ result = DateUtils.addHours(base, -1);
+ assertNotSame(base, result);
+ assertDate(base, 2000, 6, 5, 4, 3, 2, 1);
+ assertDate(result, 2000, 6, 5, 3, 3, 2, 1);
+ }
+
+ //-----------------------------------------------------------------------
+ public void testAddMinutes() throws Exception {
+ Date base = new Date(MILLIS_TEST);
+ Date result = DateUtils.addMinutes(base, 0);
+ assertNotSame(base, result);
+ assertDate(base, 2000, 6, 5, 4, 3, 2, 1);
+ assertDate(result, 2000, 6, 5, 4, 3, 2, 1);
+
+ result = DateUtils.addMinutes(base, 1);
+ assertNotSame(base, result);
+ assertDate(base, 2000, 6, 5, 4, 3, 2, 1);
+ assertDate(result, 2000, 6, 5, 4, 4, 2, 1);
+
+ result = DateUtils.addMinutes(base, -1);
+ assertNotSame(base, result);
+ assertDate(base, 2000, 6, 5, 4, 3, 2, 1);
+ assertDate(result, 2000, 6, 5, 4, 2, 2, 1);
+ }
+
+ //-----------------------------------------------------------------------
+ public void testAddSeconds() throws Exception {
+ Date base = new Date(MILLIS_TEST);
+ Date result = DateUtils.addSeconds(base, 0);
+ assertNotSame(base, result);
+ assertDate(base, 2000, 6, 5, 4, 3, 2, 1);
+ assertDate(result, 2000, 6, 5, 4, 3, 2, 1);
+
+ result = DateUtils.addSeconds(base, 1);
+ assertNotSame(base, result);
+ assertDate(base, 2000, 6, 5, 4, 3, 2, 1);
+ assertDate(result, 2000, 6, 5, 4, 3, 3, 1);
+
+ result = DateUtils.addSeconds(base, -1);
+ assertNotSame(base, result);
+ assertDate(base, 2000, 6, 5, 4, 3, 2, 1);
+ assertDate(result, 2000, 6, 5, 4, 3, 1, 1);
+ }
+
+ //-----------------------------------------------------------------------
+ public void testAddMilliseconds() throws Exception {
+ Date base = new Date(MILLIS_TEST);
+ Date result = DateUtils.addMilliseconds(base, 0);
+ assertNotSame(base, result);
+ assertDate(base, 2000, 6, 5, 4, 3, 2, 1);
+ assertDate(result, 2000, 6, 5, 4, 3, 2, 1);
+
+ result = DateUtils.addMilliseconds(base, 1);
+ assertNotSame(base, result);
+ assertDate(base, 2000, 6, 5, 4, 3, 2, 1);
+ assertDate(result, 2000, 6, 5, 4, 3, 2, 2);
+
+ result = DateUtils.addMilliseconds(base, -1);
+ assertNotSame(base, result);
+ assertDate(base, 2000, 6, 5, 4, 3, 2, 1);
+ assertDate(result, 2000, 6, 5, 4, 3, 2, 0);
+ }
+
+ //-----------------------------------------------------------------------
+ public void testAddByField() throws Exception {
+ Date base = new Date(MILLIS_TEST);
+ Date result = DateUtils.add(base, Calendar.YEAR, 0);
+ assertNotSame(base, result);
+ assertDate(base, 2000, 6, 5, 4, 3, 2, 1);
+ assertDate(result, 2000, 6, 5, 4, 3, 2, 1);
+
+ result = DateUtils.add(base, Calendar.YEAR, 1);
+ assertNotSame(base, result);
+ assertDate(base, 2000, 6, 5, 4, 3, 2, 1);
+ assertDate(result, 2001, 6, 5, 4, 3, 2, 1);
+
+ result = DateUtils.add(base, Calendar.YEAR, -1);
+ assertNotSame(base, result);
+ assertDate(base, 2000, 6, 5, 4, 3, 2, 1);
+ assertDate(result, 1999, 6, 5, 4, 3, 2, 1);
+ }
+
+ //-----------------------------------------------------------------------
+ private void assertDate(Date date, int year, int month, int day, int hour,
int min, int sec, int mil) throws Exception {
+ GregorianCalendar cal = new GregorianCalendar();
+ cal.setTime(date);
+ assertEquals(year, cal.get(Calendar.YEAR));
+ assertEquals(month, cal.get(Calendar.MONTH));
+ assertEquals(day, cal.get(Calendar.DAY_OF_MONTH));
+ assertEquals(hour, cal.get(Calendar.HOUR_OF_DAY));
+ assertEquals(min, cal.get(Calendar.MINUTE));
+ assertEquals(sec, cal.get(Calendar.SECOND));
+ assertEquals(mil, cal.get(Calendar.MILLISECOND));
+ }
+
//-----------------------------------------------------------------------
/**
* Tests various values with the round method
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
