commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From bay...@apache.org
Subject svn commit: r151308 - jakarta/commons/proper/lang/trunk/src/java/org/apache/commons/lang/time/DateUtils.java
Date Fri, 04 Feb 2005 03:17:00 GMT
Author: bayard
Date: Thu Feb  3 19:16:58 2005
New Revision: 151308

URL: http://svn.apache.org/viewcvs?view=rev&rev=151308
Log:
added javadoc and fixed long line as per checkstyle

Modified:
    jakarta/commons/proper/lang/trunk/src/java/org/apache/commons/lang/time/DateUtils.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?view=diff&r1=151307&r2=151308
==============================================================================
--- 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
Thu Feb  3 19:16:58 2005
@@ -34,7 +34,7 @@
  * @author <a href="mailto:ggregory@seagullsw.com">Gary Gregory</a>
  * @author Phil Steitz
  * @since 2.0
- * @version $Id: DateUtils.java,v 1.36 2004/10/21 01:18:33 ggregory Exp $
+ * @version $Id$
  */
 public class DateUtils {
     
@@ -74,7 +74,9 @@
             {Calendar.SECOND},
             {Calendar.MINUTE},
             {Calendar.HOUR_OF_DAY, Calendar.HOUR},
-            {Calendar.DATE, Calendar.DAY_OF_MONTH, Calendar.AM_PM /* Calendar.DAY_OF_YEAR,
Calendar.DAY_OF_WEEK, Calendar.DAY_OF_WEEK_IN_MONTH */},
+            {Calendar.DATE, Calendar.DAY_OF_MONTH, Calendar.AM_PM 
+                /* Calendar.DAY_OF_YEAR, Calendar.DAY_OF_WEEK, Calendar.DAY_OF_WEEK_IN_MONTH
*/
+            },
             {Calendar.MONTH, DateUtils.SEMI_MONTH},
             {Calendar.YEAR},
             {Calendar.ERA}};
@@ -720,6 +722,12 @@
         private final Calendar endFinal;
         private final Calendar spot;
         
+        /**
+         * Constructs a DateIterator that ranges from one date to another. 
+         *
+         * @param startFinal start date (inclusive)
+         * @param endFinal end date (not inclusive)
+         */
         DateIterator(Calendar startFinal, Calendar endFinal) {
             super();
             this.endFinal = endFinal;
@@ -727,10 +735,20 @@
             spot.add(Calendar.DATE, -1);
         }
 
+        /**
+         * Has the iterator not reached the end date yet?
+         *
+         * @return <code>true</code> if the iterator has yet to reach the end
date
+         */
         public boolean hasNext() {
             return spot.before(endFinal);
         }
 
+        /**
+         * Return the next calendar in the iteration
+         *
+         * @return Object calendar for the next date
+         */
         public Object next() {
             if (spot.equals(endFinal)) {
                 throw new NoSuchElementException();



---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org


Mime
View raw message