net.objectlab.kit.datecalc.joda

Class YearMonthDayDateCalculator

java.lang.Object

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

net.objectlab.kit.datecalc.joda.YearMonthDayDateCalculator

All Implemented Interfaces:

DateCalculator<org.joda.time.YearMonthDay>

public class YearMonthDayDateCalculator
extends AbstractDateCalculator<org.joda.time.YearMonthDay>

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
YearMonthDayDateCalculator()
YearMonthDayDateCalculator(String name, org.joda.time.YearMonthDay startDate, HolidayCalendar<org.joda.time.YearMonthDay> nonWorkingDays, HolidayHandler<org.joda.time.YearMonthDay> holidayHandler)

Method Summary

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

calculateTenorDates, calculateTenorDates, combine, getCurrentBusinessDate, getCurrentIncrement, getHolidayCalendar, getHolidayHandler, getHolidayHandlerType, getName, getStartDate, isCurrentDateNonWorking, isNonWorkingDay, moveByBusinessDays, moveByTenor, moveByTenor, 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

YearMonthDayDateCalculator

public YearMonthDayDateCalculator()

YearMonthDayDateCalculator

public YearMonthDayDateCalculator(String name,
                                  org.joda.time.YearMonthDay startDate,
                                  HolidayCalendar<org.joda.time.YearMonthDay> nonWorkingDays,
                                  HolidayHandler<org.joda.time.YearMonthDay> holidayHandler)

Method Detail

setWorkingWeek

public DateCalculator<org.joda.time.YearMonthDay> 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(org.joda.time.YearMonthDay 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.YearMonthDay> 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<org.joda.time.YearMonthDay> createNewCalculator(String name,
                                                                         org.joda.time.YearMonthDay startDate,
                                                                         HolidayCalendar<org.joda.time.YearMonthDay> holidays,
                                                                         HolidayHandler<org.joda.time.YearMonthDay> handler)

Specified by:

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

setStartDate

public final DateCalculator<org.joda.time.YearMonthDay> setStartDate(org.joda.time.YearMonthDay startDate)

Description copied from class: AbstractDateCalculator

Set both start date and current date

Specified by:

setStartDate in interface DateCalculator<org.joda.time.YearMonthDay>

Overrides:

setStartDate in class AbstractDateCalculator<org.joda.time.YearMonthDay>

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 org.joda.time.YearMonthDay getToday()

Specified by:

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

moveByMonths

protected DateCalculator<org.joda.time.YearMonthDay> moveByMonths(int months)

Specified by:

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

compareDate

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

Specified by:

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

checkBoundary

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

clone

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

Specified by:

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