Package org.quartz.builders

Class SimpleTriggerBuilder

java.lang.Object

org.quartz.builders.TriggerBuilder

org.quartz.builders.SimpleTriggerBuilder

public class SimpleTriggerBuilder
extends TriggerBuilder

SimpleScheduleBuilder is a

invalid @link

ScheduleBuilder

that defines strict/literal interval-based schedules for Triggers.

Quartz provides a builder-style API for constructing scheduling-related entities via a Domain-Specific Language (DSL). The DSL can best be utilized through the usage of static imports of the methods on the classes TriggerBuilder, JobBuilder, DateBuilder, JobKey, TriggerKey and the various ScheduleBuilder implementations.

Client code can then use the DSL to write code such as this:

 JobDetail job = newJob(MyJob.class).withIdentity("myJob").build(); Trigger trigger =
 newTrigger().withIdentity(triggerKey("myTrigger", "myTriggerGroup"))
 .withSchedule(simpleSchedule().withIntervalInHours(1).repeatForever()).startAt(futureDate(10, MINUTES)).build(); scheduler.scheduleJob(job,
 trigger);

 

Method Summary

Modifier and Type	Method	Description
SimpleTriggerBuilder	endAt(Date endTime)	Set the time at which the Trigger will no longer fire - even if it's schedule has remaining repeats.
SimpleTriggerBuilder	forJob(String jobName)	Set the identity of the Job which should be fired by the produced Trigger.
OperableTrigger	instantiate()	Build the actual Trigger -- NOT intended to be invoked by end users, but will rather be invoked by a TriggerBuilder which this ScheduleBuilder is given to.
SimpleTriggerBuilder	modifiedByCalendar(String calendarName)	Set the name of the Calendar that should be applied to this Trigger's schedule.
SimpleTriggerBuilder	repeatForever()	Specify that the trigger will repeat indefinitely.
static SimpleTriggerBuilder	simpleTriggerBuilder()	Create a SimpleScheduleBuilder.
SimpleTriggerBuilder	startAt(Date startTime)	Set the time the Trigger should start at - the trigger may or may not fire at this time - depending upon the schedule configured for the Trigger.
SimpleTriggerBuilder	startNow()	Set the time the Trigger should start at to the current moment - the trigger may or may not fire at this time - depending upon the schedule configured for the Trigger.
SimpleTriggerBuilder	usingJobData(JobDataMap newJobDataMap)	Set the Trigger's JobDataMap.
SimpleTriggerBuilder	withDescription(String description)	Set the given (human-meaningful) description of the Trigger.
SimpleTriggerBuilder	withIdentity(String name)	Use the given TriggerKey to identify the Trigger.
SimpleTriggerBuilder	withIntervalInMilliseconds(long intervalInMillis)	Specify a repeat interval in milliseconds.
SimpleTriggerBuilder	withMisfireHandlingInstructionFireNow()	If the Trigger misfires, use the SimpleTrigger.MISFIRE_INSTRUCTION_FIRE_NOW instruction.
SimpleTriggerBuilder	withMisfireHandlingInstructionNextWithExistingCount()	If the Trigger misfires, use the SimpleTrigger.MISFIRE_INSTRUCTION_RESCHEDULE_NEXT_WITH_EXISTING_COUNT instruction.
SimpleTriggerBuilder	withMisfireHandlingInstructionNextWithRemainingCount()	If the Trigger misfires, use the SimpleTrigger.MISFIRE_INSTRUCTION_RESCHEDULE_NEXT_WITH_REMAINING_COUNT instruction.
SimpleTriggerBuilder	withMisfireHandlingInstructionNowWithExistingCount()	If the Trigger misfires, use the SimpleTrigger.MISFIRE_INSTRUCTION_RESCHEDULE_NOW_WITH_EXISTING_REPEAT_COUNT instruction.
SimpleTriggerBuilder	withMisfireHandlingInstructionNowWithRemainingCount()	If the Trigger misfires, use the SimpleTrigger.MISFIRE_INSTRUCTION_RESCHEDULE_NOW_WITH_REMAINING_REPEAT_COUNT instruction.
SimpleTriggerBuilder	withPriority(int priority)	Set the Trigger's priority.
SimpleTriggerBuilder	withRepeatCount(int repeatCount)	Specify a the number of time the trigger will repeat - total number of firings will be this number + 1.

Methods inherited from class org.quartz.builders.TriggerBuilder

build, withTriggerImplementation

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

simpleTriggerBuilder

public static SimpleTriggerBuilder simpleTriggerBuilder()

Create a SimpleScheduleBuilder.

Returns:

the new SimpleScheduleBuilder

instantiate

public OperableTrigger instantiate()

Build the actual Trigger -- NOT intended to be invoked by end users, but will rather be invoked by a TriggerBuilder which this ScheduleBuilder is given to.

Specified by:

instantiate in class TriggerBuilder

withIntervalInMilliseconds

public SimpleTriggerBuilder withIntervalInMilliseconds(long intervalInMillis)

Specify a repeat interval in milliseconds.

Parameters:

intervalInMillis - the number of seconds at which the trigger should repeat.

Returns:

the updated SimpleScheduleBuilder

See Also:

• SimpleTrigger.getRepeatInterval()
• withRepeatCount(int)

withRepeatCount

public SimpleTriggerBuilder withRepeatCount(int repeatCount)

Specify a the number of time the trigger will repeat - total number of firings will be this number + 1.

Parameters:

repeatCount - the number of seconds at which the trigger should repeat.

Returns:

the updated SimpleScheduleBuilder

See Also:

• SimpleTrigger.getRepeatCount()
• repeatForever()

repeatForever

public SimpleTriggerBuilder repeatForever()

Specify that the trigger will repeat indefinitely.

Returns:

the updated SimpleScheduleBuilder

See Also:

• SimpleTrigger.getRepeatCount()
• SimpleTrigger.REPEAT_INDEFINITELY
• withIntervalInMilliseconds(long)

withMisfireHandlingInstructionFireNow

public SimpleTriggerBuilder withMisfireHandlingInstructionFireNow()

If the Trigger misfires, use the SimpleTrigger.MISFIRE_INSTRUCTION_FIRE_NOW instruction.

Returns:

the updated SimpleScheduleBuilder

See Also:

• SimpleTrigger.MISFIRE_INSTRUCTION_FIRE_NOW

withMisfireHandlingInstructionNextWithExistingCount

public SimpleTriggerBuilder withMisfireHandlingInstructionNextWithExistingCount()

If the Trigger misfires, use the SimpleTrigger.MISFIRE_INSTRUCTION_RESCHEDULE_NEXT_WITH_EXISTING_COUNT instruction.

Returns:

the updated SimpleScheduleBuilder

See Also:

• SimpleTrigger.MISFIRE_INSTRUCTION_RESCHEDULE_NEXT_WITH_EXISTING_COUNT

withMisfireHandlingInstructionNextWithRemainingCount

public SimpleTriggerBuilder withMisfireHandlingInstructionNextWithRemainingCount()

If the Trigger misfires, use the SimpleTrigger.MISFIRE_INSTRUCTION_RESCHEDULE_NEXT_WITH_REMAINING_COUNT instruction.

Returns:

the updated SimpleScheduleBuilder

See Also:

• SimpleTrigger.MISFIRE_INSTRUCTION_RESCHEDULE_NEXT_WITH_REMAINING_COUNT

withMisfireHandlingInstructionNowWithExistingCount

public SimpleTriggerBuilder withMisfireHandlingInstructionNowWithExistingCount()

If the Trigger misfires, use the SimpleTrigger.MISFIRE_INSTRUCTION_RESCHEDULE_NOW_WITH_EXISTING_REPEAT_COUNT instruction.

Returns:

the updated SimpleScheduleBuilder

See Also:

• SimpleTrigger.MISFIRE_INSTRUCTION_RESCHEDULE_NOW_WITH_EXISTING_REPEAT_COUNT

withMisfireHandlingInstructionNowWithRemainingCount

public SimpleTriggerBuilder withMisfireHandlingInstructionNowWithRemainingCount()

If the Trigger misfires, use the SimpleTrigger.MISFIRE_INSTRUCTION_RESCHEDULE_NOW_WITH_REMAINING_REPEAT_COUNT instruction.

Returns:

the updated SimpleScheduleBuilder

See Also:

• SimpleTrigger.MISFIRE_INSTRUCTION_RESCHEDULE_NOW_WITH_REMAINING_REPEAT_COUNT

withIdentity

public SimpleTriggerBuilder withIdentity(String name)

Description copied from class: TriggerBuilder

Use the given TriggerKey to identify the Trigger.

If none of the 'withIdentity' methods are set on the TriggerBuilder, then a random, unique TriggerKey will be generated.

Overrides:

withIdentity in class TriggerBuilder

Parameters:

name - the TriggerKey for the Trigger to be built

Returns:

the updated TriggerBuilder

withDescription

public SimpleTriggerBuilder withDescription(String description)

Description copied from class: TriggerBuilder

Set the given (human-meaningful) description of the Trigger.

Overrides:

withDescription in class TriggerBuilder

Parameters:

description - the description for the Trigger

Returns:

the updated TriggerBuilder

withPriority

public SimpleTriggerBuilder withPriority(int priority)

Description copied from class: TriggerBuilder

Set the Trigger's priority. When more than one Trigger have the same fire time, the scheduler will fire the one with the highest priority first.

Overrides:

withPriority in class TriggerBuilder

Parameters:

priority - the priority for the Trigger

Returns:

the updated TriggerBuilder

modifiedByCalendar

public SimpleTriggerBuilder modifiedByCalendar(String calendarName)

Description copied from class: TriggerBuilder

Set the name of the Calendar that should be applied to this Trigger's schedule.

Overrides:

modifiedByCalendar in class TriggerBuilder

Parameters:

calendarName - the name of the Calendar to reference.

Returns:

the updated TriggerBuilder

startNow

public SimpleTriggerBuilder startNow()

Description copied from class: TriggerBuilder

Set the time the Trigger should start at to the current moment - the trigger may or may not fire at this time - depending upon the schedule configured for the Trigger.

Overrides:

startNow in class TriggerBuilder

Returns:

the updated TriggerBuilder

startAt

public SimpleTriggerBuilder startAt(Date startTime)

Description copied from class: TriggerBuilder

Set the time the Trigger should start at - the trigger may or may not fire at this time - depending upon the schedule configured for the Trigger. However the Trigger will NOT fire before this time, regardless of the Trigger's schedule.

Overrides:

startAt in class TriggerBuilder

Parameters:

startTime - the start time for the Trigger.

Returns:

the updated TriggerBuilder

endAt

public SimpleTriggerBuilder endAt(Date endTime)

Description copied from class: TriggerBuilder

Set the time at which the Trigger will no longer fire - even if it's schedule has remaining repeats.

Overrides:

endAt in class TriggerBuilder

Parameters:

endTime - the end time for the Trigger. If null, the end time is indefinite.

Returns:

the updated TriggerBuilder

forJob

public SimpleTriggerBuilder forJob(String jobName)

Description copied from class: TriggerBuilder

Set the identity of the Job which should be fired by the produced Trigger.

Overrides:

forJob in class TriggerBuilder

Parameters:

jobName - the identity of the Job to fire.

Returns:

the updated TriggerBuilder

usingJobData

public SimpleTriggerBuilder usingJobData(JobDataMap newJobDataMap)

Description copied from class: TriggerBuilder

Set the Trigger's JobDataMap.

Overrides:

usingJobData in class TriggerBuilder

Returns:

the updated TriggerBuilder