org.quartz.impl.triggers

Class AbstractTrigger<T extends Trigger>

java.lang.Object

org.quartz.impl.triggers.AbstractTrigger<T>

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<Trigger>, MutableTrigger, OperableTrigger, Trigger

Direct Known Subclasses:

CalendarIntervalTriggerImpl, CronTriggerImpl, DailyTimeIntervalTriggerImpl, SimpleTriggerImpl

public abstract class AbstractTrigger<T extends Trigger>
extends java.lang.Object
implements OperableTrigger

The base abstract class to be extended by all Triggers.

Triggers s have a name and group associated with them, which should uniquely identify them within a single Scheduler.

Triggers are the 'mechanism' by which Job s are scheduled. Many Trigger s can point to the same Job, but a single Trigger can only point to one Job.

Triggers can 'send' parameters/data to Jobs by placing contents into the JobDataMap on the Trigger.

Author:

James House, Sharada Jambula

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.quartz.Trigger

Trigger.CompletedExecutionInstruction, Trigger.TriggerState, Trigger.TriggerTimeComparator

Field Summary

Fields inherited from interface org.quartz.Trigger

DEFAULT_PRIORITY, MISFIRE_INSTRUCTION_IGNORE_MISFIRE_POLICY, MISFIRE_INSTRUCTION_SMART_POLICY

Constructor Summary

Constructors

Constructor and Description
AbstractTrigger() Create a Trigger with no specified name, group, or JobDetail.
AbstractTrigger(java.lang.String name) Create a Trigger with the given name, and default group.
AbstractTrigger(java.lang.String name, java.lang.String group) Create a Trigger with the given name, and group.
AbstractTrigger(java.lang.String name, java.lang.String group, java.lang.String jobName, java.lang.String jobGroup) Create a Trigger with the given name, and group.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone()
int	compareTo(Trigger other) Compare the next fire time of this Trigger to that of another by comparing their keys, or in other words, sorts them according to the natural (i.e.
boolean	equals(java.lang.Object o) Trigger equality is based upon the equality of the TriggerKey.
Trigger.CompletedExecutionInstruction	executionComplete(JobExecutionContext context, JobExecutionException result) This method should not be used by the Quartz client.
java.lang.String	getCalendarName() Get the name of the Calendar associated with this Trigger.
java.lang.String	getDescription() Return the description given to the Trigger instance by its creator (if any).
java.lang.String	getFireInstanceId() This method should not be used by the Quartz client.
java.lang.String	getFullJobName() Returns the 'full name' of the Job that the Trigger points to, in the format "group.name".
java.lang.String	getFullName() Returns the 'full name' of the Trigger in the format "group.name".
java.lang.String	getGroup() Get the group of this Trigger.
JobDataMap	getJobDataMap() Get the JobDataMap that is associated with the Trigger.
java.lang.String	getJobGroup() Get the name of the associated JobDetail's group.
JobKey	getJobKey()
java.lang.String	getJobName() Get the name of the associated JobDetail.
TriggerKey	getKey()
int	getMisfireInstruction() Get the instruction the Scheduler should be given for handling misfire situations for this Trigger- the concrete Trigger type that you are using will have defined a set of additional MISFIRE_INSTRUCTION_XXX constants that may be passed to this method.
java.lang.String	getName() Get the name of this Trigger.
int	getPriority() The priority of a Trigger acts as a tiebreaker such that if two Triggers have the same scheduled fire time, then the one with the higher priority will get first access to a worker thread.
abstract ScheduleBuilder<T>	getScheduleBuilder() Get a ScheduleBuilder that is configured to produce a schedule identical to this trigger's schedule.
TriggerBuilder<T>	getTriggerBuilder() Get a TriggerBuilder that is configured to produce a Trigger identical to this one.
int	hashCode()
void	setCalendarName(java.lang.String calendarName) Associate the Calendar with the given name with this Trigger.
void	setDescription(java.lang.String description) Set a description for the Trigger instance - may be useful for remembering/displaying the purpose of the trigger, though the description has no meaning to Quartz.
void	setFireInstanceId(java.lang.String id) This method should not be used by the Quartz client.
void	setGroup(java.lang.String group) Set the name of this Trigger.
void	setJobDataMap(JobDataMap jobDataMap) Set the JobDataMap to be associated with the Trigger.
void	setJobGroup(java.lang.String jobGroup) Set the name of the associated JobDetail's group.
void	setJobKey(JobKey key)
void	setJobName(java.lang.String jobName) Set the name of the associated JobDetail.
void	setKey(TriggerKey key)
void	setMisfireInstruction(int misfireInstruction) Set the instruction the Scheduler should be given for handling misfire situations for this Trigger- the concrete Trigger type that you are using will have defined a set of additional MISFIRE_INSTRUCTION_XXX constants that may be passed to this method.
void	setName(java.lang.String name) Set the name of this Trigger.
void	setPriority(int priority) The priority of a Trigger acts as a tie breaker such that if two Triggers 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.
java.lang.String	toString() Return a simple string representation of this object.
void	validate() Validates whether the properties of the JobDetail are valid for submission into a Scheduler.
protected abstract boolean	validateMisfireInstruction(int candidateMisfireInstruction)

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.quartz.spi.OperableTrigger

computeFirstFireTime, setNextFireTime, setPreviousFireTime, triggered, updateAfterMisfire, updateWithNewCalendar

Methods inherited from interface org.quartz.spi.MutableTrigger

setEndTime, setStartTime

Methods inherited from interface org.quartz.Trigger

getEndTime, getFinalFireTime, getFireTimeAfter, getNextFireTime, getPreviousFireTime, getStartTime, mayFireAgain

Constructor Detail

AbstractTrigger

public AbstractTrigger()

Create a Trigger with no specified name, group, or JobDetail.

Note that the setName(String),setGroup(String)and the setJobName(String)and setJobGroup(String)methods must be called before the Trigger can be placed into a Scheduler.

AbstractTrigger

public AbstractTrigger(java.lang.String name)

Create a Trigger with the given name, and default group.

Note that the setJobName(String)and setJobGroup(String)methods must be called before the Trigger can be placed into a Scheduler.

Throws:

java.lang.IllegalArgumentException - if name is null or empty, or the group is an empty string.

AbstractTrigger

public AbstractTrigger(java.lang.String name,
                       java.lang.String group)

Create a Trigger with the given name, and group.

Note that the setJobName(String)and setJobGroup(String)methods must be called before the Trigger can be placed into a Scheduler.

Parameters:

group - if null, Scheduler.DEFAULT_GROUP will be used.

Throws:

java.lang.IllegalArgumentException - if name is null or empty, or the group is an empty string.

AbstractTrigger

public AbstractTrigger(java.lang.String name,
                       java.lang.String group,
                       java.lang.String jobName,
                       java.lang.String jobGroup)

Create a Trigger with the given name, and group.

Parameters:

group - if null, Scheduler.DEFAULT_GROUP will be used.

Throws:

java.lang.IllegalArgumentException - if name is null or empty, or the group is an empty string.

Method Detail

getName

public java.lang.String getName()

Get the name of this Trigger.

setName

public void setName(java.lang.String name)

Set the name of this Trigger.

Throws:

java.lang.IllegalArgumentException - if name is null or empty.

getGroup

public java.lang.String getGroup()

Get the group of this Trigger.

setGroup

public void setGroup(java.lang.String group)

Set the name of this Trigger.

Parameters:

group - if null, Scheduler.DEFAULT_GROUP will be used.

Throws:

java.lang.IllegalArgumentException - if group is an empty string.

setKey

public void setKey(TriggerKey key)

Specified by:

setKey in interface MutableTrigger

getJobName

public java.lang.String getJobName()

Get the name of the associated JobDetail.

setJobName

public void setJobName(java.lang.String jobName)

Set the name of the associated JobDetail.

Throws:

java.lang.IllegalArgumentException - if jobName is null or empty.

getJobGroup

public java.lang.String getJobGroup()

Get the name of the associated JobDetail's group.

setJobGroup

public void setJobGroup(java.lang.String jobGroup)

Set the name of the associated JobDetail's group.

Parameters:

jobGroup - if null, Scheduler.DEFAULT_GROUP will be used.

Throws:

java.lang.IllegalArgumentException - if group is an empty string.

setJobKey

public void setJobKey(JobKey key)

Specified by:

setJobKey in interface MutableTrigger

getFullName

public java.lang.String getFullName()

Returns the 'full name' of the Trigger in the format "group.name".

getKey

public TriggerKey getKey()

Specified by:

getKey in interface Trigger

getJobKey

public JobKey getJobKey()

Specified by:

getJobKey in interface Trigger

getFullJobName

public java.lang.String getFullJobName()

Returns the 'full name' of the Job that the Trigger points to, in the format "group.name".

getDescription

public java.lang.String getDescription()

Return the description given to the Trigger instance by its creator (if any).

Specified by:

getDescription in interface Trigger

Returns:

null if no description was set.

setDescription

public void setDescription(java.lang.String description)

Set a description for the Trigger instance - may be useful for remembering/displaying the purpose of the trigger, though the description has no meaning to Quartz.

Specified by:

setDescription in interface MutableTrigger

setCalendarName

public void setCalendarName(java.lang.String calendarName)

Associate the Calendar with the given name with this Trigger.

Specified by:

setCalendarName in interface MutableTrigger

Parameters:

calendarName - use null to dis-associate a Calendar.

getCalendarName

public java.lang.String getCalendarName()

Get the name of the Calendar associated with this Trigger.

Specified by:

getCalendarName in interface Trigger

Returns:

null if there is no associated Calendar.

getJobDataMap

public JobDataMap getJobDataMap()

Get the JobDataMap that is associated with the Trigger.

Changes made to this map during job execution are not re-persisted, and in fact typically result in an IllegalStateException.

Specified by:

getJobDataMap in interface Trigger

setJobDataMap

public void setJobDataMap(JobDataMap jobDataMap)

Set the JobDataMap to be associated with the Trigger.

Specified by:

setJobDataMap in interface MutableTrigger

getPriority

public int getPriority()

The priority of a Trigger acts as a tiebreaker such that if two Triggers have the same scheduled fire time, then the one with the higher priority will get first access to a worker thread.

If not explicitly set, the default value is 5.

Specified by:

getPriority in interface Trigger

See Also:

Trigger.DEFAULT_PRIORITY

setPriority

public void setPriority(int priority)

The priority of a Trigger acts as a tie breaker such that if two Triggers 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.

Specified by:

setPriority in interface MutableTrigger

See Also:

Trigger.DEFAULT_PRIORITY

executionComplete

public Trigger.CompletedExecutionInstruction executionComplete(JobExecutionContext context,
                                                               JobExecutionException result)

This method should not be used by the Quartz client.

Called after the Scheduler has executed the JobDetail associated with the Trigger in order to get the final instruction code from the trigger.

Specified by:

executionComplete in interface OperableTrigger

Parameters:

context - is the JobExecutionContext that was used by the Job'sexecute(xx) method.

result - is the JobExecutionException thrown by the Job, if any (may be null).

Returns:

one of the CompletedExecutionInstruction constants.

See Also:

Trigger.CompletedExecutionInstruction, OperableTrigger.triggered(Calendar)

setMisfireInstruction

public void setMisfireInstruction(int misfireInstruction)

Set the instruction the Scheduler should be given for handling misfire situations for this Trigger- the concrete Trigger type that you are using will have defined a set of additional MISFIRE_INSTRUCTION_XXX constants that may be passed to this method.

If not explicitly set, the default value is MISFIRE_INSTRUCTION_SMART_POLICY.

Specified by:

setMisfireInstruction in interface MutableTrigger

See Also:

Trigger.MISFIRE_INSTRUCTION_SMART_POLICY, OperableTrigger.updateAfterMisfire(Calendar), SimpleTrigger, CronTrigger

validateMisfireInstruction

protected abstract boolean validateMisfireInstruction(int candidateMisfireInstruction)

getMisfireInstruction

public int getMisfireInstruction()

Get the instruction the Scheduler should be given for handling misfire situations for this Trigger- the concrete Trigger type that you are using will have defined a set of additional MISFIRE_INSTRUCTION_XXX constants that may be passed to this method.

If not explicitly set, the default value is MISFIRE_INSTRUCTION_SMART_POLICY.

Specified by:

getMisfireInstruction in interface Trigger

See Also:

Trigger.MISFIRE_INSTRUCTION_SMART_POLICY, OperableTrigger.updateAfterMisfire(Calendar), SimpleTrigger, CronTrigger

validate

public void validate()
              throws SchedulerException

Validates whether the properties of the JobDetail are valid for submission into a Scheduler.

Specified by:

validate in interface OperableTrigger

Throws:

java.lang.IllegalStateException - if a required property (such as Name, Group, Class) is not set.

SchedulerException

setFireInstanceId

public void setFireInstanceId(java.lang.String id)

This method should not be used by the Quartz client.

Usable by JobStore implementations, in order to facilitate 'recognizing' instances of fired Trigger s as their jobs complete execution.

Specified by:

setFireInstanceId in interface OperableTrigger

getFireInstanceId

public java.lang.String getFireInstanceId()

This method should not be used by the Quartz client.

Specified by:

getFireInstanceId in interface OperableTrigger

toString

public java.lang.String toString()

Return a simple string representation of this object.

Overrides:

toString in class java.lang.Object

compareTo

public int compareTo(Trigger other)

Compare the next fire time of this Trigger to that of another by comparing their keys, or in other words, sorts them according to the natural (i.e. alphabetical) order of their keys.

Specified by:

compareTo in interface java.lang.Comparable<Trigger>

Specified by:

compareTo in interface Trigger

equals

public boolean equals(java.lang.Object o)

Trigger equality is based upon the equality of the TriggerKey.

Specified by:

equals in interface Trigger

Overrides:

equals in class java.lang.Object

Returns:

true if the key of this Trigger equals that of the given Trigger.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

clone

public java.lang.Object clone()

Specified by:

clone in interface MutableTrigger

Overrides:

clone in class java.lang.Object

getTriggerBuilder

public TriggerBuilder<T> 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()

getScheduleBuilder

public abstract ScheduleBuilder<T> getScheduleBuilder()

Description copied from interface: Trigger

Get a ScheduleBuilder that is configured to produce a schedule identical to this trigger's schedule.

Specified by:

getScheduleBuilder in interface Trigger

See Also:

Trigger.getTriggerBuilder()