Menu
▾
▴
[Objectlabkit-svn] SF.net SVN: objectlabkit: [158] trunk/datecalc-common/src/main/java/net/ objectlab/kit/datecalc/common
|
From: <be...@us...> - 2006-09-11 11:56:24
|
Revision: 158
http://svn.sourceforge.net/objectlabkit/?rev=158&view=rev
Author: benoitx
Date: 2006-09-11 04:56:13 -0700 (Mon, 11 Sep 2006)
Log Message:
-----------
Better javadoc.
Modified Paths:
--------------
trunk/datecalc-common/src/main/java/net/objectlab/kit/datecalc/common/AbstractDateCalculator.java
trunk/datecalc-common/src/main/java/net/objectlab/kit/datecalc/common/AbstractIMMDateCalculator.java
trunk/datecalc-common/src/main/java/net/objectlab/kit/datecalc/common/AbstractKitCalculatorsFactory.java
trunk/datecalc-common/src/main/java/net/objectlab/kit/datecalc/common/DateCalculator.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/IMMDateCalculator.java
trunk/datecalc-common/src/main/java/net/objectlab/kit/datecalc/common/KitCalculatorsFactory.java
trunk/datecalc-common/src/main/java/net/objectlab/kit/datecalc/common/PeriodCountCalculator.java
trunk/datecalc-common/src/main/java/net/objectlab/kit/datecalc/common/Tenor.java
Modified: trunk/datecalc-common/src/main/java/net/objectlab/kit/datecalc/common/AbstractDateCalculator.java
===================================================================
--- trunk/datecalc-common/src/main/java/net/objectlab/kit/datecalc/common/AbstractDateCalculator.java 2006-09-11 11:17:54 UTC (rev 157)
+++ trunk/datecalc-common/src/main/java/net/objectlab/kit/datecalc/common/AbstractDateCalculator.java 2006-09-11 11:56:13 UTC (rev 158)
@@ -32,6 +32,9 @@
* @version $Revision$ $Date$
*
* @param <E>
+ * a representation of a date, typically JDK: Date, Calendar;
+ * Joda:LocalDate, YearMonthDay
+ *
*/
public abstract class AbstractDateCalculator<E> implements DateCalculator<E> {
private static final int MONTHS_IN_YEAR = 12;
Modified: trunk/datecalc-common/src/main/java/net/objectlab/kit/datecalc/common/AbstractIMMDateCalculator.java
===================================================================
--- trunk/datecalc-common/src/main/java/net/objectlab/kit/datecalc/common/AbstractIMMDateCalculator.java 2006-09-11 11:17:54 UTC (rev 157)
+++ trunk/datecalc-common/src/main/java/net/objectlab/kit/datecalc/common/AbstractIMMDateCalculator.java 2006-09-11 11:56:13 UTC (rev 158)
@@ -30,6 +30,9 @@
* @version $Revision: 108 $ $Date: 2006-09-05 11:13:01 +0100 (Tue, 05 Sep 2006) $
*
* @param <E>
+ * a representation of a date, typically JDK: Date, Calendar;
+ * Joda:LocalDate, YearMonthDay
+ *
*/
public abstract class AbstractIMMDateCalculator<E> implements IMMDateCalculator<E> {
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-11 11:17:54 UTC (rev 157)
+++ trunk/datecalc-common/src/main/java/net/objectlab/kit/datecalc/common/AbstractKitCalculatorsFactory.java 2006-09-11 11:56:13 UTC (rev 158)
@@ -22,12 +22,16 @@
import java.util.concurrent.ConcurrentMap;
/**
- * @TODO javadoc
+ * Base class for all calculator factories, it handles the holiday registration.
*
* @author Marcin Jekot
* @author $LastChangedBy: benoitx $
* @version $Revision: 125 $ $Date: 2006-09-07 19:24:20 +0200 (Thu, 07 Sep 2006) $
*
+ * @param <E>
+ * a representation of a date, typically JDK: Date, Calendar;
+ * Joda:LocalDate, YearMonthDay
+ *
*/
public abstract class AbstractKitCalculatorsFactory<E> implements KitCalculatorsFactory<E> {
Modified: trunk/datecalc-common/src/main/java/net/objectlab/kit/datecalc/common/DateCalculator.java
===================================================================
--- trunk/datecalc-common/src/main/java/net/objectlab/kit/datecalc/common/DateCalculator.java 2006-09-11 11:17:54 UTC (rev 157)
+++ trunk/datecalc-common/src/main/java/net/objectlab/kit/datecalc/common/DateCalculator.java 2006-09-11 11:56:13 UTC (rev 158)
@@ -32,6 +32,11 @@
* @author Benoit Xhenseval
* @author $LastChangedBy$
* @version $Revision$ $Date$
+ *
+ * @param <E>
+ * a representation of a date, typically JDK: Date, Calendar;
+ * Joda:LocalDate, YearMonthDay
+ *
*/
public interface DateCalculator<E> {
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-11 11:17:54 UTC (rev 157)
+++ trunk/datecalc-common/src/main/java/net/objectlab/kit/datecalc/common/HolidayHandler.java 2006-09-11 11:56:13 UTC (rev 158)
@@ -26,6 +26,9 @@
* @version $Revision$ $Date$
*
* @param <E>
+ * a representation of a date, typically JDK: Date, Calendar;
+ * Joda:LocalDate, YearMonthDay
+ *
*/
public interface HolidayHandler<E> {
E moveCurrentDate(DateCalculator<E> date);
Modified: trunk/datecalc-common/src/main/java/net/objectlab/kit/datecalc/common/IMMDateCalculator.java
===================================================================
--- trunk/datecalc-common/src/main/java/net/objectlab/kit/datecalc/common/IMMDateCalculator.java 2006-09-11 11:17:54 UTC (rev 157)
+++ trunk/datecalc-common/src/main/java/net/objectlab/kit/datecalc/common/IMMDateCalculator.java 2006-09-11 11:56:13 UTC (rev 158)
@@ -26,6 +26,10 @@
* @author Benoit Xhenseval
* @author $LastChangedBy: benoitx $
* @version $Revision: 109 $ $Date: 2006-09-05 12:16:39 +0100 (Tue, 05 Sep 2006) $
+ * @param <E>
+ * a representation of a date, typically JDK: Date, Calendar;
+ * Joda:LocalDate, YearMonthDay
+ *
*/
public interface IMMDateCalculator<E> {
/**
Modified: trunk/datecalc-common/src/main/java/net/objectlab/kit/datecalc/common/KitCalculatorsFactory.java
===================================================================
--- trunk/datecalc-common/src/main/java/net/objectlab/kit/datecalc/common/KitCalculatorsFactory.java 2006-09-11 11:17:54 UTC (rev 157)
+++ trunk/datecalc-common/src/main/java/net/objectlab/kit/datecalc/common/KitCalculatorsFactory.java 2006-09-11 11:56:13 UTC (rev 158)
@@ -27,13 +27,14 @@
* NOT change even if a new set is registered; one needs to get a new
* DateCalculator to get the new set.
*
- * @param E
+ * @author Benoit Xhenseval
+ * @author $LastChangedBy: benoitx $
+ * @version $Revision: 125 $ $Date: 2006-09-07 19:24:20 +0200 (Thu, 07 Sep 2006) $
+ *
+ * @param <E>
* a representation of a date, typically JDK: Date, Calendar;
* Joda:LocalDate, YearMonthDay
*
- * @author Benoit Xhenseval
- * @author $LastChangedBy: benoitx $
- * @version $Revision: 125 $ $Date: 2006-09-07 19:24:20 +0200 (Thu, 07 Sep 2006) $
*/
public interface KitCalculatorsFactory<E> {
Modified: trunk/datecalc-common/src/main/java/net/objectlab/kit/datecalc/common/PeriodCountCalculator.java
===================================================================
--- trunk/datecalc-common/src/main/java/net/objectlab/kit/datecalc/common/PeriodCountCalculator.java 2006-09-11 11:17:54 UTC (rev 157)
+++ trunk/datecalc-common/src/main/java/net/objectlab/kit/datecalc/common/PeriodCountCalculator.java 2006-09-11 11:56:13 UTC (rev 158)
@@ -21,18 +21,16 @@
* Interface that defines a financial market way of calculating difference in
* days, month (or part of) and year (or part of).
*
- * @TODO Improve javadoc.
- *
* @author Benoit Xhenseval
* @author $LastChangedBy$
* @version $Revision$ $Date$
*
* @param <E>
- * a representation of "Date", typically Date, Calendar, LocalDate,
- * YearMonthDay.
+ * a representation of a date, typically JDK: Date, Calendar;
+ * Joda:LocalDate, YearMonthDay
+ *
*/
public interface PeriodCountCalculator<E> {
-
int YEAR_360 = 360;
int MONTHS_IN_YEAR = 12;
@@ -45,9 +43,33 @@
int MONTH_30_DAYS = 30;
+ /**
+ * This calculates the number of days between 2 dates, it follows the given basis which means that
+ * the result could vary between the same 2 dates if the basis is different.
+ * @param start the start date
+ * @param end the end date
+ * @param basis the basis to use
+ * @return number of days between end and start.
+ */
int dayDiff(final E start, final E end, PeriodCountBasis basis);
+ /**
+ * This calculates the number of months (or fraction) between 2 dates, it follows the given basis which means that
+ * the result could vary between the same 2 dates if the basis is different.
+ * @param start the start date
+ * @param end the end date
+ * @param basis the basis to use
+ * @return number of months between end and start.
+ */
double monthDiff(final E start, final E end, PeriodCountBasis basis);
+ /**
+ * This calculates the number of years (or fraction) between 2 dates, it follows the given basis which means that
+ * the result could vary between the same 2 dates if the basis is different.
+ * @param start the start date
+ * @param end the end date
+ * @param basis the basis to use
+ * @return number of months between end and start.
+ */
double yearDiff(final E start, final E end, PeriodCountBasis basis);
}
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-11 11:17:54 UTC (rev 157)
+++ trunk/datecalc-common/src/main/java/net/objectlab/kit/datecalc/common/Tenor.java 2006-09-11 11:56:13 UTC (rev 158)
@@ -19,7 +19,7 @@
/**
* Holds only valid unit and TenorCode: Day, Week, Month, Year, IMM, Overnight,
- * TomNext, Spot, SpotNext, SpotWeek.
+ * Spot.
*
* @author Benoit Xhenseval
* @author $LastChangedBy$
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
