net.objectlab.kit.datecalc.joda

Class LocalDateIMMDateCalculator

java.lang.Object

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

net.objectlab.kit.datecalc.joda.LocalDateIMMDateCalculator

All Implemented Interfaces:

IMMDateCalculator<org.joda.time.LocalDate>

public class LocalDateIMMDateCalculator
extends AbstractIMMDateCalculator<org.joda.time.LocalDate>

Joda LocalDate based implementation of the IMMDateCalculator.

Author:

Benoit Xhenseval

Field Summary

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

DAYS_IN_WEEK, MONTH_IN_YEAR, MONTHS_IN_QUARTER

Constructor Summary

Constructors

Constructor and Description
LocalDateIMMDateCalculator()

Method Summary

Modifier and Type	Method and Description
List<org.joda.time.LocalDate>	getIMMDates(org.joda.time.LocalDate start, org.joda.time.LocalDate end, IMMPeriod period) Returns a list of IMM dates between 2 dates, it will exclude the start date if it is an IMM date but would include the end date if it is an IMM.
protected org.joda.time.LocalDate	getNextIMMDate(boolean requestNextIMM, org.joda.time.LocalDate start, IMMPeriod period)
boolean	isIMMDate(org.joda.time.LocalDate date) Checks if a given date is an official IMM Date (3rd Wednesdays of March/June/Sept/Dec.

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

getIMMDates, getNextIMMDate, getNextIMMDate, getNextIMMDates, getPreviousIMMDate, getPreviousIMMDate

Methods inherited from class java.lang.Object

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

Constructor Detail

LocalDateIMMDateCalculator

public LocalDateIMMDateCalculator()

Method Detail

getIMMDates

public List<org.joda.time.LocalDate> getIMMDates(org.joda.time.LocalDate start,
                                                 org.joda.time.LocalDate end,
                                                 IMMPeriod period)

Returns a list of IMM dates between 2 dates, it will exclude the start date if it is an IMM date but would include the end date if it is an IMM.

Parameters:

start - start of the interval, excluded

end - end of the interval, may be included.

period - specify when the "next" IMM is, if quarterly then it is the conventional algorithm.

Returns:

list of IMM dates

getNextIMMDate

protected org.joda.time.LocalDate getNextIMMDate(boolean requestNextIMM,
                                                 org.joda.time.LocalDate start,
                                                 IMMPeriod period)

Specified by:

getNextIMMDate in class AbstractIMMDateCalculator<org.joda.time.LocalDate>

isIMMDate

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

Checks if a given date is an official IMM Date (3rd Wednesdays of March/June/Sept/Dec.

Parameters:

date -

Returns:

true if that date is an IMM date.