[Objectlabkit-svn] SF.net SVN: objectlabkit: [147] trunk/datecalc-common/src/main/java/net/ objectlab/kit/datecalc/common

[<ma...@us...>]

Revision: 147
          http://svn.sourceforge.net/objectlabkit/?rev=147&view=rev
Author:   marchy
Date:     2006-09-10 08:18:53 -0700 (Sun, 10 Sep 2006)

Log Message:
-----------
javadoc update

Modified Paths:
--------------
    trunk/datecalc-common/src/main/java/net/objectlab/kit/datecalc/common/AbstractKitCalculatorsFactory.java
    trunk/datecalc-common/src/main/java/net/objectlab/kit/datecalc/common/HolidayHandler.java
    trunk/datecalc-common/src/main/java/net/objectlab/kit/datecalc/common/HolidayHandlerType.java
    trunk/datecalc-common/src/main/java/net/objectlab/kit/datecalc/common/PeriodCountBasis.java
    trunk/datecalc-common/src/main/java/net/objectlab/kit/datecalc/common/StandardTenor.java
    trunk/datecalc-common/src/main/java/net/objectlab/kit/datecalc/common/Tenor.java
    trunk/datecalc-common/src/main/java/net/objectlab/kit/datecalc/common/TenorCode.java
    trunk/datecalc-common/src/main/java/net/objectlab/kit/datecalc/common/Utils.java
    trunk/datecalc-common/src/main/java/net/objectlab/kit/datecalc/common/WorkingWeek.java

Modified: trunk/datecalc-common/src/main/java/net/objectlab/kit/datecalc/common/AbstractKitCalculatorsFactory.java
===================================================================
--- trunk/datecalc-common/src/main/java/net/objectlab/kit/datecalc/common/AbstractKitCalculatorsFactory.java	2006-09-10 14:56:37 UTC (rev 146)
+++ trunk/datecalc-common/src/main/java/net/objectlab/kit/datecalc/common/AbstractKitCalculatorsFactory.java	2006-09-10 15:18:53 UTC (rev 147)
@@ -22,9 +22,9 @@
 import java.util.concurrent.ConcurrentMap;
 
 /**
- * TODO javadoc
+ * @TODO javadoc
  * 
- * @author marchi
+ * @author Marcin Jekot
  * @author $LastChangedBy: benoitx $
  * @version $Revision: 125 $ $Date: 2006-09-07 19:24:20 +0200 (Thu, 07 Sep 2006) $
  * 

Modified: trunk/datecalc-common/src/main/java/net/objectlab/kit/datecalc/common/HolidayHandler.java
===================================================================
--- trunk/datecalc-common/src/main/java/net/objectlab/kit/datecalc/common/HolidayHandler.java	2006-09-10 14:56:37 UTC (rev 146)
+++ trunk/datecalc-common/src/main/java/net/objectlab/kit/datecalc/common/HolidayHandler.java	2006-09-10 15:18:53 UTC (rev 147)
@@ -20,8 +20,12 @@
 /**
  * This will be called to determine whether the date should be moved according
  * to the special algorithm used.
- * 
+ *
  * @author Benoit Xhenseval
+ * @author $LastChangedBy$
+ * @version $Revision$ $Date$
+ *
+ * @param <E>
  */
 public interface HolidayHandler<E> {
     E moveCurrentDate(DateCalculator<E> date);

Modified: trunk/datecalc-common/src/main/java/net/objectlab/kit/datecalc/common/HolidayHandlerType.java
===================================================================
--- trunk/datecalc-common/src/main/java/net/objectlab/kit/datecalc/common/HolidayHandlerType.java	2006-09-10 14:56:37 UTC (rev 146)
+++ trunk/datecalc-common/src/main/java/net/objectlab/kit/datecalc/common/HolidayHandlerType.java	2006-09-10 15:18:53 UTC (rev 147)
@@ -21,6 +21,9 @@
  * Define a series of standard way to handle holidays.
  * 
  * @author Benoit Xhenseval
+ * @author $LastChangedBy$
+ * @version $Revision$ $Date$
+ *
  */
 public final class HolidayHandlerType {
 

Modified: trunk/datecalc-common/src/main/java/net/objectlab/kit/datecalc/common/PeriodCountBasis.java
===================================================================
--- trunk/datecalc-common/src/main/java/net/objectlab/kit/datecalc/common/PeriodCountBasis.java	2006-09-10 14:56:37 UTC (rev 146)
+++ trunk/datecalc-common/src/main/java/net/objectlab/kit/datecalc/common/PeriodCountBasis.java	2006-09-10 15:18:53 UTC (rev 147)
@@ -17,10 +17,13 @@
  */
 package net.objectlab.kit.datecalc.common;
 
+
 /**
  * Defines some standard Day Count basis.
  * 
  * @author Benoit Xhenseval
+ * @author $LastChangedBy$
+ * @version $Revision$ $Date$
  */
 public enum PeriodCountBasis {
     /**

Modified: trunk/datecalc-common/src/main/java/net/objectlab/kit/datecalc/common/StandardTenor.java
===================================================================
--- trunk/datecalc-common/src/main/java/net/objectlab/kit/datecalc/common/StandardTenor.java	2006-09-10 14:56:37 UTC (rev 146)
+++ trunk/datecalc-common/src/main/java/net/objectlab/kit/datecalc/common/StandardTenor.java	2006-09-10 15:18:53 UTC (rev 147)
@@ -21,6 +21,9 @@
  * A series of Standard Tenors used by the financial industry.
  * 
  * @author Benoit Xhenseval
+ * @author $LastChangedBy$
+ * @version $Revision$ $Date$
+ *
  */
 public final class StandardTenor {
     private StandardTenor() {

Modified: trunk/datecalc-common/src/main/java/net/objectlab/kit/datecalc/common/Tenor.java
===================================================================
--- trunk/datecalc-common/src/main/java/net/objectlab/kit/datecalc/common/Tenor.java	2006-09-10 14:56:37 UTC (rev 146)
+++ trunk/datecalc-common/src/main/java/net/objectlab/kit/datecalc/common/Tenor.java	2006-09-10 15:18:53 UTC (rev 147)
@@ -20,6 +20,11 @@
 /**
  * Holds only valid unit and TenorCode: Day, Week, Month, Year, IMM, Overnight,
  * TomNext, Spot, SpotNext, SpotWeek.
+ *
+ * @author Benoit Xhenseval
+ * @author $LastChangedBy$
+ * @version $Revision$ $Date$
+ *
  */
 public class Tenor {
     private int units = 0;

Modified: trunk/datecalc-common/src/main/java/net/objectlab/kit/datecalc/common/TenorCode.java
===================================================================
--- trunk/datecalc-common/src/main/java/net/objectlab/kit/datecalc/common/TenorCode.java	2006-09-10 14:56:37 UTC (rev 146)
+++ trunk/datecalc-common/src/main/java/net/objectlab/kit/datecalc/common/TenorCode.java	2006-09-10 15:18:53 UTC (rev 147)
@@ -17,6 +17,14 @@
  */
 package net.objectlab.kit.datecalc.common;
 
+/**
+ * enum of Tenor Codes held by a {@link Tenor}
+ *
+ * @author Benoit Xhenseval
+ * @author $LastChangedBy$
+ * @version $Revision$ $Date$
+ *
+ */
 public enum TenorCode {
     OVERNIGHT("ON", false),
     // TOMNEXT("TN", false),
@@ -34,10 +42,17 @@
         this.acceptUnits = acceptUnits;
     }
 
+    /**
+     * @return the string representation of this <code>TenorCode</code>
+     */
     public String getCode() {
         return code;
     }
 
+    /**
+     * @param code string representation of the <code>TenorCode</code>
+     * @return a <code>TenorCode</code> represented by the string argument 
+     */
     public static TenorCode fromCode(final String code) {
         for (final TenorCode ct : TenorCode.values()) {
             if (ct.getCode().equals(code)) {

Modified: trunk/datecalc-common/src/main/java/net/objectlab/kit/datecalc/common/Utils.java
===================================================================
--- trunk/datecalc-common/src/main/java/net/objectlab/kit/datecalc/common/Utils.java	2006-09-10 14:56:37 UTC (rev 146)
+++ trunk/datecalc-common/src/main/java/net/objectlab/kit/datecalc/common/Utils.java	2006-09-10 15:18:53 UTC (rev 147)
@@ -28,7 +28,7 @@
 import java.util.TimeZone;
 
 /**
- * TODO javadoc
+ * Utilities class for <code>Date/Calendar</code> conversions
  * 
  * @author Marcin Jekot
  * @author $LastModifiedBy$
@@ -44,15 +44,12 @@
     private Utils() {
     }
 
-    public static Calendar getCal(final Date date) {
-        if (date == null) {
-            return null;
-        }
-        final Calendar cal = Calendar.getInstance();
-        cal.setTime(date);
-        return blastTime(cal);
-    }
-
+    /**
+     * Removes set's all "time" fields to zero, leaving only the date portion of the Calendar.
+     * The Calendar passe
+     * @param cal to Calendar object to blast, note, it will be modified
+     * @return the calendar object modified (same instance)
+     */
     public static Calendar blastTime(final Calendar cal) {
         cal.setTimeZone(TimeZone.getTimeZone("UTC"));
         cal.set(Calendar.HOUR_OF_DAY, 0);
@@ -63,26 +60,28 @@
     }
 
     /**
+     * Creates a Date object given a string representation of it
      * 
-     * @param str
+     * @param dateStr
      *            string (return today if string is null)
-     * @return today if
+     * @return today if string is null, a Date object representing the string
+     *         otherwise
      * @throws IllegalArgumentException
      *             if the string cannot be parsed.
      */
-    public static Date createDate(final String str) {
-        if (str == null) {
+    public static Date createDate(final String dateStr) {
+        if (dateStr == null) {
             return createCalendar(null).getTime();
         }
         try {
-            final Date date = SDF.parse(str);
+            final Date date = SDF.parse(dateStr);
             final Calendar cal = getCal(date);
             return cal.getTime();
         } catch (final ParseException e) {
-            throw new IllegalArgumentException("\"" + str + "\"" + " is an invalid date, the pattern is : " + DATE_PATTERN);
+            throw new IllegalArgumentException("\"" + dateStr + "\"" + " is an invalid date, the pattern is : " + DATE_PATTERN);
         }
     }
-
+    
     /**
      * 
      * @param str
@@ -104,6 +103,26 @@
         }
     }
 
+    /**
+     * Get a Calendar object for a given Date representation
+     * @param date
+     * @return
+     */
+    public static Calendar getCal(final Date date) {
+        if (date == null) {
+            return null;
+        }
+        final Calendar cal = Calendar.getInstance();
+        cal.setTime(date);
+        return blastTime(cal);
+    }
+    
+    /**
+     * Converts a Set of Date objects to a Set of Calendar objects
+     * 
+     * @param dates
+     * @return
+     */
     public static Set<Calendar> toCalendarSet(final Set<Date> dates) {
         final Set<Calendar> calendars = new HashSet<Calendar>();
         for (final Date date : dates) {
@@ -112,6 +131,12 @@
         return calendars;
     }
 
+    /**
+     * Converts a Set of Calendar objects to a Set of Date objects
+     * 
+     * @param calendars
+     * @return
+     */
     public static Set<Date> toDateSet(final Set<Calendar> calendars) {
 
         final Set<Date> dates = new HashSet<Date>();
@@ -121,6 +146,13 @@
         return dates;
     }
 
+    /**
+     * Converts a <code>List</code> of Calendar objects to a <code>List</code>
+     * of dates
+     * 
+     * @param dates
+     * @return
+     */
     public static List<Date> toDateList(final List<Calendar> dates) {
 
         final List<Date> dateList = new ArrayList<Date>();

Modified: trunk/datecalc-common/src/main/java/net/objectlab/kit/datecalc/common/WorkingWeek.java
===================================================================
--- trunk/datecalc-common/src/main/java/net/objectlab/kit/datecalc/common/WorkingWeek.java	2006-09-10 14:56:37 UTC (rev 146)
+++ trunk/datecalc-common/src/main/java/net/objectlab/kit/datecalc/common/WorkingWeek.java	2006-09-10 15:18:53 UTC (rev 147)
@@ -24,6 +24,9 @@
  * Immutable Working Week, default is Mon->Friday.
  * 
  * @author Benoit Xhenseval
+ * @author $LastChangedBy$
+ * @version $Revision$ $Date$
+ *
  */
 public class WorkingWeek {
     private static final byte MONDAY = 1;


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.