com.helger.quartz.impl.triggers

Class SimpleTrigger

java.lang.Object

com.helger.quartz.impl.triggers.AbstractTrigger<SimpleTrigger>

com.helger.quartz.impl.triggers.SimpleTrigger

All Implemented Interfaces:

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

public class SimpleTrigger
extends AbstractTrigger<SimpleTrigger>
implements ISimpleTrigger

A concrete ITrigger that is used to fire a IJobDetail at a given moment in time, and optionally repeated at a specified interval.

Author:

James House, contributions by Lieven Govaerts of Ebitec Nv, Belgium.

See Also:

ITrigger, ICronTrigger, TriggerUtils

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.ISimpleTrigger

REPEAT_INDEFINITELY

Fields inherited from interface com.helger.quartz.ITrigger

DEFAULT_PRIORITY

Constructor Summary

Constructors

Constructor and Description
SimpleTrigger() Create a SimpleTrigger with no settings.
SimpleTrigger(SimpleTrigger aOther)

Method Summary

Modifier and Type	Method and Description
Date	computeFirstFireTime(ICalendar calendar) Called by the scheduler at the time a Trigger is first added to the scheduler, in order to have the Trigger compute its first fire time, based on any associated calendar.
int	computeNumTimesFiredBetween(Date start, Date end)
static SimpleTrigger	create(String name, String group, String jobName, String jobGroup, Date startTime, Date endTime, int repeatCount, long repeatInterval)
boolean	equals(Object o) Trigger equality is based upon the equality of the TriggerKey.
SimpleTrigger	getClone()
Date	getEndTime() Get the time at which the Trigger should quit repeating - regardless of any remaining repeats (based on the trigger's particular repeat settings).
Date	getFinalFireTime() Returns the final time at which the SimpleTrigger will fire, if repeatCount is REPEAT_INDEFINITELY, null will be returned.
Date	getFireTimeAfter(Date aAfterTime) Returns the next time at which the SimpleTrigger will fire, after the given time.
Date	getFireTimeBefore(Date end) Returns the last time at which the SimpleTrigger will fire, before the given time.
Date	getNextFireTime() Returns the next time at which the Trigger is scheduled to fire.
Date	getPreviousFireTime() Returns the previous time at which the SimpleTrigger fired.
int	getRepeatCount() Get the the number of times the SimpleTrigger should repeat, after which it will be automatically deleted.
long	getRepeatInterval() Get the the time interval (in milliseconds) at which the SimpleTrigger should repeat.
IScheduleBuilder<SimpleTrigger>	getScheduleBuilder() Get a IScheduleBuilder that is configured to produce a schedule identical to this trigger's schedule.
Date	getStartTime() Get the time at which the Trigger should occur.
int	getTimesTriggered() Get the number of times the SimpleTrigger has already fired.
int	hashCode()
boolean	mayFireAgain() Determines whether or not the SimpleTrigger will occur again.
void	setEndTime(Date endTime) Set the time at which the Trigger should quit repeating - regardless of any remaining repeats (based on the trigger's particular repeat settings).
void	setNextFireTime(Date nextFireTime) Set the next time at which the SimpleTrigger should fire.
void	setPreviousFireTime(Date previousFireTime) Set the previous time at which the SimpleTrigger fired.
void	setRepeatCount(int repeatCount) Set the the number of time the SimpleTrigger should repeat, after which it will be automatically deleted.
void	setRepeatInterval(long repeatInterval) Set the the time interval (in milliseconds) at which the SimpleTrigger should repeat.
void	setStartTime(Date startTime) The time at which the trigger's scheduling should start.
void	setTimesTriggered(int timesTriggered) Set the number of times the SimpleTrigger has already fired.
void	triggered(ICalendar calendar) Called when the IScheduler has decided to 'fire' the trigger (execute the associated Job), in order to give the Trigger a chance to update itself for its next triggering (if any).
void	updateAfterMisfire(ICalendar cal) Updates the SimpleTrigger's state based on the MISFIRE_INSTRUCTION_XXX that was selected when the SimpleTrigger was created.
void	updateWithNewCalendar(ICalendar calendar, long misfireThreshold) This method should not be used by the Quartz client.
void	validate() Validates whether the properties of the JobDetail are valid for submission into a Scheduler.
protected boolean	validateMisfireInstruction(ITrigger.EMisfireInstruction misfireInstruction)

Methods inherited from class com.helger.quartz.impl.triggers.AbstractTrigger

compareTo, executionComplete, getCalendarName, getDescription, getFireInstanceId, getFullJobName, getFullName, getGroup, getJobDataMap, getJobGroup, getJobKey, getJobName, getKey, getMisfireInstruction, getName, getPriority, getTriggerBuilder, setCalendarName, setDescription, setFireInstanceId, setGroup, setJobDataMap, setJobGroup, setJobKey, setJobName, setKey, setMisfireInstruction, setName, setPriority, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.quartz.ISimpleTrigger

getTriggerBuilder

Methods inherited from interface com.helger.quartz.ITrigger

compareTo, getCalendarName, getDescription, getJobDataMap, getJobKey, getKey, getMisfireInstruction, getPriority

Constructor Detail

SimpleTrigger

public SimpleTrigger(@Nonnull
                     SimpleTrigger aOther)

SimpleTrigger

public SimpleTrigger()

Create a SimpleTrigger with no settings.

Method Detail

getStartTime

@Nullable
public final Date getStartTime()

Description copied from interface: ITrigger

Get the time at which the Trigger should occur.

Specified by:

getStartTime in interface ITrigger

Returns:

The start. May be null depending on the implementation

setStartTime

public void setStartTime(@Nonnull
                         Date startTime)

Description copied from interface: IMutableTrigger

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.

Specified by:

setStartTime in interface IMutableTrigger

Parameters:

startTime - start time

getEndTime

@Nullable
public final Date getEndTime()

Description copied from interface: ITrigger

Get the time at which the Trigger should quit repeating - regardless of any remaining repeats (based on the trigger's particular repeat settings).

Specified by:

getEndTime in interface ITrigger

Returns:

the end time or null.

See Also:

ITrigger.getFinalFireTime()

setEndTime

public final void setEndTime(@Nullable
                             Date endTime)

Description copied from interface: IMutableTrigger

Set the time at which the Trigger should quit repeating - regardless of any remaining repeats (based on the trigger's particular repeat settings).

Specified by:

setEndTime in interface IMutableTrigger

See Also:

TriggerUtils.computeEndTimeToAllowParticularNumberOfFirings(IOperableTrigger,com.helger.quartz.ICalendar,int)

getRepeatCount

public int getRepeatCount()

Description copied from interface: ISimpleTrigger

Get the the number of times the SimpleTrigger should repeat, after which it will be automatically deleted.

Specified by:

getRepeatCount in interface ISimpleTrigger

See Also:

ISimpleTrigger.REPEAT_INDEFINITELY

setRepeatCount

public void setRepeatCount(int repeatCount)

Set the the number of time the SimpleTrigger should repeat, after which it will be automatically deleted.

Throws:

IllegalArgumentException - if repeatCount is < 0

See Also:

ISimpleTrigger.REPEAT_INDEFINITELY

getRepeatInterval

public long getRepeatInterval()

Description copied from interface: ISimpleTrigger

Get the the time interval (in milliseconds) at which the SimpleTrigger should repeat.

Specified by:

getRepeatInterval in interface ISimpleTrigger

setRepeatInterval

public void setRepeatInterval(long repeatInterval)

Set the the time interval (in milliseconds) at which the SimpleTrigger should repeat.

Throws:

IllegalArgumentException - if repeatInterval is < 0

getTimesTriggered

public int getTimesTriggered()

Get the number of times the SimpleTrigger has already fired.

Specified by:

getTimesTriggered in interface ISimpleTrigger

setTimesTriggered

public void setTimesTriggered(int timesTriggered)

Set the number of times the SimpleTrigger has already fired.

validateMisfireInstruction

protected boolean validateMisfireInstruction(ITrigger.EMisfireInstruction misfireInstruction)

Specified by:

validateMisfireInstruction in class AbstractTrigger<SimpleTrigger>

updateAfterMisfire

public void updateAfterMisfire(ICalendar cal)

Updates the SimpleTrigger's state based on the MISFIRE_INSTRUCTION_XXX that was selected when the SimpleTrigger was created.

If the misfire instruction is set to MISFIRE_INSTRUCTION_SMART_POLICY, then the following scheme will be used:

• If the Repeat Count is 0, then the instruction will be interpreted as MISFIRE_INSTRUCTION_FIRE_NOW.
• If the Repeat Count is REPEAT_INDEFINITELY, then the instruction will be interpreted as MISFIRE_INSTRUCTION_RESCHEDULE_NEXT_WITH_REMAINING_COUNT. WARNING: using MISFIRE_INSTRUCTION_RESCHEDULE_NEXT_WITH_REMAINING_COUNT with a trigger that has a non-null end-time may cause the trigger to never fire again if the end-time arrived during the misfire time span.
• If the Repeat Count is > 0, then the instruction will be interpreted as MISFIRE_INSTRUCTION_RESCHEDULE_NOW_WITH_EXISTING_REPEAT_COUNT.

Specified by:

updateAfterMisfire in interface IOperableTrigger

triggered

public void triggered(ICalendar calendar)

Called when the IScheduler has decided to 'fire' the trigger (execute the associated Job), in order to give the Trigger a chance to update itself for its next triggering (if any).

Specified by:

triggered in interface IOperableTrigger

See Also:

AbstractTrigger.executionComplete(com.helger.quartz.IJobExecutionContext, com.helger.quartz.JobExecutionException)

updateWithNewCalendar

public void updateWithNewCalendar(ICalendar calendar,
                                  long misfireThreshold)

Description copied from interface: IOperableTrigger

This method should not be used by the Quartz client.
To be implemented by the concrete class.
The implementation should update the Trigger's state based on the given new version of the associated Calendar (the state should be updated so that it's next fire time is appropriate given the Calendar's new settings).

Specified by:

updateWithNewCalendar in interface IOperableTrigger

See Also:

IOperableTrigger.updateWithNewCalendar(com.helger.quartz.ICalendar, long)

computeFirstFireTime

public Date computeFirstFireTime(ICalendar calendar)

Called by the scheduler at the time a Trigger is first added to the scheduler, in order to have the Trigger compute its first fire time, based on any associated calendar.

After this method has been called, getNextFireTime() should return a valid answer.

Specified by:

computeFirstFireTime in interface IOperableTrigger

Returns:

the first time at which the Trigger will be fired by the scheduler, which is also the same value getNextFireTime() will return (until after the first firing of the Trigger).

getNextFireTime

public Date getNextFireTime()

Returns the next time at which the Trigger is scheduled to fire. If the trigger will not fire again, null will be returned. Note that the time returned can possibly be in the past, if the time that was computed for the trigger to next fire has already arrived, but the scheduler has not yet been able to fire the trigger (which would likely be due to lack of resources e.g. threads).

The value returned is not guaranteed to be valid until after the Trigger has been added to the scheduler.

Specified by:

getNextFireTime in interface ITrigger

See Also:

TriggerUtils.computeFireTimesBetween(com.helger.quartz.spi.IOperableTrigger, ICalendar, Date, Date)

getPreviousFireTime

public Date getPreviousFireTime()

Returns the previous time at which the SimpleTrigger fired. If the trigger has not yet fired, null will be returned.

Specified by:

getPreviousFireTime in interface ITrigger

setNextFireTime

public void setNextFireTime(Date nextFireTime)

Set the next time at which the SimpleTrigger should fire.
This method should not be invoked by client code.

Specified by:

setNextFireTime in interface IOperableTrigger

setPreviousFireTime

public void setPreviousFireTime(Date previousFireTime)

Set the previous time at which the SimpleTrigger fired.
This method should not be invoked by client code.

Specified by:

setPreviousFireTime in interface IOperableTrigger

getFireTimeAfter

public Date getFireTimeAfter(@Nullable
                             Date aAfterTime)

Returns the next time at which the SimpleTrigger will fire, after the given time. If the trigger will not fire after the given time, null will be returned.

Specified by:

getFireTimeAfter in interface ITrigger

Parameters:

aAfterTime - After time. May be null

getFireTimeBefore

public Date getFireTimeBefore(Date end)

Returns the last time at which the SimpleTrigger will fire, before the given time. If the trigger will not fire before the given time, null will be returned.

computeNumTimesFiredBetween

public int computeNumTimesFiredBetween(Date start,
                                       Date end)

getFinalFireTime

public Date getFinalFireTime()

Returns the final time at which the SimpleTrigger will fire, if repeatCount is REPEAT_INDEFINITELY, null will be returned.

Note that the return time may be in the past.

Specified by:

getFinalFireTime in interface ITrigger

mayFireAgain

public boolean mayFireAgain()

Determines whether or not the SimpleTrigger will occur again.

Specified by:

mayFireAgain in interface ITrigger

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

Overrides:

validate in class AbstractTrigger<SimpleTrigger>

Throws:

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

SchedulerException

getScheduleBuilder

public IScheduleBuilder<SimpleTrigger> getScheduleBuilder()

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

Specified by:

getScheduleBuilder in interface ITrigger

Specified by:

getScheduleBuilder in class AbstractTrigger<SimpleTrigger>

See Also:

AbstractTrigger.getTriggerBuilder()

getClone

@Nonnull
 @ReturnsMutableCopy
public SimpleTrigger getClone()

Specified by:

getClone in interface com.helger.commons.lang.ICloneable<SimpleTrigger>

Specified by:

getClone in interface ITrigger

Specified by:

getClone in interface IMutableTrigger

Specified by:

getClone in interface IOperableTrigger

equals

public boolean equals(Object o)

Description copied from class: AbstractTrigger

Trigger equality is based upon the equality of the TriggerKey.

Specified by:

equals in interface ITrigger

Overrides:

equals in class AbstractTrigger<SimpleTrigger>

Returns:

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

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractTrigger<SimpleTrigger>

create

@Nonnull
public static SimpleTrigger create(@Nonnull
                                             String name,
                                             @Nullable
                                             String group,
                                             @Nonnull
                                             String jobName,
                                             @Nullable
                                             String jobGroup,
                                             Date startTime,
                                             Date endTime,
                                             int repeatCount,
                                             long repeatInterval)