com.helger.quartz.impl.calendar

Class HolidayCalendar

java.lang.Object

com.helger.quartz.impl.calendar.AbstractCalendar<HolidayCalendar>

com.helger.quartz.impl.calendar.HolidayCalendar

All Implemented Interfaces:

com.helger.commons.lang.ICloneable<HolidayCalendar>, ICalendar

public class HolidayCalendar
extends AbstractCalendar<HolidayCalendar>

This implementation of the Calendar stores a list of holidays (full days that are excluded from scheduling).

The implementation DOES take the year into consideration, so if you want to exclude July 4th for the next 10 years, you need to add 10 entries to the exclude list.

Author:

Sharada Jambula, Juergen Donnerstag

Field Summary

Fields inherited from interface com.helger.quartz.ICalendar

MONTH

Constructor Summary

Constructors

Constructor and Description
HolidayCalendar()
HolidayCalendar(HolidayCalendar aOther)
HolidayCalendar(ICalendar baseCalendar)
HolidayCalendar(ICalendar baseCalendar, TimeZone timeZone)
HolidayCalendar(TimeZone timeZone)

Method Summary

Modifier and Type	Method and Description
void	addExcludedDate(Date excludedDate) Add the given Date to the list of excluded days.
HolidayCalendar	getClone()
SortedSet<Date>	getExcludedDates() Returns a SortedSet of Dates representing the excluded days.
long	getNextIncludedTime(long nTimeStamp) Determine the next time (in milliseconds) that is 'included' by the Calendar after the given time.
boolean	isTimeIncluded(long timeStamp) Determine whether the given time (in milliseconds) is 'included' by the Calendar.
void	removeExcludedDate(Date dateToRemove)

Methods inherited from class com.helger.quartz.impl.calendar.AbstractCalendar

createJavaCalendar, createJavaCalendar, getBaseCalendar, getDescription, getEndOfDayJavaCalendar, getStartOfDayJavaCalendar, getTimeZone, setBaseCalendar, setDescription, setTimeZone

Methods inherited from class java.lang.Object

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

Constructor Detail

HolidayCalendar

public HolidayCalendar(@Nonnull
                       HolidayCalendar aOther)

HolidayCalendar

public HolidayCalendar()

HolidayCalendar

public HolidayCalendar(ICalendar baseCalendar)

HolidayCalendar

public HolidayCalendar(TimeZone timeZone)

HolidayCalendar

public HolidayCalendar(ICalendar baseCalendar,
                       TimeZone timeZone)

Method Detail

isTimeIncluded

public boolean isTimeIncluded(long timeStamp)

Determine whether the given time (in milliseconds) is 'included' by the Calendar.

Note that this Calendar is only has full-day precision.

Specified by:

isTimeIncluded in interface ICalendar

Overrides:

isTimeIncluded in class AbstractCalendar<HolidayCalendar>

See Also:

ICalendar.isTimeIncluded(long)

getNextIncludedTime

public long getNextIncludedTime(long nTimeStamp)

Determine the next time (in milliseconds) that is 'included' by the Calendar after the given time.
Note that this Calendar is only has full-day precision.

Specified by:

getNextIncludedTime in interface ICalendar

Overrides:

getNextIncludedTime in class AbstractCalendar<HolidayCalendar>

See Also:

ICalendar.getNextIncludedTime(long)

addExcludedDate

public void addExcludedDate(Date excludedDate)

Add the given Date to the list of excluded days. Only the month, day and year of the returned dates are significant.

removeExcludedDate

public void removeExcludedDate(Date dateToRemove)

getExcludedDates

public SortedSet<Date> getExcludedDates()

Returns a SortedSet of Dates representing the excluded days. Only the month, day and year of the returned dates are significant.

getClone

@Nonnull
public HolidayCalendar getClone()