net.objectlab.kit.datecalc.common

Interface HolidayHandler<E>

Type Parameters:

E - a representation of a date, typically JDK: Date, Calendar; Joda:LocalDate, YearMonthDay

All Known Implementing Classes:

CalendarBackwardHandler, CalendarForwardHandler, CalendarForwardUnlessNegativeHandler, CalendarModifiedFollowingHandler, CalendarModifiedPrecedingHandler, DateBackwardHandler, DateForwardHandler, DateForwardUnlessNegativeHandler, DateModifiedFollowingHandler, DateModifiedPreceedingHandler, HolidayHandlerDateWrapper, LocalDateBackwardHandler, LocalDateBackwardHandler, LocalDateForwardHandler, LocalDateForwardHandler, LocalDateForwardUnlessNegativeHandler, LocalDateForwardUnlessNegativeHandler, LocalDateModifiedFollowingHandler, LocalDateModifiedFollowingHandler, LocalDateModifiedPrecedingHandler, LocalDateModifiedPrecedingHandler

public interface HolidayHandler<E>

This will be called to determine whether the date should be moved according to the special algorithm used.

Author:

Benoit Xhenseval

Method Summary

Modifier and Type	Method and Description
E	adjustDate(E startDate, int increment, NonWorkingDayChecker<E> checker) For a given date, adjust it if required but using the logic across Month/etc for calc
String	getType() Give the type name for this algorithm.
E	moveCurrentDate(BaseCalculator<E> calculator) If the current date of the give calculator is a non-working day, it will be moved according to the algorithm implemented.

Method Detail

moveCurrentDate

E moveCurrentDate(BaseCalculator<E> calculator)

If the current date of the give calculator is a non-working day, it will be moved according to the algorithm implemented.

Parameters:

calculator - the calculator

Returns:

the date which may have moved.

adjustDate

E adjustDate(E startDate,
             int increment,
             NonWorkingDayChecker<E> checker)

For a given date, adjust it if required but using the logic across Month/etc for calc

Parameters:

startDate -

increment -

checker -

Returns:

getType

String getType()

Give the type name for this algorithm.

Returns:

algorithm name.