Class TimeTriggerBuilder
java.lang.Object
com.inet.taskplanner.server.api.trigger.TimeTriggerBuilder
This can be used to easily create
TimeTrigger definition.
Example usage:
TaskDefinition task = new TaskDefinition( "mytask" ); //from tomorrow on each workday at 8:30 TriggerDefinition timeTrigger = new TimeTriggerBuilder().withStartDate( ZonedDateTime.now().plusDays( 1 ) ).withHourAndMinute( 8, 30 ).withRepeating( RepeatInterval.WORKDAYS ).create(); task.addTrigger( timeTrigger ); // .. add jobs and actions ... TaskPlanner.getInstance().addTask( task );
- Since:
- taskplanner 3.0
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncreate()Finish the configuration of the time trigger and create aTriggerDefinitionwhich can be added totasks.withHourAndMinute(int hour, int minute) Set the hour and minute of the day when the trigger must start the task.
The hour and minute is part of the startDate, but it determines the time of the day when the task is triggered.withMonthlyDay(@Nonnull MonthlyDay monthlyDay) If you have set therepeat intervaltoRepeatInterval.MONTHLY, then you can configure here on which day of the month the task must be executed.
The default value isMonthlyDay.INITIAL, which means the day from thestartDateis used.withRepeating(@Nonnull RepeatInterval repeatInterval) Set the repeating interval.withStartDate(@Nonnull ZonedDateTime startDateAndTime) Set the start date and time to the given date.
-
Constructor Details
-
TimeTriggerBuilder
public TimeTriggerBuilder()
-
-
Method Details
-
withStartDate
Set the start date and time to the given date.The trigger will start at this point in time or later depending on the
repeat interval.The hour and minute of this defines on which time of the day the task will be executed for all future executions. Also with many
repeat intervalsthe startDate has also an impact on future executions, like onweeklyinterval it determines the day of week for all future executions.- Parameters:
startDateAndTime- Date and time to use as start point- Returns:
- this builder instance
- Throws:
IllegalArgumentException- if given startDateAndTime is null.- Since:
- taskplanner 3.0
-
withHourAndMinute
Set the hour and minute of the day when the trigger must start the task.
The hour and minute is part of the startDate, but it determines the time of the day when the task is triggered.- Parameters:
hour- hour of the day when to trigger (0..23)minute- minute of the hour when to trigger (0..59)- Returns:
- this builder instance
- Throws:
DateTimeException- if given hour or minute are invalid- Since:
- taskplanner 3.0
- See Also:
-
withRepeating
Set the repeating interval. The default value isRepeatInterval.NONE. SeeRepeatIntervalfor details aboout each interval.- Parameters:
repeatInterval- the desired repeat interval fir this trigger- Returns:
- this builder instance
- Throws:
IllegalArgumentException- if given repeatInterval is null.- Since:
- taskplanner 3.0
-
withMonthlyDay
If you have set therepeat intervaltoRepeatInterval.MONTHLY, then you can configure here on which day of the month the task must be executed.
The default value isMonthlyDay.INITIAL, which means the day from thestartDateis used. For otherrepeating intervalsthanRepeatInterval.MONTHLYthis settings has no effect.- Parameters:
monthlyDay- the day of the month when execution is desired- Returns:
- this builder instance
- Throws:
IllegalArgumentException- if given monthlyDay is null.- Since:
- taskplanner 3.0
- See Also:
-
create
Finish the configuration of the time trigger and create aTriggerDefinitionwhich can be added totasks.- Returns:
- a new
TriggerDefinitionwith settings from this builder. - Since:
- taskplanner 3.0
-