CalendarIntervalTrigger (Quartz Parent POM 2.0.1 API)
From Quartz Java
|
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
org.quartz Interface CalendarIntervalTrigger
- All Superinterfaces:
- Cloneable, Comparable<Trigger>, Serializable, Trigger
- All Known Implementing Classes:
- CalendarIntervalTriggerImpl
public interface CalendarIntervalTrigger
- extends Trigger
A concrete Trigger that is used to fire a JobDetail
based upon repeating calendar time intervals.
The trigger will fire every N (see #setRepeatInterval(int) ) units of calendar time
(see #setRepeatIntervalUnit(IntervalUnit)) as specified in the trigger's definition.
This trigger can achieve schedules that are not possible with SimpleTrigger (e.g
because months are not a fixed number of seconds) or CronTrigger (e.g. because
"every 5 months" is not an even divisor of 12).
If you use an interval unit of MONTH then care should be taken when setting
a startTime value that is on a day near the end of the month. For example,
if you choose a start time that occurs on January 31st, and have a trigger with unit
MONTH and interval 1, then the next fire time will be February 28th,
and the next time after that will be March 28th - and essentially each subsequent firing will
occur on the 28th of the month, even if a 31st day exists. If you want a trigger that always
fires on the last day of the month - regardless of the number of days in the month,
you should use CronTrigger.
- Author:
- James House
- See Also:
TriggerBuilder,
CalendarIntervalScheduleBuilder,
SimpleScheduleBuilder,
CronScheduleBuilder
Nested Class Summary
Nested classes/interfaces inherited from interface org.quartz.Trigger
Trigger.CompletedExecutionInstruction, Trigger.TriggerState, Trigger.TriggerTimeComparator
Field Summary
static int
MISFIRE_INSTRUCTION_DO_NOTHING
Instructs the Scheduler that upon a mis-fire
situation, the CalendarIntervalTrigger wants to have it's
next-fire-time updated to the next time in the schedule after the
current time (taking into account any associated Calendar,
but it does not want to be fired now.
static int
MISFIRE_INSTRUCTION_FIRE_ONCE_NOW
Instructs the Scheduler that upon a mis-fire
situation, the CalendarIntervalTrigger wants to be
fired now by Scheduler.
Fields inherited from interface org.quartz.Trigger
DEFAULT_PRIORITY, MISFIRE_INSTRUCTION_IGNORE_MISFIRE_POLICY, MISFIRE_INSTRUCTION_SMART_POLICY, serialVersionUID
Method Summary
int
getRepeatInterval()
Get the the time interval that will be added to the DateIntervalTrigger's
fire time (in the set repeat interval unit) in order to calculate the time of the
next trigger repeat.
DateBuilder.IntervalUnit
getRepeatIntervalUnit()
Get the interval unit - the time unit on with the interval applies.
int
getTimesTriggered()
Get the number of times the DateIntervalTrigger has already
fired.
TriggerBuilder<CalendarIntervalTrigger>
getTriggerBuilder()
Get a TriggerBuilder that is configured to produce a
Trigger identical to this one.
Methods inherited from interface org.quartz.Trigger
compareTo, equals, getCalendarName, getDescription, getEndTime, getFinalFireTime, getFireTimeAfter, getJobDataMap, getJobKey, getKey, getMisfireInstruction, getNextFireTime, getPreviousFireTime, getPriority, getScheduleBuilder, getStartTime, mayFireAgain
Field Detail
MISFIRE_INSTRUCTION_FIRE_ONCE_NOW
static final int MISFIRE_INSTRUCTION_FIRE_ONCE_NOW
Instructs the Scheduler that upon a mis-fire
situation, the CalendarIntervalTrigger wants to be
fired now by Scheduler.
- See Also:
- Constant Field Values
MISFIRE_INSTRUCTION_DO_NOTHING
static final int MISFIRE_INSTRUCTION_DO_NOTHING
Instructs the Scheduler that upon a mis-fire
situation, the CalendarIntervalTrigger wants to have it's
next-fire-time updated to the next time in the schedule after the
current time (taking into account any associated Calendar,
but it does not want to be fired now.
- See Also:
- Constant Field Values
Method Detail
getRepeatIntervalUnit
DateBuilder.IntervalUnit getRepeatIntervalUnit()
Get the interval unit - the time unit on with the interval applies.
getRepeatInterval
int getRepeatInterval()
Get the the time interval that will be added to the DateIntervalTrigger's
fire time (in the set repeat interval unit) in order to calculate the time of the
next trigger repeat.
getTimesTriggered
int getTimesTriggered()
Get the number of times the DateIntervalTrigger has already
fired.
getTriggerBuilder
TriggerBuilder<CalendarIntervalTrigger> getTriggerBuilder()
- Description copied from interface:
Trigger
- Get a
TriggerBuilder that is configured to produce a
Trigger identical to this one.
- Specified by:
getTriggerBuilder in interface Trigger
- See Also:
Trigger.getScheduleBuilder()
PREV CLASS
NEXT CLASS
FRAMES
NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD
DETAIL: FIELD | CONSTR | METHOD
Copyright 2001-2011, Terracotta, Inc.