net.objectlab.kit.datecalc.common

Interface ReadOnlyHolidayCalendar<E>

Type Parameters:

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

All Superinterfaces:

Serializable

All Known Subinterfaces:

HolidayCalendar<E>

All Known Implementing Classes:

DefaultHolidayCalendar, ImmutableHolidayCalendar

public interface ReadOnlyHolidayCalendar<E>
extends Serializable

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.4.0

Author:

Benoit Xhenseval

Method Summary

Modifier and Type	Method and Description
E	getEarlyBoundary() Returns the earliest date covered by this HolidayCalendar.
Set<E>	getHolidays() Returns an immutable set of holidays.
E	getLateBoundary() Returns the latest date covered by this HolidayCalendar.

Method Detail

getHolidays

Set<E> getHolidays()

Returns an immutable set of holidays.

Returns:

an immutable copy of the holiday set.

getEarlyBoundary

E getEarlyBoundary()

Returns the earliest date covered by this HolidayCalendar.

Returns:

E the earliest date covered by this holiday calendar.

getLateBoundary

E getLateBoundary()

Returns the latest date covered by this HolidayCalendar.

Returns:

E the latest date covered by this holiday calendar.