|
|||||||||||
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.AnnualCalendar
This implementation of the Calendar excludes a set of days of the year. You may use it to exclude bank holidays which are on the same date every year.
Calendar
,
BaseCalendar
,
Serialized FormField Summary |
Fields inherited from interface org.quartz.Calendar |
MONTH |
Constructor Summary | |
AnnualCalendar()
Constructor |
|
AnnualCalendar(Calendar baseCalendar)
Constructor |
Method Summary | |
java.util.ArrayList |
getDaysExcluded()
Get the array which defines the exclude-value of each day of month |
long |
getNextIncludedTime(long timeStamp)
Determine the next time (in milliseconds) that is 'included' by the Calendar after the given time. |
boolean |
isDayExcluded(java.util.Calendar day)
Return true, if day is defined to be exluded. |
boolean |
isTimeIncluded(long timeStamp)
Determine whether the given time (in milliseconds) is 'included' by the Calendar. |
void |
setDayExcluded(java.util.Calendar day,
boolean exclude)
Redefine a certain day to be excluded (true) or included (false). |
void |
setDaysExcluded(java.util.ArrayList days)
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 AnnualCalendar()
Constructor
public AnnualCalendar(Calendar baseCalendar)
Constructor
Method Detail |
public java.util.ArrayList getDaysExcluded()
Get the array which defines the exclude-value of each day of month
public boolean isDayExcluded(java.util.Calendar day)
Return true, if day is defined to be exluded.
public void setDaysExcluded(java.util.ArrayList days)
Redefine the array of days excluded. The array must of size greater or equal 31.
public void setDayExcluded(java.util.Calendar day, boolean exclude)
Redefine a certain day to be excluded (true) or included (false).
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 Project Page | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |