com.helger.quartz.impl.triggers

Class CronTrigger

java.lang.Object

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

com.helger.quartz.impl.triggers.CronTrigger

All Implemented Interfaces:

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

public class CronTrigger
extends AbstractTrigger<CronTrigger>
implements ICronTrigger

A concrete ITrigger that is used to fire a IJobDetail at given moments in time, defined with Unix 'cron-like' definitions.

Author:

Sharada Jambula, James House, Contributions from Mads Henderson

Nested Class Summary

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

ITrigger.ECompletedExecutionInstruction, ITrigger.EMisfireInstruction, ITrigger.ETriggerState

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	YEAR_TO_GIVEUP_SCHEDULING_AT

Fields inherited from interface com.helger.quartz.ITrigger

DEFAULT_PRIORITY

Constructor Summary

Constructors

Constructor and Description
CronTrigger() Create a CronTrigger with no settings.
CronTrigger(CronTrigger 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.
boolean	equals(Object o) Trigger equality is based upon the equality of the TriggerKey.
CronTrigger	getClone()
String	getCronExpression()
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).
String	getExpressionSummary()
Date	getFinalFireTime() NOT YET IMPLEMENTED: Returns the final time at which the CronTrigger will fire.
Date	getFireTimeAfter(Date aAfterTime) Returns the next time at which the CronTrigger will fire, after 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 Trigger fired.
IScheduleBuilder<CronTrigger>	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.
protected Date	getTimeAfter(Date afterTime)
protected Date	getTimeBefore(Date eTime) NOT YET IMPLEMENTED: Returns the time before the given time that this CronTrigger will fire.
TimeZone	getTimeZone() Returns the time zone for which the cronExpression of this ICronTrigger will be resolved.
int	hashCode()
boolean	mayFireAgain() Determines whether or not the CronTrigger will occur again.
void	setCronExpression(CronExpression cronExpression) Set the CronExpression to the given one.
void	setCronExpression(String cronExpression)
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)
void	setPreviousFireTime(Date previousFireTime)
void	setStartTime(Date startTime) The time at which the trigger's scheduling should start.
void	setTimeZone(TimeZone timeZone) Sets the time zone for which the cronExpression of this CronTrigger will be resolved.
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 CronTrigger's state based on the MISFIRE_INSTRUCTION_XXX that was selected when the CronTrigger was created.
void	updateWithNewCalendar(ICalendar calendar, long misfireThreshold) This method should not be used by the Quartz client.
protected boolean	validateMisfireInstruction(ITrigger.EMisfireInstruction misfireInstruction)
boolean	willFireOn(Calendar test) Determines whether the date and (optionally) time of the given Calendar instance falls on a scheduled fire-time of this trigger.
boolean	willFireOn(Calendar aTest, boolean dayOnly) Determines whether the date and (optionally) time of the given Calendar instance falls on a scheduled fire-time of this trigger.

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, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.quartz.ICronTrigger

getTriggerBuilder

Methods inherited from interface com.helger.quartz.ITrigger

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

Field Detail

YEAR_TO_GIVEUP_SCHEDULING_AT

protected static final int YEAR_TO_GIVEUP_SCHEDULING_AT

Constructor Detail

CronTrigger

public CronTrigger(@Nonnull
                   CronTrigger aOther)

CronTrigger

public CronTrigger()

Create a CronTrigger with no settings.
The start-time will also be set to the current time, and the time zone will be set the the system's default time zone.

Method Detail

getCronExpression

@Nullable
public String getCronExpression()

Specified by:

getCronExpression in interface ICronTrigger

setCronExpression

public void setCronExpression(@Nonnull
                              String cronExpression)
                       throws ParseException

Throws:

ParseException

setCronExpression

public void setCronExpression(@Nonnull
                              CronExpression cronExpression)

Set the CronExpression to the given one. The TimeZone on the passed-in CronExpression over-rides any that was already set on the Trigger.

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 final 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)

getNextFireTime

public Date getNextFireTime()

Description copied from interface: ITrigger

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)

setNextFireTime

public void setNextFireTime(Date nextFireTime)

Specified by:

setNextFireTime in interface IOperableTrigger

getPreviousFireTime

public Date getPreviousFireTime()

Description copied from interface: ITrigger

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

Specified by:

getPreviousFireTime in interface ITrigger

setPreviousFireTime

public void setPreviousFireTime(Date previousFireTime)

Specified by:

setPreviousFireTime in interface IOperableTrigger

getTimeZone

@Nonnull
public TimeZone getTimeZone()

Description copied from interface: ICronTrigger

Returns the time zone for which the cronExpression of this ICronTrigger will be resolved.

Specified by:

getTimeZone in interface ICronTrigger

setTimeZone

public void setTimeZone(@Nullable
                        TimeZone timeZone)

Sets the time zone for which the cronExpression of this CronTrigger will be resolved.
If setCronExpression(CronExpression) is called after this method, the TimeZon setting on the CronExpression will "win". However if setCronExpression(String) is called after this method, the time zone applied by this method will remain in effect, since the String cron expression does not carry a time zone!

getFireTimeAfter

public Date getFireTimeAfter(@Nullable
                             Date aAfterTime)

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

Note that the date returned is NOT validated against the related ICalendar (if any)

Specified by:

getFireTimeAfter in interface ITrigger

Parameters:

aAfterTime - after time

getFinalFireTime

public Date getFinalFireTime()

NOT YET IMPLEMENTED: Returns the final time at which the CronTrigger will fire.

Note that the return time *may* be in the past. and the date returned is not validated against ICalendar

Specified by:

getFinalFireTime in interface ITrigger

mayFireAgain

public boolean mayFireAgain()

Determines whether or not the CronTrigger will occur again.

Specified by:

mayFireAgain in interface ITrigger

validateMisfireInstruction

protected boolean validateMisfireInstruction(ITrigger.EMisfireInstruction misfireInstruction)

Specified by:

validateMisfireInstruction in class AbstractTrigger<CronTrigger>

updateAfterMisfire

public void updateAfterMisfire(ICalendar cal)

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

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

• The instruction will be interpreted as MISFIRE_INSTRUCTION_FIRE_ONCE_NOW

Specified by:

updateAfterMisfire in interface IOperableTrigger

willFireOn

public boolean willFireOn(Calendar test)

Determines whether the date and (optionally) time of the given Calendar instance falls on a scheduled fire-time of this trigger.

Equivalent to calling willFireOn(cal, false).

Parameters:

test - the date to compare

See Also:

willFireOn(Calendar, boolean)

willFireOn

public boolean willFireOn(Calendar aTest,
                          boolean dayOnly)

Determines whether the date and (optionally) time of the given Calendar instance falls on a scheduled fire-time of this trigger.

Note that the value returned is NOT validated against the related ICalendar (if any)

Parameters:

aTest - the date to compare

dayOnly - if set to true, the method will only determine if the trigger will fire during the day represented by the given Calendar (hours, minutes and seconds will be ignored).

See Also:

willFireOn(Calendar)

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(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).

getExpressionSummary

public String getExpressionSummary()

Specified by:

getExpressionSummary in interface ICronTrigger

getScheduleBuilder

public IScheduleBuilder<CronTrigger> 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<CronTrigger>

See Also:

AbstractTrigger.getTriggerBuilder()

getTimeAfter

@Nullable
protected Date getTimeAfter(Date afterTime)

getTimeBefore

@Nullable
protected Date getTimeBefore(Date eTime)

NOT YET IMPLEMENTED: Returns the time before the given time that this CronTrigger will fire.

getClone

@Nonnull
 @ReturnsMutableCopy
public CronTrigger getClone()

Specified by:

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

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<CronTrigger>

Returns:

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

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractTrigger<CronTrigger>