AbstractTrigger (ph-mini-quartz 4.2.0 API)

java.lang.Object
- com.helger.quartz.impl.triggers.AbstractTrigger<IMPLTYPE>

Type Parameters:

IMPLTYPE - Implementation type

All Implemented Interfaces:

com.helger.commons.lang.ICloneable<IMPLTYPE>, ITrigger, IMutableTrigger, IOperableTrigger, Comparable<ITrigger>

Direct Known Subclasses:

CalendarIntervalTrigger, CronTrigger, DailyTimeIntervalTrigger, SimpleTrigger
```
public abstract class AbstractTrigger<IMPLTYPE extends AbstractTrigger<IMPLTYPE>>
extends Object
implements IOperableTrigger, com.helger.commons.lang.ICloneable<IMPLTYPE>
```
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 IScheduler.

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

Nested Class Summary
- Nested classes/interfaces inherited from interface com.helger.quartz.ITrigger
  ITrigger.ECompletedExecutionInstruction, ITrigger.EMisfireInstruction, ITrigger.ETriggerState

Field Summary
- Fields inherited from interface com.helger.quartz.ITrigger
  DEFAULT_PRIORITY

Constructor Summary

Constructors
Modifier	Constructor and Description
	`AbstractTrigger()` Create a `Trigger` with no specified name, group, or `IJobDetail`.
`protected`	`AbstractTrigger(AbstractTrigger<IMPLTYPE> aOther)` Copy constructor
	`AbstractTrigger(String name)` Create a `Trigger` with the given name, and default group.
	`AbstractTrigger(String name, String group)` Create a `Trigger` with the given name, and group.
	`AbstractTrigger(String name, String group, String jobName, String jobGroup)` Create a `Trigger` with the given name, and group.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(ITrigger aOther)` 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.
`boolean`	`equals(Object o)` Trigger equality is based upon the equality of the TriggerKey.
`ITrigger.ECompletedExecutionInstruction`	`executionComplete(IJobExecutionContext context, JobExecutionException result)` This method should not be used by the Quartz client.
`String`	`getCalendarName()` Get the name of the `ICalendar` associated with this Trigger.
`String`	`getDescription()` Return the description given to the `Trigger` instance by its creator (if any).
`String`	`getFireInstanceId()` This method should not be used by the Quartz client.
`String`	`getFullJobName()` Returns the 'full name' of the `Job` that the `Trigger` points to, in the format "group.name".
`String`	`getFullName()` Returns the 'full name' of the `Trigger` in the format "group.name".
`String`	`getGroup()` Get the group of this `Trigger`.
`JobDataMap`	`getJobDataMap()` Get the `JobDataMap` that is associated with the `Trigger`.
`String`	`getJobGroup()` Get the name of the associated `IJobDetail`'s group.
`JobKey`	`getJobKey()`
`String`	`getJobName()` Get the name of the associated `IJobDetail`.
`TriggerKey`	`getKey()`
`ITrigger.EMisfireInstruction`	`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 set as this property's value.
`String`	`getName()` Get the name of this `Trigger`.
`int`	`getPriority()` The priority of a `Trigger` acts as a tiebreaker such that if two `Trigger`s have the same scheduled fire time, then the one with the higher priority will get first access to a worker thread.
`abstract IScheduleBuilder<IMPLTYPE>`	`getScheduleBuilder()` Get a `IScheduleBuilder` that is configured to produce a schedule identical to this trigger's schedule.
`TriggerBuilder<IMPLTYPE>`	`getTriggerBuilder()` Get a `TriggerBuilder` that is configured to produce a `Trigger` identical to this one.
`int`	`hashCode()`
`void`	`setCalendarName(String sCalendarName)` Associate the `Calendar` with the given name with this Trigger.
`void`	`setDescription(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(String id)` This method should not be used by the Quartz client.
`void`	`setGroup(String group)` Set the name of this `Trigger`.
`void`	`setJobDataMap(JobDataMap jobDataMap)` Set the `JobDataMap` to be associated with the `Trigger`.
`void`	`setJobGroup(String jobGroup)` Set the name of the associated `IJobDetail`'s group.
`void`	`setJobKey(JobKey key)`
`void`	`setJobName(String jobName)` Set the name of the associated `IJobDetail`.
`void`	`setKey(TriggerKey key)`
`void`	`setMisfireInstruction(ITrigger.EMisfireInstruction 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(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 `Trigger`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.
`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(ITrigger.EMisfireInstruction candidateMisfireInstruction)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.helger.quartz.spi.IOperableTrigger
computeFirstFireTime, getClone, setNextFireTime, setPreviousFireTime, triggered, updateAfterMisfire, updateWithNewCalendar

Methods inherited from interface com.helger.quartz.spi.IMutableTrigger
setEndTime, setStartTime

Methods inherited from interface com.helger.quartz.ITrigger
getEndTime, getFinalFireTime, getFireTimeAfter, getNextFireTime, getPreviousFireTime, getStartTime, mayFireAgain

Methods inherited from interface com.helger.commons.lang.ICloneable
getClone

- Constructor Detail
  - AbstractTrigger
```
protected AbstractTrigger(@Nonnull
                          AbstractTrigger<IMPLTYPE> aOther)
```
    Copy constructor
    
    Parameters:
    
    aOther - Calendar to copy from. May not be null.
  - AbstractTrigger
```
public AbstractTrigger()
```
    Create a Trigger with no specified name, group, or IJobDetail.
    
    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 IScheduler.
  - AbstractTrigger
```
public AbstractTrigger(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 IScheduler.
    
    Throws:
    
    IllegalArgumentException - if name is null or empty, or the group is an empty string.
  - AbstractTrigger
```
public AbstractTrigger(String name,
                       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 IScheduler.
    
    Parameters:
    
    group - if null, Scheduler.DEFAULT_GROUP will be used.
    
    Throws:
    
    IllegalArgumentException - if name is null or empty, or the group is an empty string.
  - AbstractTrigger
```
public AbstractTrigger(String name,
                       String group,
                       String jobName,
                       String jobGroup)
```
    Create a Trigger with the given name, and group.
    
    Parameters:
    
    group - if null, Scheduler.DEFAULT_GROUP will be used.
    
    Throws:
    
    IllegalArgumentException - if name is null or empty, or the group is an empty string.
- Method Detail
  - getName
```
public final String getName()
```
    Get the name of this Trigger.
  - setName
```
public final void setName(@Nonnull
                          String name)
```
    Set the name of this Trigger.
    
    Throws:
    
    IllegalArgumentException - if name is null or empty.
  - getGroup
```
public final String getGroup()
```
    Get the group of this Trigger.
  - setGroup
```
public final void setGroup(@Nullable
                           String group)
```
    Set the name of this Trigger.
    
    Parameters:
    
    group - if null, Scheduler.DEFAULT_GROUP will be used.
    
    Throws:
    
    IllegalArgumentException - if group is an empty string.
  - setKey
```
public final void setKey(@Nonnull
                         TriggerKey key)
```
    Specified by:
    
    setKey in interface IMutableTrigger
  - getJobName
```
public final String getJobName()
```
    Get the name of the associated IJobDetail.
  - setJobName
```
public final void setJobName(@Nonnull
                             String jobName)
```
    Set the name of the associated IJobDetail.
    
    Throws:
    
    IllegalArgumentException - if jobName is null or empty.
  - getJobGroup
```
public final String getJobGroup()
```
    Get the name of the associated IJobDetail's group.
  - setJobGroup
```
public final void setJobGroup(@Nullable
                              String jobGroup)
```
    Set the name of the associated IJobDetail's group.
    
    Parameters:
    
    jobGroup - if null, Scheduler.DEFAULT_GROUP will be used.
    
    Throws:
    
    IllegalArgumentException - if group is an empty string.
  - setJobKey
```
public final void setJobKey(@Nonnull
                            JobKey key)
```
    Specified by:
    
    setJobKey in interface IMutableTrigger
  - getFullName
```
@Nonnull
public final String getFullName()
```
    Returns the 'full name' of the Trigger in the format "group.name".
  - getKey
```
@Nullable
public final TriggerKey getKey()
```
    Specified by:
    
    getKey in interface ITrigger
  - getJobKey
```
@Nullable
public final JobKey getJobKey()
```
    Specified by:
    
    getJobKey in interface ITrigger
  - getFullJobName
```
@Nonnull
public final String getFullJobName()
```
    Returns the 'full name' of the Job that the Trigger points to, in the format "group.name".
  - getDescription
```
@Nullable
public final String getDescription()
```
    Description copied from interface: ITrigger
    
    Return the description given to the Trigger instance by its creator (if any).
    
    Specified by:
    
    getDescription in interface ITrigger
    
    Returns:
    
    null if no description was set.
  - setDescription
```
public final void setDescription(@Nullable
                                 String description)
```
    Description copied from interface: IMutableTrigger
    
    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 IMutableTrigger
  - getCalendarName
```
@Nullable
public final String getCalendarName()
```
    Description copied from interface: ITrigger
    
    Get the name of the ICalendar associated with this Trigger.
    
    Specified by:
    
    getCalendarName in interface ITrigger
    
    Returns:
    
    null if there is no associated Calendar.
  - setCalendarName
```
public final void setCalendarName(@Nullable
                                  String sCalendarName)
```
    Description copied from interface: IMutableTrigger
    
    Associate the Calendar with the given name with this Trigger.
    
    Specified by:
    
    setCalendarName in interface IMutableTrigger
    
    Parameters:
    
    sCalendarName - use null to dis-associate a Calendar.
  - getJobDataMap
```
@Nonnull
public final JobDataMap getJobDataMap()
```
    Description copied from interface: ITrigger
    
    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 ITrigger
  - setJobDataMap
```
public final void setJobDataMap(@Nullable
                                JobDataMap jobDataMap)
```
    Description copied from interface: IMutableTrigger
    
    Set the JobDataMap to be associated with the Trigger.
    
    Specified by:
    
    setJobDataMap in interface IMutableTrigger
    
    Parameters:
    
    jobDataMap - The new job data map. May be null.
  - getPriority
```
public final int getPriority()
```
    Description copied from interface: ITrigger
    
    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 ITrigger
    
    See Also:
    
    ITrigger.DEFAULT_PRIORITY
  - setPriority
```
public final void setPriority(int priority)
```
    Description copied from interface: IMutableTrigger
    
    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 IMutableTrigger
    
    See Also:
    
    ITrigger.DEFAULT_PRIORITY
  - executionComplete
```
@Nonnull
public ITrigger.ECompletedExecutionInstruction executionComplete(IJobExecutionContext context,
                                                                           @Nullable
                                                                           JobExecutionException result)
```
    This method should not be used by the Quartz client.
    Called after the IScheduler has executed the IJobDetail associated with the Trigger in order to get the final instruction code from the trigger.
    
    Specified by:
    
    executionComplete in interface IOperableTrigger
    
    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:
    
    ITrigger.ECompletedExecutionInstruction, IOperableTrigger.triggered(ICalendar)
  - getMisfireInstruction
```
public final ITrigger.EMisfireInstruction getMisfireInstruction()
```
    Description copied from interface: ITrigger
    
    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 set as this property's value.
    If not explicitly set, the default value is MISFIRE_INSTRUCTION_SMART_POLICY.
    
    Specified by:
    
    getMisfireInstruction in interface ITrigger
    
    See Also:
    
    ISimpleTrigger, ICronTrigger
  - setMisfireInstruction
```
public final void setMisfireInstruction(ITrigger.EMisfireInstruction misfireInstruction)
```
    Description copied from interface: IMutableTrigger
    
    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 IMutableTrigger
    
    See Also:
    
    IOperableTrigger.updateAfterMisfire(com.helger.quartz.ICalendar), ISimpleTrigger, ICronTrigger
  - validateMisfireInstruction
```
protected abstract boolean validateMisfireInstruction(ITrigger.EMisfireInstruction candidateMisfireInstruction)
```
  - 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 IOperableTrigger
    
    Throws:
    
    IllegalStateException - if a required property (such as Name, Group, Class) is not set.
    
    SchedulerException
  - getFireInstanceId
```
@Nullable
public final String getFireInstanceId()
```
    Description copied from interface: IOperableTrigger
    
    This method should not be used by the Quartz client.
    
    Specified by:
    
    getFireInstanceId in interface IOperableTrigger
  - setFireInstanceId
```
public final void setFireInstanceId(@Nullable
                                    String id)
```
    Description copied from interface: IOperableTrigger
    
    This method should not be used by the Quartz client.
    Usable by IJobStore implementations, in order to facilitate 'recognizing' instances of fired Trigger s as their jobs complete execution.
    
    Specified by:
    
    setFireInstanceId in interface IOperableTrigger
  - toString
```
public String toString()
```
    Return a simple string representation of this object.
    
    Overrides:
    
    toString in class Object
  - compareTo
```
public int compareTo(@Nonnull
                     ITrigger aOther)
```
    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 ITrigger
    
    Specified by:
    
    compareTo in interface Comparable<ITrigger>
  - equals
```
public boolean equals(Object o)
```
    Trigger equality is based upon the equality of the TriggerKey.
    
    Specified by:
    
    equals in interface ITrigger
    
    Overrides:
    
    equals in class Object
    
    Returns:
    
    true if the key of this Trigger equals that of the given Trigger.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - getTriggerBuilder
```
@Nonnull
public TriggerBuilder<IMPLTYPE> getTriggerBuilder()
```
    Description copied from interface: ITrigger
    
    Get a TriggerBuilder that is configured to produce a Trigger identical to this one.
    
    Specified by:
    
    getTriggerBuilder in interface ITrigger
    
    See Also:
    
    ITrigger.getScheduleBuilder()
  - getScheduleBuilder
```
@Nonnull
public abstract IScheduleBuilder<IMPLTYPE> getScheduleBuilder()
```
    Description copied from interface: ITrigger
    
    Get a IScheduleBuilder that is configured to produce a schedule identical to this trigger's schedule.
    
    Specified by:
    
    getScheduleBuilder in interface ITrigger
    
    See Also:
    
    ITrigger.getTriggerBuilder()

Class AbstractTrigger<IMPLTYPE extends AbstractTrigger<IMPLTYPE>>

Nested Class Summary

Nested classes/interfaces inherited from interface com.helger.quartz.ITrigger

Field Summary

Fields inherited from interface com.helger.quartz.ITrigger

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.helger.quartz.spi.IOperableTrigger

Methods inherited from interface com.helger.quartz.spi.IMutableTrigger

Methods inherited from interface com.helger.quartz.ITrigger

Methods inherited from interface com.helger.commons.lang.ICloneable

Constructor Detail

AbstractTrigger

AbstractTrigger

AbstractTrigger

AbstractTrigger

AbstractTrigger

Method Detail

getName

setName

getGroup

setGroup

setKey

getJobName

setJobName

getJobGroup

setJobGroup

setJobKey

getFullName

getKey

getJobKey

getFullJobName

getDescription

setDescription

getCalendarName

setCalendarName

getJobDataMap

setJobDataMap

getPriority

setPriority

executionComplete

getMisfireInstruction

setMisfireInstruction

validateMisfireInstruction

validate

getFireInstanceId

setFireInstanceId

toString

compareTo

equals

hashCode

getTriggerBuilder

getScheduleBuilder