|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.quartz.impl.calendar.BaseCalendar org.quartz.impl.calendar.HolidayCalendar
public class 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.
Field Summary |
---|
Fields inherited from interface org.quartz.Calendar |
---|
MONTH |
Constructor Summary | |
---|---|
HolidayCalendar()
|
|
HolidayCalendar(Calendar baseCalendar)
|
|
HolidayCalendar(Calendar baseCalendar,
TimeZone timeZone)
|
|
HolidayCalendar(TimeZone timeZone)
|
Method Summary | |
---|---|
void |
addExcludedDate(Date excludedDate)
Add the given Date to the list of excluded days. |
Object |
clone()
|
SortedSet<Date> |
getExcludedDates()
Returns a SortedSet of Dates representing the excluded
days. |
long |
getNextIncludedTime(long timeStamp)
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 org.quartz.impl.calendar.BaseCalendar |
---|
createJavaCalendar, createJavaCalendar, getBaseCalendar, getDescription, getEndOfDayJavaCalendar, getStartOfDayJavaCalendar, getTimeZone, setBaseCalendar, setDescription, setTimeZone |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.quartz.Calendar |
---|
getBaseCalendar, getDescription, setBaseCalendar, setDescription |
Constructor Detail |
---|
public HolidayCalendar()
public HolidayCalendar(Calendar baseCalendar)
public HolidayCalendar(TimeZone timeZone)
public HolidayCalendar(Calendar baseCalendar, TimeZone timeZone)
Method Detail |
---|
public Object clone()
clone
in interface Calendar
clone
in class BaseCalendar
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.
isTimeIncluded
in interface Calendar
isTimeIncluded
in class BaseCalendar
Calendar.isTimeIncluded(long)
public long getNextIncludedTime(long timeStamp)
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.
getNextIncludedTime
in interface Calendar
getNextIncludedTime
in class BaseCalendar
Calendar.getNextIncludedTime(long)
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.
public void removeExcludedDate(Date dateToRemove)
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.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |