net.objectlab.kit.datecalc.jdk

Class DateDateCalculator

java.lang.Object

net.objectlab.kit.datecalc.common.AbstractDateCalculator<Date>

net.objectlab.kit.datecalc.jdk.DateDateCalculator

All Implemented Interfaces:

BaseCalculator<Date>, DateCalculator<Date>, NonWorkingDayChecker<Date>

public class DateDateCalculator
extends AbstractDateCalculator<Date>

This class is used via the DateCalculator interface, it enables the handling of different HolidayHandler, if no HolidayHandler is defined, the calendar will NOT move a date, even if it falls on a holiday or weekend.

Author:

Marcin Jekot

Field Summary

Fields inherited from class net.objectlab.kit.datecalc.common.AbstractDateCalculator

DAYS_IN_WEEK

Constructor Summary

Constructors

Constructor and Description
DateDateCalculator()
DateDateCalculator(String name, Date startDate, HolidayCalendar<Date> holidayCalendar, HolidayHandler<Date> holidayHandler)

Method Summary

Modifier and Type	Method and Description
protected void	checkBoundary(Date date) This may throw an IndexOutOfBoundsException if the date is not within the boundaries.
protected Date	clone(Date date)
protected Date	compareDate(Date date1, Date date2, boolean returnEarliest)
protected DateCalculator<Date>	createNewCalculator(String name, Date startDate, HolidayCalendar<Date> holidays, HolidayHandler<Date> handler)
int	getNumberOfBusinessDaysBetween(Date d1, Date d2) Number of non weekend, non holidays days between d1 and d2, using the Holiday Handler type to match what the method moveByBusinessDays requires.
protected Date	getToday()
boolean	isWeekend(Date date) is the date a non-working day according to the WorkingWeek?
DateCalculator<Date>	moveByDays(int days) This changes the current business date held in the calculator, it moves the new current business date by the number of days and, if it falls on a weekend or holiday, moves it further according to the HolidayHandler given in this DateCalculator.
protected DateCalculator<Date>	moveByMonths(int months)
DateCalculator<Date>	setStartDate(Date startDate) Set both start date and current date
DateCalculator<Date>	setWorkingWeek(WorkingWeek week) Allows user to define what their Working Week should be (default is Mon-Fri).

Methods inherited from class net.objectlab.kit.datecalc.common.AbstractDateCalculator

applyTenor, calculateTenorDates, calculateTenorDates, combine, forceCurrentDateNoAdjustment, getCurrentBusinessDate, getCurrentIncrement, getHolidayCalendar, getHolidayHandler, getHolidayHandlerType, getName, getStartDate, isCurrentDateNonWorking, isNonWorkingDay, moveByBusinessDays, moveByTenor, moveByTenor, moveToSpotDate, setCurrentBusinessDate, setCurrentIncrement, setHolidayCalendar, setHolidayHandler, setName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DateDateCalculator

public DateDateCalculator()

DateDateCalculator

public DateDateCalculator(String name,
                          Date startDate,
                          HolidayCalendar<Date> holidayCalendar,
                          HolidayHandler<Date> holidayHandler)

Method Detail

setWorkingWeek

public DateCalculator<Date> setWorkingWeek(WorkingWeek week)

Description copied from interface: DateCalculator

Allows user to define what their Working Week should be (default is Mon-Fri).

Parameters:

week - an immutable definition of a week.

isWeekend

public boolean isWeekend(Date date)

is the date a non-working day according to the WorkingWeek?

Returns:

true if the date falls on a weekend.

moveByDays

public DateCalculator<Date> moveByDays(int days)

Description copied from interface: DateCalculator

This changes the current business date held in the calculator, it moves the new current business date by the number of days and, if it falls on a weekend or holiday, moves it further according to the HolidayHandler given in this DateCalculator.

Parameters:

days - number of days (can be <0 or >0)

Returns:

the DateCalculator (so one can do calendar.moveByDays(-2).getCurrentBusinessDate();)

createNewCalculator

protected DateCalculator<Date> createNewCalculator(String name,
                                                   Date startDate,
                                                   HolidayCalendar<Date> holidays,
                                                   HolidayHandler<Date> handler)

Specified by:

createNewCalculator in class AbstractDateCalculator<Date>

setStartDate

public final DateCalculator<Date> setStartDate(Date startDate)

Description copied from class: AbstractDateCalculator

Set both start date and current date

Specified by:

setStartDate in interface DateCalculator<Date>

Overrides:

setStartDate in class AbstractDateCalculator<Date>

Parameters:

startDate - the reference date for this calculator, the current business date is also updated and may be moved if it falls on a non working day (holiday/weekend).

getToday

protected final Date getToday()

Specified by:

getToday in class AbstractDateCalculator<Date>

moveByMonths

protected DateCalculator<Date> moveByMonths(int months)

Specified by:

moveByMonths in class AbstractDateCalculator<Date>

compareDate

protected Date compareDate(Date date1,
                           Date date2,
                           boolean returnEarliest)

Specified by:

compareDate in class AbstractDateCalculator<Date>

checkBoundary

protected void checkBoundary(Date date)

Description copied from class: AbstractDateCalculator

This may throw an IndexOutOfBoundsException if the date is not within the boundaries.

Specified by:

checkBoundary in class AbstractDateCalculator<Date>

clone

protected Date clone(Date date)

Specified by:

clone in class AbstractDateCalculator<Date>

getNumberOfBusinessDaysBetween

public int getNumberOfBusinessDaysBetween(Date d1,
                                          Date d2)

Description copied from interface: DateCalculator

Number of non weekend, non holidays days between d1 and d2, using the Holiday Handler type to match what the method moveByBusinessDays requires. Note that moveByBusinessDays could give the same answer with some holiday handlers like modified forward or modified preceding; this getNumberOfBusinessDaysBetween should give the first (smallest) answer.

Parameters:

d1 - start date

d2 - end date

Returns:

d2 - d1 -numberOfWeekendDays - numberOfHolidays (matching what moveByBusinessDays requires)