Package org.quartz.triggers
Interface MutableTrigger
- All Superinterfaces:
Cloneable
,Comparable<Trigger>
,Serializable
,Trigger
- All Known Subinterfaces:
OperableTrigger
- All Known Implementing Classes:
AbstractTrigger
,CronTriggerImpl
,SimpleTriggerImpl
Defines the setters for Trigger
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.quartz.triggers.Trigger
Trigger.CompletedExecutionInstruction, Trigger.TriggerTimeComparator
-
Field Summary
Fields inherited from interface org.quartz.triggers.Trigger
DEFAULT_PRIORITY, MISFIRE_INSTRUCTION_IGNORE_MISFIRE_POLICY, MISFIRE_INSTRUCTION_SMART_POLICY
-
Method Summary
Modifier and TypeMethodDescriptionclone()
void
setCalendarName
(String calendarName) Associate the
with the given name with this Trigger.Calendar
void
setDescription
(String description) Set a description for theTrigger
instance - may be useful for remembering/displaying the purpose of the trigger, though the description has no meaning to Quartz.void
setEndTime
(Date endTime) Set the time at which theTrigger
should quit repeating - regardless of any remaining repeats (based on the trigger's particular repeat settings).void
setJobDataMap
(JobDataMap jobDataMap) Set theJobDataMap
to be associated with theTrigger
.void
setJobName
(String key) Set the name of the associated
.JobDetail
void
setMisfireInstruction
(int misfireInstruction) Set the instruction theScheduler
should be given for handling misfire situations for thisTrigger
- the concreteTrigger
type that you are using will have defined a set of additionalMISFIRE_INSTRUCTION_XXX
constants that may be passed to this method.void
Set the name of thisTrigger
.void
setPriority
(int priority) The priority of aTrigger
acts as a tie breaker such that if twoTrigger
s have the same scheduled fire time, then Quartz will do its best to give the one with the higher priority first access to a worker thread.void
setStartTime
(Date startTime) The time at which the trigger's scheduling should start.Methods inherited from interface java.lang.Comparable
compareTo
Methods inherited from interface org.quartz.triggers.Trigger
equals, getCalendarName, getDescription, getEndTime, getFinalFireTime, getFireTimeAfter, getJobDataMap, getJobName, getMisfireInstruction, getName, getNextFireTime, getPreviousFireTime, getPriority, getStartTime, mayFireAgain
-
Method Details
-
setName
Set the name of thisTrigger
.- Throws:
IllegalArgumentException
- if name is null or empty.
-
setJobName
Set the name of the associated
.JobDetail
- Throws:
IllegalArgumentException
- if jobName is null or empty.
-
setDescription
Set a description for theTrigger
instance - may be useful for remembering/displaying the purpose of the trigger, though the description has no meaning to Quartz. -
setCalendarName
Associate the
with the given name with this Trigger.Calendar
- Parameters:
calendarName
- usenull
to dis-associate a Calendar.
-
setJobDataMap
Set theJobDataMap
to be associated with theTrigger
. -
setPriority
void setPriority(int priority) The priority of aTrigger
acts as a tie breaker such that if twoTrigger
s have the same scheduled fire time, then Quartz will do its best to give the one with the higher priority first access to a worker thread.If not explicitly set, the default value is
5
.- See Also:
-
setStartTime
The time at which the trigger's scheduling should start. May or may not be the first actual fire time of the trigger, depending upon the type of trigger and the settings of the other properties of the trigger. However the first actual first time will not be before this date.Setting a value in the past may cause a new trigger to compute a first fire time that is in the past, which may cause an immediate misfire of the trigger.
-
setEndTime
Set the time at which theTrigger
should quit repeating - regardless of any remaining repeats (based on the trigger's particular repeat settings).- See Also:
-
-
invalid @see
TriggerUtils#computeEndTimeToAllowParticularNumberOfFirings(Trigger, Calendar, int)
-
-
setMisfireInstruction
void setMisfireInstruction(int misfireInstruction) Set the instruction theScheduler
should be given for handling misfire situations for thisTrigger
- the concreteTrigger
type that you are using will have defined a set of additionalMISFIRE_INSTRUCTION_XXX
constants that may be passed to this method.If not explicitly set, the default value is
MISFIRE_INSTRUCTION_SMART_POLICY
.- See Also:
-
Trigger.MISFIRE_INSTRUCTION_SMART_POLICY
-
invalid @see
#updateAfterMisfire(Calendar)
SimpleTrigger
CronTrigger
-
clone
Object clone()
-