Menu
▾
▴
[Objectlabkit-svn] SF.net SVN: objectlabkit: [186] trunk/datecalc-common/src/main/java/net/ objectlab/kit/datecalc/common
|
From: <be...@us...> - 2006-09-19 09:52:49
|
Revision: 186
http://svn.sourceforge.net/objectlabkit/?rev=186&view=rev
Author: benoitx
Date: 2006-09-19 02:52:41 -0700 (Tue, 19 Sep 2006)
Log Message:
-----------
javadoc corrections, based on the yDoc warning report.
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/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/KitCalculatorsFactory.java
trunk/datecalc-common/src/main/java/net/objectlab/kit/datecalc/common/Utils.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-18 20:27:22 UTC (rev 185)
+++ trunk/datecalc-common/src/main/java/net/objectlab/kit/datecalc/common/AbstractDateCalculator.java 2006-09-19 09:52:41 UTC (rev 186)
@@ -102,7 +102,7 @@
* either a 'weekend' or holiday, it will be skipped acording to the holiday
* handler and not count towards the number of days to move.
*
- * @param businessDays
+ * @param tenor the tenor.
* @param spotLag
* number of days to "spot" days, this can vary from one market
* to the other.
@@ -219,20 +219,20 @@
* currentBusinessDate will be the ones from the existing calendar (not the
* parameter one). The name will be combined name1+"/"+calendar.getName().
*
- * @param calendar,
+ * @param calculator
* return the same DateCalculator if calender is null or the
* original calendar (but why would you want to do that?)
* @throws IllegalArgumentException
* if both calendars have different types of HolidayHandlers or
* WorkingWeek;
*/
- public DateCalculator<E> combine(final DateCalculator<E> calendar) {
- if (calendar == null || calendar == this) {
+ public DateCalculator<E> combine(final DateCalculator<E> calculator) {
+ if (calculator == null || calculator == this) {
return this;
}
- if (holidayHandler == null && calendar.getHolidayHandlerType() != null || holidayHandler != null
- && !holidayHandler.getType().equals(calendar.getHolidayHandlerType())) {
+ if (holidayHandler == null && calculator.getHolidayHandlerType() != null || holidayHandler != null
+ && !holidayHandler.getType().equals(calculator.getHolidayHandlerType())) {
throw new IllegalArgumentException("Combined Calendars cannot have different handler types");
}
@@ -240,11 +240,11 @@
if (nonWorkingDays != null) {
newSet.addAll(nonWorkingDays);
}
- if (calendar.getNonWorkingDays() != null) {
- newSet.addAll(calendar.getNonWorkingDays());
+ if (calculator.getNonWorkingDays() != null) {
+ newSet.addAll(calculator.getNonWorkingDays());
}
- final DateCalculator<E> cal = createNewCalculator(getName() + "/" + calendar.getName(), getStartDate(), newSet,
+ final DateCalculator<E> cal = createNewCalculator(getName() + "/" + calculator.getName(), getStartDate(), newSet,
holidayHandler);
return cal;
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-18 20:27:22 UTC (rev 185)
+++ trunk/datecalc-common/src/main/java/net/objectlab/kit/datecalc/common/AbstractKitCalculatorsFactory.java 2006-09-19 09:52:41 UTC (rev 186)
@@ -45,7 +45,7 @@
*
* @param name
* the calendar name to register these holidays under.
- * @param holidays
+ * @param holidaysSet
* the set of holidays (non-working days).
*/
public void registerHolidays(final String name, final Set<E> holidaysSet) {
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-18 20:27:22 UTC (rev 185)
+++ trunk/datecalc-common/src/main/java/net/objectlab/kit/datecalc/common/DateCalculator.java 2006-09-19 09:52:41 UTC (rev 186)
@@ -178,7 +178,7 @@
* currentBusinessDate will be the ones from the existing calendar (not the
* parameter one). The name will be combined name1+"/"+calendar.getName().
*
- * @param calendar,
+ * @param calculator
* return the same DateCalculator if calender is null or the
* original calendar (but why would you want to do that?)
* @throws IllegalArgumentException
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-18 20:27:22 UTC (rev 185)
+++ trunk/datecalc-common/src/main/java/net/objectlab/kit/datecalc/common/KitCalculatorsFactory.java 2006-09-19 09:52:41 UTC (rev 186)
@@ -45,7 +45,7 @@
* calendar name (holidays set interested in). If there is set of
* holidays with that name, it will return a DateCalculator with
* an empty holiday set (will work on Weekend only).
- * @param type
+ * @param holidayHandlerType
* typically one of the value of HolidayHandlerType or null.
* @return a new DateCalculator
* @exception IllegalArgumentException
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-18 20:27:22 UTC (rev 185)
+++ trunk/datecalc-common/src/main/java/net/objectlab/kit/datecalc/common/Utils.java 2006-09-19 09:52:41 UTC (rev 186)
@@ -83,10 +83,10 @@
}
/**
- *
+ * get a new Calendar based on the string date.
* @param str
- * string
- * @return
+ * the date string
+ * @return a new Calendar
* @throws IllegalArgumentException
* if the string cannot be parsed.
*/
@@ -104,10 +104,10 @@
}
/**
- * Get a Calendar object for a given Date representation
+ * Get a Calendar object for a given Date representation.
*
* @param date
- * @return
+ * @return the Calendar
*/
public static Calendar getCal(final Date date) {
if (date == null) {
@@ -119,10 +119,10 @@
}
/**
- * Converts a Set of Date objects to a Set of Calendar objects
+ * Converts a Set of Date objects to a Set of Calendar objects.
*
* @param dates
- * @return
+ * @return the converted Set<Calendar>
*/
public static Set<Calendar> toCalendarSet(final Set<Date> dates) {
final Set<Calendar> calendars = new HashSet<Calendar>();
@@ -136,7 +136,7 @@
* Converts a Set of Calendar objects to a Set of Date objects
*
* @param calendars
- * @return
+ * @return the converset Set<Date>
*/
public static Set<Date> toDateSet(final Set<Calendar> calendars) {
@@ -152,7 +152,7 @@
* of dates
*
* @param dates
- * @return
+ * @return the converted List<Date>
*/
public static List<Date> toDateList(final List<Calendar> dates) {
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
