|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
An interface to be implemented by objects that define spaces of time
that should be included or excluded from a
's
normal 'firing' schedule.Trigger
Field Summary | |
static int |
MONTH
|
Method Summary | |
QuartzCalendar |
getBaseCalendar()
Get the base calendar. |
java.lang.String |
getDescription()
Return the description given to the QuartzCalendar instance
by its creator (if any). |
long |
getNextIncludedTime(long timeStamp)
Determine the next time (in milliseconds) that is 'included' by the QuartzCalendar after the given time. |
boolean |
isTimeIncluded(long timeStamp)
Determine whether the given time (in milliseconds) is 'included' by the QuartzCalendar. |
boolean |
isVolatile()
Whether or not the QuartzCalendar should be persisted in
the for re-use after program
restarts. |
void |
setBaseCalendar(QuartzCalendar baseCalendar)
Set a new base calendar or remove the existing one. |
void |
setDescription(java.lang.String description)
Set a description for the QuartzCalendar instance - may be
useful for remembering/displaying the purpose of the calendar, though
the description has no meaning to Quartz. |
void |
setVolatility(boolean volatility)
Set whether or not the QuartzCalendar should be persisted
in the for re-use after
program restarts. |
Field Detail |
public static final int MONTH
Method Detail |
public void setBaseCalendar(QuartzCalendar baseCalendar)
Set a new base calendar or remove the existing one.
public QuartzCalendar getBaseCalendar()
Get the base calendar. Will be null, if not set.
public boolean isVolatile()
Whether or not the QuartzCalendar
should be persisted in
the
for re-use after program
restarts.JobStore
If not explicitly set, the default value should be false
.
true
if the QuartzCalendar
should be
garbage collected along with the Scheduler
.public void setVolatility(boolean volatility)
Set whether or not the QuartzCalendar
should be persisted
in the
for re-use after
program restarts.JobStore
public boolean isTimeIncluded(long timeStamp)
Determine whether the given time (in milliseconds) is 'included' by the QuartzCalendar.
public long getNextIncludedTime(long timeStamp)
Determine the next time (in milliseconds) that is 'included' by the QuartzCalendar after the given time.
public java.lang.String getDescription()
Return the description given to the QuartzCalendar
instance
by its creator (if any).
public void setDescription(java.lang.String description)
Set a description for the QuartzCalendar
instance - may be
useful for remembering/displaying the purpose of the calendar, though
the description has no meaning to Quartz.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |