net.objectlab.kit.datecalc.jdk

Class CalendarDateCalculator

java.lang.Object

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

net.objectlab.kit.datecalc.jdk.CalendarDateCalculator

All Implemented Interfaces:

BaseCalculator<Calendar>, DateCalculator<Calendar>, NonWorkingDayChecker<Calendar>

public class CalendarDateCalculator
extends AbstractDateCalculator<Calendar>

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
CalendarDateCalculator()
CalendarDateCalculator(String name, Calendar startDate, HolidayCalendar<Calendar> holidayCalendar, HolidayHandler<Calendar> holidayHandler)

Method Summary

Modifier and Type	Method and Description
protected void	checkBoundary(Calendar date) This may throw an IndexOutOfBoundsException if the date is not within the boundaries.
protected Calendar	clone(Calendar date)
protected Calendar	compareDate(Calendar date1, Calendar date2, boolean returnEarliest)
protected DateCalculator<Calendar>	createNewCalculator(String name, Calendar startDate, HolidayCalendar<Calendar> holidays, HolidayHandler<Calendar> handler)
int	getNumberOfBusinessDaysBetween(Calendar d1, Calendar 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 Calendar	getToday()
boolean	isWeekend(Calendar date) is the date a non-working day according to the WorkingWeek?
CalendarDateCalculator	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.
DateCalculator<Calendar>	moveByMonths(int months)
DateCalculator<Calendar>	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, setStartDate

Methods inherited from class java.lang.Object

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

Constructor Detail

CalendarDateCalculator

public CalendarDateCalculator()

CalendarDateCalculator

public CalendarDateCalculator(String name,
                              Calendar startDate,
                              HolidayCalendar<Calendar> holidayCalendar,
                              HolidayHandler<Calendar> holidayHandler)

Method Detail

setWorkingWeek

public DateCalculator<Calendar> 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(Calendar date)

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

Returns:

true if the date falls on a weekend.

moveByDays

public CalendarDateCalculator 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();)

moveByMonths

public DateCalculator<Calendar> moveByMonths(int months)

Specified by:

moveByMonths in class AbstractDateCalculator<Calendar>

createNewCalculator

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

Specified by:

createNewCalculator in class AbstractDateCalculator<Calendar>

getToday

protected final Calendar getToday()

Specified by:

getToday in class AbstractDateCalculator<Calendar>

compareDate

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

Specified by:

compareDate in class AbstractDateCalculator<Calendar>

checkBoundary

protected void checkBoundary(Calendar 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<Calendar>

clone

protected Calendar clone(Calendar date)

Specified by:

clone in class AbstractDateCalculator<Calendar>

getNumberOfBusinessDaysBetween

public int getNumberOfBusinessDaysBetween(Calendar d1,
                                          Calendar 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)