de.jollyday

Class HolidayManager

java.lang.Object

de.jollyday.HolidayManager

Direct Known Subclasses:

DefaultHolidayManager

public abstract class HolidayManager
extends Object

Abstract base class for all holiday manager implementations. Upon call of getInstance method the implementing class will be read from the jollyday.properties file and instantiated.

Version:

$Id: $

Author:

Sven Diedrichsen

Field Summary

Fields

Modifier and Type	Field and Description
protected CalendarUtil	calendarUtil Utility for calendar operations

Constructor Summary

Constructors

Constructor and Description
HolidayManager()

Method Summary

Modifier and Type	Method and Description
static void	clearManagerCache() Clears the manager cache from all cached manager instances.
abstract void	doInit()
abstract CalendarHierarchy	getCalendarHierarchy() Returns the configured hierarchy structure for the specific manager.
ConfigurationDataSource	getConfigurationDataSource() Returns the ConfigurationDataSource to be used to retrieve holiday data.
abstract Set<Holiday>	getHolidays(int year, String... args) Returns the holidays for the requested year and hierarchy structure.
abstract Set<Holiday>	getHolidays(LocalDate startDateInclusive, LocalDate endDateInclusive, String... args) Returns the holidays for the requested interval and hierarchy structure.
static HolidayManager	getInstance() Creates a HolidayManager instance for the default locale country using the configured properties from the configuration file.
static HolidayManager	getInstance(HolidayCalendar c) Deprecated. Use getInstance(ManagerParameter) instead.
static HolidayManager	getInstance(HolidayCalendar c, Properties properties) Deprecated. Use getInstance(ManagerParameter) instead.
static HolidayManager	getInstance(ManagerParameter parameter) Creates and returns a HolidayManager for the provided ManagerParameters
static HolidayManager	getInstance(Properties properties) Creates a HolidayManager instance for the default locale country using the provided properties.
static HolidayManager	getInstance(String calendar) Deprecated. Use getInstance(ManagerParameter) instead.
static HolidayManager	getInstance(String calendar, Properties properties) Deprecated. Use getInstance(ManagerParameter) instead.
ManagerParameter	getManagerParameter()
static Set<String>	getSupportedCalendarCodes() Returns a set of all currently supported calendar codes.
void	init(ManagerParameter parameters) Initializes the implementing manager for the provided calendar.
boolean	isHoliday(Calendar c, String... args) Calls isHoliday with JODA time object.
boolean	isHoliday(LocalDate c, String... args) Show if the requested date is a holiday.
static boolean	isManagerCachingEnabled() isManagerCachingEnabled.
void	setConfigurationDataSource(ConfigurationDataSource configurationDataSource) Sets the configuration datasource with this holiday manager.
static void	setManagerCachingEnabled(boolean managerCachingEnabled) If true, instantiated managers will be cached.

Methods inherited from class java.lang.Object

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

Field Detail

calendarUtil

protected CalendarUtil calendarUtil

Utility for calendar operations

Constructor Detail

HolidayManager

public HolidayManager()

Method Detail

getInstance

public static HolidayManager getInstance()

Creates a HolidayManager instance for the default locale country using the configured properties from the configuration file.

Returns:

a eventually cached HolidayManager instance

getInstance

public static HolidayManager getInstance(Properties properties)

Creates a HolidayManager instance for the default locale country using the provided properties.

Parameters:

properties - the overriding configuration properties.

Returns:

a eventually cached HolidayManager instance

getInstance

@Deprecated
public static HolidayManager getInstance(HolidayCalendar c)

Deprecated. Use getInstance(ManagerParameter) instead.

Parameters:

c - the HolidayCalendar to use for creating a HolidayManager instance

Returns:

the eventually cached HolidayManager

getInstance

@Deprecated
public static HolidayManager getInstance(HolidayCalendar c,
                                                     Properties properties)

Deprecated. Use getInstance(ManagerParameter) instead.

Parameters:

c - the HolidayCalendar to use for creating a HolidayManager instance

properties - the configuration overriding Properties

Returns:

the eventually cached HolidayManager

getInstance

@Deprecated
public static HolidayManager getInstance(String calendar)

Deprecated. Use getInstance(ManagerParameter) instead.

Parameters:

calendar - the calendar to use for creating a HolidayManager instance

Returns:

the eventually cached HolidayManager

getInstance

@Deprecated
public static HolidayManager getInstance(String calendar,
                                                     Properties properties)

Deprecated. Use getInstance(ManagerParameter) instead.

Parameters:

calendar - the calendar to use for creating a HolidayManager instance

properties - the configuration overriding Properties

Returns:

the eventually cached HolidayManager

getInstance

public static HolidayManager getInstance(ManagerParameter parameter)

Creates and returns a HolidayManager for the provided ManagerParameters

Parameters:

parameter - the ManagerParameters to create the manager with

Returns:

the HolidayManager instance

setManagerCachingEnabled

public static void setManagerCachingEnabled(boolean managerCachingEnabled)

If true, instantiated managers will be cached. If false every call to getInstance will create new manager. True by default.

Parameters:

managerCachingEnabled - the managerCachingEnabled to set

isManagerCachingEnabled

public static boolean isManagerCachingEnabled()

isManagerCachingEnabled.

Returns:

the CACHING_ENABLED

clearManagerCache

public static void clearManagerCache()

Clears the manager cache from all cached manager instances.

isHoliday

public boolean isHoliday(Calendar c,
                         String... args)

Calls isHoliday with JODA time object.

Parameters:

c - a Calendar object.

args - a String object.

Returns:

a boolean.

isHoliday

public boolean isHoliday(LocalDate c,
                         String... args)

Show if the requested date is a holiday.

Parameters:

c - The potential holiday.

args - Hierarchy to request the holidays for. i.e. args = {'ny'} -> New York holidays

Returns:

is a holiday in the state/region

getSupportedCalendarCodes

public static Set<String> getSupportedCalendarCodes()

Returns a set of all currently supported calendar codes.

Returns:

Set of supported calendar codes.

setConfigurationDataSource

public void setConfigurationDataSource(ConfigurationDataSource configurationDataSource)

Sets the configuration datasource with this holiday manager.

Parameters:

configurationDataSource - the ConfigurationDataSource to use.

getConfigurationDataSource

public ConfigurationDataSource getConfigurationDataSource()

Returns the ConfigurationDataSource to be used to retrieve holiday data.

Returns:

the ConfigurationDataSource to use.

getManagerParameter

public ManagerParameter getManagerParameter()

init

public void init(ManagerParameter parameters)

Initializes the implementing manager for the provided calendar.

Parameters:

parameters - i.e. us, uk, de

doInit

public abstract void doInit()

getHolidays

public abstract Set<Holiday> getHolidays(int year,
                                         String... args)

Returns the holidays for the requested year and hierarchy structure.

Parameters:

year - i.e. 2010

args - i.e. args = {'ny'}. returns US/New York holidays. No args -> holidays common to whole country

Returns:

the list of holidays for the requested year

getHolidays

public abstract Set<Holiday> getHolidays(LocalDate startDateInclusive,
                                         LocalDate endDateInclusive,
                                         String... args)

Returns the holidays for the requested interval and hierarchy structure.

Parameters:

startDateInclusive - the start date of the interval in which holidays lie, inclusive

endDateInclusive - the end date of the interval in which holidays lie, inclusive

args - a String object.

Returns:

list of holidays within the interval

getCalendarHierarchy

public abstract CalendarHierarchy getCalendarHierarchy()

Returns the configured hierarchy structure for the specific manager. This hierarchy shows how the configured holidays are structured and can be retrieved.

Returns:

Current calendars hierarchy