org.quartz.TriggerBuilder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of sundial Show documentation
Show all versions of sundial Show documentation
A Lightweight Java Job Scheduling Framework
/**
* All content copyright Terracotta, Inc., unless otherwise indicated. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy
* of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations
* under the License.
*
*/
package org.quartz;
import java.util.Date;
import org.quartz.spi.MutableTrigger;
import org.quartz.utils.Key;
/**
* TriggerBuilder is used to instantiate {@link Trigger}s.
*
* 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);
*
*
*
* @see JobBuilder
* @see ScheduleBuilder
* @see DateBuilder
* @see Trigger
*/
public class TriggerBuilder {
private TriggerKey key;
private String description;
private Date startTime = new Date();
private Date endTime;
private int priority = Trigger.DEFAULT_PRIORITY;
private String calendarName;
private JobKey jobKey;
private JobDataMap jobDataMap = new JobDataMap();
private ScheduleBuilder scheduleBuilder = null;
private TriggerBuilder() {
}
/**
* Create a new TriggerBuilder with which to define a specification for a Trigger.
*
* @return the new TriggerBuilder
*/
public static TriggerBuilder newTrigger() {
return new TriggerBuilder();
}
/**
* Produce the Trigger.
*
* @return a Trigger that meets the specifications of the builder.
*/
public T build() {
if (scheduleBuilder == null)
scheduleBuilder = SimpleScheduleBuilder.simpleSchedule();
MutableTrigger trig = scheduleBuilder.build();
trig.setCalendarName(calendarName);
trig.setDescription(description);
trig.setEndTime(endTime);
if (key == null)
key = new TriggerKey(Key.createUniqueName(null), null);
trig.setKey(key);
if (jobKey != null)
trig.setJobKey(jobKey);
trig.setPriority(priority);
trig.setStartTime(startTime);
if (!jobDataMap.isEmpty())
trig.setJobDataMap(jobDataMap);
return (T) trig;
}
/**
* Use a TriggerKey with the given name and default group to identify the Trigger.
*
* If none of the 'withIdentity' methods are set on the TriggerBuilder, then a random, unique TriggerKey will be generated.
*
*
* @param name the name element for the Trigger's TriggerKey
* @return the updated TriggerBuilder
* @see TriggerKey
* @see Trigger#getKey()
*/
public TriggerBuilder withIdentity(String name) {
key = new TriggerKey(name, null);
return this;
}
/**
* Use a TriggerKey with the given name and group to identify the Trigger.
*
* If none of the 'withIdentity' methods are set on the TriggerBuilder, then a random, unique TriggerKey will be generated.
*
*
* @param name the name element for the Trigger's TriggerKey
* @param group the group element for the Trigger's TriggerKey
* @return the updated TriggerBuilder
* @see TriggerKey
* @see Trigger#getKey()
*/
public TriggerBuilder withIdentity(String name, String group) {
key = new TriggerKey(name, group);
return this;
}
/**
* 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.
*
*
* @param key the TriggerKey for the Trigger to be built
* @return the updated TriggerBuilder
* @see TriggerKey
* @see Trigger#getKey()
*/
public TriggerBuilder withIdentity(TriggerKey key) {
this.key = key;
return this;
}
/**
* Set the given (human-meaningful) description of the Trigger.
*
* @param description the description for the Trigger
* @return the updated TriggerBuilder
* @see Trigger#getDescription()
*/
public TriggerBuilder withDescription(String description) {
this.description = description;
return this;
}
/**
* 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.
*
* @param priority the priority for the Trigger
* @return the updated TriggerBuilder
* @see Trigger#DEFAULT_PRIORITY
* @see Trigger#getPriority()
*/
public TriggerBuilder withPriority(int priority) {
this.priority = priority;
return this;
}
/**
* Set the name of the {@link Calendar} that should be applied to this Trigger's schedule.
*
* @param calendarName the name of the Calendar to reference.
* @return the updated TriggerBuilder
* @see Calendar
* @see Trigger#getCalendarName()
*/
public TriggerBuilder modifiedByCalendar(String calendarName) {
this.calendarName = calendarName;
return this;
}
/**
* 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.
*
* @param startTime the start time for the Trigger.
* @return the updated TriggerBuilder
* @see Trigger#getStartTime()
* @see DateBuilder
*/
public TriggerBuilder startAt(Date startTime) {
this.startTime = startTime;
return this;
}
/**
* 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.
*
* @return the updated TriggerBuilder
* @see Trigger#getStartTime()
*/
public TriggerBuilder startNow() {
this.startTime = new Date();
return this;
}
/**
* Set the time at which the Trigger will no longer fire - even if it's schedule has remaining repeats.
*
* @param endTime the end time for the Trigger. If null, the end time is indefinite.
* @return the updated TriggerBuilder
* @see Trigger#getEndTime()
* @see DateBuilder
*/
public TriggerBuilder endAt(Date endTime) {
this.endTime = endTime;
return this;
}
/**
* Set the {@link ScheduleBuilder} that will be used to define the Trigger's schedule.
*
* The particular SchedulerBuilder used will dictate the concrete type of Trigger that is produced by the TriggerBuilder.
*
*
* @param scheduleBuilder the SchedulerBuilder to use.
* @return the updated TriggerBuilder
* @see ScheduleBuilder
* @see SimpleScheduleBuilder
* @see CronScheduleBuilder
* @see CalendarIntervalScheduleBuilder
*/
public TriggerBuilder withSchedule(ScheduleBuilder scheduleBuilder) {
this.scheduleBuilder = scheduleBuilder;
return (TriggerBuilder) this;
}
/**
* Set the identity of the Job which should be fired by the produced Trigger.
*
* @param jobKey the identity of the Job to fire.
* @return the updated TriggerBuilder
* @see Trigger#getJobKey()
*/
public TriggerBuilder forJob(JobKey jobKey) {
this.jobKey = jobKey;
return this;
}
/**
* Set the identity of the Job which should be fired by the produced Trigger - a JobKey will be produced with the given name and default group.
*
* @param jobName the name of the job (in default group) to fire.
* @return the updated TriggerBuilder
* @see Trigger#getJobKey()
*/
public TriggerBuilder forJob(String jobName) {
this.jobKey = new JobKey(jobName, null);
return this;
}
/**
* Set the identity of the Job which should be fired by the produced Trigger - a JobKey will be produced with the given name and group.
*
* @param jobName the name of the job to fire.
* @param jobGroup the group of the job to fire.
* @return the updated TriggerBuilder
* @see Trigger#getJobKey()
*/
public TriggerBuilder forJob(String jobName, String jobGroup) {
this.jobKey = new JobKey(jobName, jobGroup);
return this;
}
/**
* Set the identity of the Job which should be fired by the produced Trigger, by extracting the JobKey from the given job.
*
* @param jobDetail the Job to fire.
* @return the updated TriggerBuilder
* @see Trigger#getJobKey()
*/
public TriggerBuilder forJob(JobDetail jobDetail) {
JobKey k = jobDetail.getKey();
if (k.getName() == null)
throw new IllegalArgumentException("The given job has not yet had a name assigned to it.");
this.jobKey = k;
return this;
}
/**
* Add the given key-value pair to the Trigger's {@link JobDataMap}.
*
* @return the updated TriggerBuilder
* @see Trigger#getJobDataMap()
*/
public TriggerBuilder usingJobData(String key, String value) {
jobDataMap.put(key, value);
return this;
}
/**
* Add the given key-value pair to the Trigger's {@link JobDataMap}.
*
* @return the updated TriggerBuilder
* @see Trigger#getJobDataMap()
*/
public TriggerBuilder usingJobData(String key, Integer value) {
jobDataMap.put(key, value);
return this;
}
/**
* Add the given key-value pair to the Trigger's {@link JobDataMap}.
*
* @return the updated TriggerBuilder
* @see Trigger#getJobDataMap()
*/
public TriggerBuilder usingJobData(String key, Long value) {
jobDataMap.put(key, value);
return this;
}
/**
* Add the given key-value pair to the Trigger's {@link JobDataMap}.
*
* @return the updated TriggerBuilder
* @see Trigger#getJobDataMap()
*/
public TriggerBuilder usingJobData(String key, Float value) {
jobDataMap.put(key, value);
return this;
}
/**
* Add the given key-value pair to the Trigger's {@link JobDataMap}.
*
* @return the updated TriggerBuilder
* @see Trigger#getJobDataMap()
*/
public TriggerBuilder usingJobData(String key, Double value) {
jobDataMap.put(key, value);
return this;
}
/**
* Add the given key-value pair to the Trigger's {@link JobDataMap}.
*
* @return the updated TriggerBuilder
* @see Trigger#getJobDataMap()
*/
public TriggerBuilder usingJobData(String key, Boolean value) {
jobDataMap.put(key, value);
return this;
}
/**
* Set the Trigger's {@link JobDataMap}, adding any values to it that were already set on this TriggerBuilder using any of the other 'usingJobData' methods.
*
* @return the updated TriggerBuilder
* @see Trigger#getJobDataMap()
*/
public TriggerBuilder usingJobData(JobDataMap newJobDataMap) {
// add any existing data to this new map
for (Object key : jobDataMap.keySet()) {
newJobDataMap.put(key, jobDataMap.get(key));
}
jobDataMap = newJobDataMap; // set new map as the map to use
return this;
}
}