net.objectlab.kit.datecalc.common

Interface HolidayCalendar<E>

Type Parameters:

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

All Superinterfaces:

ReadOnlyHolidayCalendar<E>, Serializable

All Known Implementing Classes:

DefaultHolidayCalendar, ImmutableHolidayCalendar

public interface HolidayCalendar<E>
extends ReadOnlyHolidayCalendar<E>

A Holiday Calendar not only defines a set of holiday dates but an early and late boundary for these dates, e.g. putting the holidays for 2006 in a set with limits of 1 Jan 2006 and 31 Dec 2006 means that 2006 is covered, not that 31 Dec is a holiday itself.

Since:

1.1.0

Author:

Benoit Xhenseval

Method Summary

Modifier and Type	Method and Description
boolean	isHoliday(E date) Check if a date is a holiday.
HolidayCalendar<E>	setEarlyBoundary(E earlyBoundary) Sets the earliest date (must be <= first date in holiday set)
HolidayCalendar<E>	setHolidays(Set<E> holidays) Takes a copy of the holidays and store it in an immutable set.
HolidayCalendar<E>	setLateBoundary(E lateBoundary) Sets the latest date (must be <= first date in holiday set)

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

getEarlyBoundary, getHolidays, getLateBoundary

Method Detail

setHolidays

HolidayCalendar<E> setHolidays(Set<E> holidays)

Takes a copy of the holidays and store it in an immutable set.

setEarlyBoundary

HolidayCalendar<E> setEarlyBoundary(E earlyBoundary)

Sets the earliest date (must be <= first date in holiday set)

Parameters:

earlyBoundary -

setLateBoundary

HolidayCalendar<E> setLateBoundary(E lateBoundary)

Sets the latest date (must be <= first date in holiday set)

Parameters:

lateBoundary -

isHoliday

boolean isHoliday(E date)

Check if a date is a holiday.

Parameters:

date -

Returns:

true if the given date is in the holiday set.