net.objectlab.kit.datecalc.common

Class AbstractKitCalculatorsFactory<E extends Serializable>

java.lang.Object

net.objectlab.kit.datecalc.common.AbstractKitCalculatorsFactory<E>

Type Parameters:

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

All Implemented Interfaces:

KitCalculatorsFactory<E>

Direct Known Subclasses:

CalendarKitCalculatorsFactory, DateKitCalculatorsFactory, LocalDateKitCalculatorsFactory, LocalDateKitCalculatorsFactory

public abstract class AbstractKitCalculatorsFactory<E extends Serializable>
extends Object
implements KitCalculatorsFactory<E>

Base class for all calculator factories, it handles the holiday registration.

Author:

Marcin Jekot

Constructor Summary

Constructors

Constructor and Description
AbstractKitCalculatorsFactory()

Method Summary

Modifier and Type	Method and Description
protected CurrencyDateCalculatorBuilder<E>	configureCurrencyCalculatorBuilder(CurrencyDateCalculatorBuilder<E> builder) Method that may be called by the specialised factory methods and will fetch the registered holidayCalendar for all 3 currencies and the working weeks via the currencyCalculatorConfig and assigning currencyCalculatorConfig to the builder, using the DefaultCurrencyCalculatorConfig if not modified.
CurrencyCalculatorConfig	getCurrencyCalculatorConfig() Provides the registered instance of currencyCalculatorConfig or use DefaultCurrencyCalculatorConfig if none registered.
HolidayCalendar<E>	getHolidayCalendar(String name) Provides an immutable Holiday Calendar with that name if registered, null if not registered
Set<String>	getRegisteredHolidayCalendarNames() Provides the immutable set of registered calendar names
boolean	isHolidayCalendarRegistered(String name) Check if a calendar of a given name is already registered.
KitCalculatorsFactory<E>	registerHolidays(String name, HolidayCalendar<E> holidaysCalendar) Use this method to register a given calendar, it will replace any existing one with the same name.
void	setCurrencyCalculatorConfig(CurrencyCalculatorConfig config) Use this method register a specific currency config, if not provided then the DefaultCurrencyCalculatorConfig will be given.
protected void	setHolidays(String name, DateCalculator<E> dc) Used by extensions to set holidays in a DateCalculator.
KitCalculatorsFactory<E>	unregisterAllHolidayCalendars() unregister all holiday calendars;
KitCalculatorsFactory<E>	unregisterHolidayCalendar(String calendarName) Unregister a given holiday calendar

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.objectlab.kit.datecalc.common.KitCalculatorsFactory

buildCurrencyDateCalculator, getDateCalculator, getDefaultCurrencyDateCalculator, getDefaultCurrencyDateCalculatorBuilder, getHolidayHandler, getIMMDateCalculator, getPeriodCountCalculator

Constructor Detail

AbstractKitCalculatorsFactory

public AbstractKitCalculatorsFactory()

Method Detail

setCurrencyCalculatorConfig

public void setCurrencyCalculatorConfig(CurrencyCalculatorConfig config)

Use this method register a specific currency config, if not provided then the DefaultCurrencyCalculatorConfig will be given.

Specified by:

setCurrencyCalculatorConfig in interface KitCalculatorsFactory<E extends Serializable>

Parameters:

config - that specifies the set of currencies subject to USD T+1 and the WorkingWeeks per currency.

getCurrencyCalculatorConfig

public CurrencyCalculatorConfig getCurrencyCalculatorConfig()

Provides the registered instance of currencyCalculatorConfig or use DefaultCurrencyCalculatorConfig if none registered.

Specified by:

getCurrencyCalculatorConfig in interface KitCalculatorsFactory<E extends Serializable>

See Also:

DefaultCurrencyCalculatorConfig

registerHolidays

public KitCalculatorsFactory<E> registerHolidays(String name,
                                                 HolidayCalendar<E> holidaysCalendar)

Use this method to register a given calendar, it will replace any existing one with the same name. An immutable copy is made so that any changes outside this class will have no affect. It won't update any existing DateCalculator as these should not be amended whilst in existence (we could otherwise get inconsistent results).

Specified by:

registerHolidays in interface KitCalculatorsFactory<E extends Serializable>

Parameters:

name - the calendar name to register these holidays under.

holidaysCalendar - a calendar containing a set of holidays (non-working days).

isHolidayCalendarRegistered

public boolean isHolidayCalendarRegistered(String name)

Check if a calendar of a given name is already registered.

Specified by:

isHolidayCalendarRegistered in interface KitCalculatorsFactory<E extends Serializable>

Returns:

true if the holiday name is registered.

getHolidayCalendar

public HolidayCalendar<E> getHolidayCalendar(String name)

Provides an immutable Holiday Calendar with that name if registered, null if not registered

Specified by:

getHolidayCalendar in interface KitCalculatorsFactory<E extends Serializable>

Returns:

an immutable Holiday Calendar that is registered, null if not registered.

setHolidays

protected void setHolidays(String name,
                           DateCalculator<E> dc)

Used by extensions to set holidays in a DateCalculator.

Parameters:

name - holiday name

dc - the date calculator to configure.

getRegisteredHolidayCalendarNames

public Set<String> getRegisteredHolidayCalendarNames()

Provides the immutable set of registered calendar names

Specified by:

getRegisteredHolidayCalendarNames in interface KitCalculatorsFactory<E extends Serializable>

Returns:

an immutable set of registered calendar names

unregisterHolidayCalendar

public KitCalculatorsFactory<E> unregisterHolidayCalendar(String calendarName)

Unregister a given holiday calendar

Specified by:

unregisterHolidayCalendar in interface KitCalculatorsFactory<E extends Serializable>

Parameters:

calendarName - the calendar name to unregister.

unregisterAllHolidayCalendars

public KitCalculatorsFactory<E> unregisterAllHolidayCalendars()

unregister all holiday calendars;

Specified by:

unregisterAllHolidayCalendars in interface KitCalculatorsFactory<E extends Serializable>

configureCurrencyCalculatorBuilder

protected CurrencyDateCalculatorBuilder<E> configureCurrencyCalculatorBuilder(CurrencyDateCalculatorBuilder<E> builder)

Method that may be called by the specialised factory methods and will fetch the registered holidayCalendar for all 3 currencies and the working weeks via the currencyCalculatorConfig and assigning currencyCalculatorConfig to the builder, using the DefaultCurrencyCalculatorConfig if not modified.

Parameters:

builder - the original builder

Returns:

same instance of builder but modified