|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.quartz.impl.calendar.BaseCalendar
org.quartz.impl.calendar.WeeklyCalendar
This implementation of the Calendar excludes a set of days of the week. You may use it to exclude weekends for example. But you may define any day of the week.
Calendar
,
BaseCalendar
,
Serialized FormField Summary |
Fields inherited from interface org.quartz.Calendar |
MONTH |
Constructor Summary | |
WeeklyCalendar()
Constructor |
|
WeeklyCalendar(Calendar baseCalendar)
Constructor |
Method Summary | |
boolean |
areAllDaysExcluded()
Check if all week days are excluded. |
boolean[] |
getDaysExcluded()
Get the array with the week days |
long |
getNextIncludedTime(long timeStamp)
Determine the next time (in milliseconds) that is 'included' by the Calendar after the given time. |
boolean |
isDayExcluded(int wday)
Return true, if wday (see Calendar.get()) is defined to be exluded. |
boolean |
isTimeIncluded(long timeStamp)
Determine whether the given time (in milliseconds) is 'included' by the Calendar. |
void |
setDayExcluded(int wday,
boolean exclude)
Redefine a certain day of the week to be excluded (true) or included (false). |
void |
setDaysExcluded(boolean[] weekDays)
Redefine the array of days excluded. |
Methods inherited from class org.quartz.impl.calendar.BaseCalendar |
buildHoliday, buildHoliday, getBaseCalendar, getDescription, getJavaCalendar, setBaseCalendar, setDescription |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.quartz.Calendar |
getBaseCalendar, getDescription, setBaseCalendar, setDescription |
Constructor Detail |
public WeeklyCalendar()
Constructor
public WeeklyCalendar(Calendar baseCalendar)
Constructor
Method Detail |
public boolean[] getDaysExcluded()
Get the array with the week days
public boolean isDayExcluded(int wday)
Return true, if wday (see Calendar.get()) is defined to be exluded. E. g. saturday and sunday.
public void setDaysExcluded(boolean[] weekDays)
Redefine the array of days excluded. The array must of size greater or equal 8. java.util.Calendar's constants like MONDAY should be used as index. A value of true is regarded as: exclude it.
public void setDayExcluded(int wday, boolean exclude)
Redefine a certain day of the week to be excluded (true) or included (false). Use java.util.Calendar's constants like MONDAY to determine the wday.
public boolean areAllDaysExcluded()
Check if all week days are excluded. That is no day is included.
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. Return the original value if timeStamp is included. Return 0 if all days are excluded.
Note that this Calendar is only has full-day precision.
getNextIncludedTime
in interface Calendar
getNextIncludedTime
in class BaseCalendar
Calendar.getNextIncludedTime(long)
|
Quartz Enterprise Job Scheduler Project Page | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |