net.objectlab.kit.datecalc.joda

Class YearMonthDayIMMDateCalculator

java.lang.Object

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

net.objectlab.kit.datecalc.joda.YearMonthDayIMMDateCalculator

All Implemented Interfaces:

IMMDateCalculator<org.joda.time.YearMonthDay>

public class YearMonthDayIMMDateCalculator
extends AbstractIMMDateCalculator<org.joda.time.YearMonthDay>

Joda YearMonthDay 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
YearMonthDayIMMDateCalculator()

Method Summary

Modifier and Type	Method and Description
List<org.joda.time.YearMonthDay>	getIMMDates(org.joda.time.YearMonthDay start, org.joda.time.YearMonthDay 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.YearMonthDay	getNextIMMDate(boolean requestNextIMM, org.joda.time.YearMonthDay theStartDate, IMMPeriod period)
boolean	isIMMDate(org.joda.time.YearMonthDay 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, getPreviousIMMDate, getPreviousIMMDate

Methods inherited from class java.lang.Object

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

Constructor Detail

YearMonthDayIMMDateCalculator

public YearMonthDayIMMDateCalculator()

Method Detail

isIMMDate

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

Description copied from interface: IMMDateCalculator

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

Returns:

true if that date is an IMM date.

getNextIMMDate

protected org.joda.time.YearMonthDay getNextIMMDate(boolean requestNextIMM,
                                                    org.joda.time.YearMonthDay theStartDate,
                                                    IMMPeriod period)

Specified by:

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

getIMMDates

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

Description copied from interface: IMMDateCalculator

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