com.helger.quartz

Class DailyTimeIntervalScheduleBuilder

java.lang.Object

com.helger.quartz.DailyTimeIntervalScheduleBuilder

All Implemented Interfaces:

IScheduleBuilder<DailyTimeIntervalTrigger>

public class DailyTimeIntervalScheduleBuilder
extends Object
implements IScheduleBuilder<DailyTimeIntervalTrigger>

A IScheduleBuilder implementation that build schedule for DailyTimeIntervalTrigger.

This builder provide an extra convenient method for you to set the trigger's endTimeOfDay. You may use either endingDailyAt() or endingDailyAfterCount() to set the value. The later will auto calculate your endTimeOfDay by using the interval, intervalUnit and startTimeOfDay to perform the calculation.

When using endingDailyAfterCount(), you should note that it is used to calculating endTimeOfDay. So if your startTime on the first day is already pass by a time that would not add up to the count you expected, until the next day comes. Remember that DailyTimeIntervalTrigger will use startTimeOfDay and endTimeOfDay as fresh per each day!

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 (onDaysOfTheWeek (MONDAY, THURSDAY))
                                .startAt (futureDate (10, MINUTES))
                                .build ();
 scheduler.scheduleJob (job, trigger);
 

Since:

2.1.0

Author:

James House, Zemian Deng saltnlight5@gmail.com

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DailyTimeIntervalScheduleBuilder()

Method Summary

Modifier and Type	Method and Description
DailyTimeIntervalTrigger	build() 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.
static DailyTimeIntervalScheduleBuilder	dailyTimeIntervalSchedule() Create a DailyTimeIntervalScheduleBuilder.
DailyTimeIntervalScheduleBuilder	endingDailyAfterCount(int count) Calculate and set the endTimeOfDay using count, interval and starTimeOfDay.
DailyTimeIntervalScheduleBuilder	endingDailyAt(LocalTime timeOfDay) Set the startTimeOfDay for this trigger to end firing each day at the given time.
DailyTimeIntervalScheduleBuilder	onDaysOfTheWeek(DayOfWeek... onDaysOfWeek) Set the trigger to fire on the given days of the week.
DailyTimeIntervalScheduleBuilder	onDaysOfTheWeek(Set<DayOfWeek> onDaysOfWeek) Set the trigger to fire on the given days of the week.
DailyTimeIntervalScheduleBuilder	onEveryDay() Set the trigger to fire on all days of the week.
DailyTimeIntervalScheduleBuilder	onMondayThroughFriday() Set the trigger to fire on the days from Monday through Friday.
DailyTimeIntervalScheduleBuilder	onSaturdayAndSunday() Set the trigger to fire on the days Saturday and Sunday.
DailyTimeIntervalScheduleBuilder	startingDailyAt(LocalTime timeOfDay) Set the trigger to begin firing each day at the given time.
DailyTimeIntervalScheduleBuilder	withInterval(int timeInterval, EIntervalUnit unit) Specify the time unit and interval for the Trigger to be produced.
DailyTimeIntervalScheduleBuilder	withIntervalInHours(int intervalInHours) Specify an interval in the IntervalUnit.HOUR that the produced Trigger will repeat at.
DailyTimeIntervalScheduleBuilder	withIntervalInMinutes(int intervalInMinutes) Specify an interval in the IntervalUnit.MINUTE that the produced Trigger will repeat at.
DailyTimeIntervalScheduleBuilder	withIntervalInSeconds(int intervalInSeconds) Specify an interval in the IntervalUnit.SECOND that the produced Trigger will repeat at.
DailyTimeIntervalScheduleBuilder	withMisfireHandlingInstructionDoNothing() If the Trigger misfires, use the ITrigger.EMisfireInstruction.MISFIRE_INSTRUCTION_DO_NOTHING instruction.
DailyTimeIntervalScheduleBuilder	withMisfireHandlingInstructionFireAndProceed() If the Trigger misfires, use the ITrigger.EMisfireInstruction.MISFIRE_INSTRUCTION_FIRE_ONCE_NOW instruction.
DailyTimeIntervalScheduleBuilder	withMisfireHandlingInstructionIgnoreMisfires() If the Trigger misfires, use the ITrigger.EMisfireInstruction.MISFIRE_INSTRUCTION_IGNORE_MISFIRE_POLICY instruction.
DailyTimeIntervalScheduleBuilder	withRepeatCount(int nRepeatCount) Set number of times for interval to repeat.

Methods inherited from class java.lang.Object

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

Constructor Detail

DailyTimeIntervalScheduleBuilder

protected DailyTimeIntervalScheduleBuilder()

Method Detail

dailyTimeIntervalSchedule

@Nonnull
public static DailyTimeIntervalScheduleBuilder dailyTimeIntervalSchedule()

Create a DailyTimeIntervalScheduleBuilder.

Returns:

the new DailyTimeIntervalScheduleBuilder

build

@Nonnull
public DailyTimeIntervalTrigger build()

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:

build in interface IScheduleBuilder<DailyTimeIntervalTrigger>

See Also:

TriggerBuilder.withSchedule(IScheduleBuilder)

withInterval

@Nonnull
public DailyTimeIntervalScheduleBuilder withInterval(int timeInterval,
                                                               @Nonnull
                                                               EIntervalUnit unit)

Specify the time unit and interval for the Trigger to be produced.

Parameters:

timeInterval - the interval at which the trigger should repeat.

unit - the time unit (IntervalUnit) of the interval. The only intervals that are valid for this type of trigger are EIntervalUnit.SECOND, EIntervalUnit.MINUTE, and EIntervalUnit.HOUR.

Returns:

the updated DailyTimeIntervalScheduleBuilder

See Also:

IDailyTimeIntervalTrigger.getRepeatInterval(), IDailyTimeIntervalTrigger.getRepeatIntervalUnit()

withIntervalInSeconds

@Nonnull
public DailyTimeIntervalScheduleBuilder withIntervalInSeconds(int intervalInSeconds)

Specify an interval in the IntervalUnit.SECOND that the produced Trigger will repeat at.

Parameters:

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

Returns:

the updated DailyTimeIntervalScheduleBuilder

See Also:

IDailyTimeIntervalTrigger.getRepeatInterval(), IDailyTimeIntervalTrigger.getRepeatIntervalUnit()

withIntervalInMinutes

@Nonnull
public DailyTimeIntervalScheduleBuilder withIntervalInMinutes(int intervalInMinutes)

Specify an interval in the IntervalUnit.MINUTE that the produced Trigger will repeat at.

Parameters:

intervalInMinutes - the number of minutes at which the trigger should repeat.

Returns:

the updated CalendarIntervalScheduleBuilder

See Also:

IDailyTimeIntervalTrigger.getRepeatInterval(), IDailyTimeIntervalTrigger.getRepeatIntervalUnit()

withIntervalInHours

@Nonnull
public DailyTimeIntervalScheduleBuilder withIntervalInHours(int intervalInHours)

Specify an interval in the IntervalUnit.HOUR that the produced Trigger will repeat at.

Parameters:

intervalInHours - the number of hours at which the trigger should repeat.

Returns:

the updated DailyTimeIntervalScheduleBuilder

See Also:

IDailyTimeIntervalTrigger.getRepeatInterval(), IDailyTimeIntervalTrigger.getRepeatIntervalUnit()

onDaysOfTheWeek

@Nonnull
public DailyTimeIntervalScheduleBuilder onDaysOfTheWeek(Set<DayOfWeek> onDaysOfWeek)

Set the trigger to fire on the given days of the week.

Parameters:

onDaysOfWeek - a Set containing the integers representing the days of the week, per the values 1-7 as defined by Calendar.SUNDAY - Calendar.SATURDAY.

Returns:

the updated DailyTimeIntervalScheduleBuilder

onDaysOfTheWeek

@Nonnull
public DailyTimeIntervalScheduleBuilder onDaysOfTheWeek(DayOfWeek... onDaysOfWeek)

Set the trigger to fire on the given days of the week.

Parameters:

onDaysOfWeek - a variable length list of Integers representing the days of the week, per the values 1-7 as defined by Calendar.SUNDAY - Calendar.SATURDAY.

Returns:

the updated DailyTimeIntervalScheduleBuilder

onMondayThroughFriday

@Nonnull
public DailyTimeIntervalScheduleBuilder onMondayThroughFriday()

Set the trigger to fire on the days from Monday through Friday.

Returns:

the updated DailyTimeIntervalScheduleBuilder

onSaturdayAndSunday

@Nonnull
public DailyTimeIntervalScheduleBuilder onSaturdayAndSunday()

Set the trigger to fire on the days Saturday and Sunday.

Returns:

the updated DailyTimeIntervalScheduleBuilder

onEveryDay

@Nonnull
public DailyTimeIntervalScheduleBuilder onEveryDay()

Set the trigger to fire on all days of the week.

Returns:

the updated DailyTimeIntervalScheduleBuilder

startingDailyAt

@Nonnull
public DailyTimeIntervalScheduleBuilder startingDailyAt(LocalTime timeOfDay)

Set the trigger to begin firing each day at the given time.

Returns:

the updated DailyTimeIntervalScheduleBuilder

endingDailyAt

@Nonnull
public DailyTimeIntervalScheduleBuilder endingDailyAt(LocalTime timeOfDay)

Set the startTimeOfDay for this trigger to end firing each day at the given time.

Returns:

the updated DailyTimeIntervalScheduleBuilder

endingDailyAfterCount

@Nonnull
public DailyTimeIntervalScheduleBuilder endingDailyAfterCount(int count)

Calculate and set the endTimeOfDay using count, interval and starTimeOfDay. This means that these must be set before this method is call.

Returns:

the updated DailyTimeIntervalScheduleBuilder

withMisfireHandlingInstructionIgnoreMisfires

@Nonnull
public DailyTimeIntervalScheduleBuilder withMisfireHandlingInstructionIgnoreMisfires()

If the Trigger misfires, use the ITrigger.EMisfireInstruction.MISFIRE_INSTRUCTION_IGNORE_MISFIRE_POLICY instruction.

Returns:

the updated DailyTimeIntervalScheduleBuilder

See Also:

ITrigger.EMisfireInstruction.MISFIRE_INSTRUCTION_IGNORE_MISFIRE_POLICY

withMisfireHandlingInstructionDoNothing

@Nonnull
public DailyTimeIntervalScheduleBuilder withMisfireHandlingInstructionDoNothing()

If the Trigger misfires, use the ITrigger.EMisfireInstruction.MISFIRE_INSTRUCTION_DO_NOTHING instruction.

Returns:

the updated DailyTimeIntervalScheduleBuilder

See Also:

ITrigger.EMisfireInstruction.MISFIRE_INSTRUCTION_DO_NOTHING

withMisfireHandlingInstructionFireAndProceed

@Nonnull
public DailyTimeIntervalScheduleBuilder withMisfireHandlingInstructionFireAndProceed()

If the Trigger misfires, use the ITrigger.EMisfireInstruction.MISFIRE_INSTRUCTION_FIRE_ONCE_NOW instruction.

Returns:

the updated DailyTimeIntervalScheduleBuilder

See Also:

ITrigger.EMisfireInstruction.MISFIRE_INSTRUCTION_FIRE_ONCE_NOW

withRepeatCount

@Nonnull
public DailyTimeIntervalScheduleBuilder withRepeatCount(int nRepeatCount)

Set number of times for interval to repeat.

Note: if you want total count = 1 (at start time) + repeatCount

Returns:

the new DailyTimeIntervalScheduleBuilder