net.objectlab.kit.datecalc.joda

Class LocalDateCalculator

java.lang.Object

net.objectlab.kit.datecalc.common.AbstractDateCalculator<org.joda.time.LocalDate>

net.objectlab.kit.datecalc.joda.LocalDateCalculator

All Implemented Interfaces:

BaseCalculator<org.joda.time.LocalDate>, DateCalculator<org.joda.time.LocalDate>, NonWorkingDayChecker<org.joda.time.LocalDate>

public class LocalDateCalculator
extends AbstractDateCalculator<org.joda.time.LocalDate>

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:

Benoit Xhenseval

Field Summary

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

DAYS_IN_WEEK

Constructor Summary

Constructors

Constructor and Description
LocalDateCalculator()
LocalDateCalculator(String name, org.joda.time.LocalDate startDate, HolidayCalendar<org.joda.time.LocalDate> holidayCalendar, HolidayHandler<org.joda.time.LocalDate> holidayHandler)

Method Summary

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

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

LocalDateCalculator

public LocalDateCalculator()

LocalDateCalculator

public LocalDateCalculator(String name,
                           org.joda.time.LocalDate startDate,
                           HolidayCalendar<org.joda.time.LocalDate> holidayCalendar,
                           HolidayHandler<org.joda.time.LocalDate> holidayHandler)

Method Detail

setWorkingWeek

public DateCalculator<org.joda.time.LocalDate> setWorkingWeek(WorkingWeek week)

Set the working week.

Parameters:

week - the JodaWorkingWeek

Throws:

IllegalArgumentException - if the week is not a JodaWorkingWeek.

isWeekend

public boolean isWeekend(org.joda.time.LocalDate date)

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

Returns:

true if the date falls on a weekend.

moveByDays

public DateCalculator<org.joda.time.LocalDate> 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<org.joda.time.LocalDate> moveByMonths(int months)

Specified by:

moveByMonths in class AbstractDateCalculator<org.joda.time.LocalDate>

createNewCalculator

protected DateCalculator<org.joda.time.LocalDate> createNewCalculator(String name,
                                                                      org.joda.time.LocalDate startDate,
                                                                      HolidayCalendar<org.joda.time.LocalDate> holidays,
                                                                      HolidayHandler<org.joda.time.LocalDate> handler)

Specified by:

createNewCalculator in class AbstractDateCalculator<org.joda.time.LocalDate>

getToday

protected org.joda.time.LocalDate getToday()

Specified by:

getToday in class AbstractDateCalculator<org.joda.time.LocalDate>

compareDate

protected org.joda.time.LocalDate compareDate(org.joda.time.LocalDate date1,
                                              org.joda.time.LocalDate date2,
                                              boolean returnEarliest)

Specified by:

compareDate in class AbstractDateCalculator<org.joda.time.LocalDate>

checkBoundary

protected void checkBoundary(org.joda.time.LocalDate 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<org.joda.time.LocalDate>

clone

protected org.joda.time.LocalDate clone(org.joda.time.LocalDate date)

Specified by:

clone in class AbstractDateCalculator<org.joda.time.LocalDate>

getNumberOfBusinessDaysBetween

public int getNumberOfBusinessDaysBetween(org.joda.time.LocalDate d1,
                                          org.joda.time.LocalDate 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)