org.quartz.builders.CronTriggerBuilder Maven / Gradle / Ivy

Go to download
/*
 * 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.builders;

import java.text.ParseException;
import java.util.TimeZone;

import org.quartz.triggers.CronExpression;
import org.quartz.triggers.CronTrigger;
import org.quartz.triggers.CronTriggerImpl;
import org.quartz.triggers.OperableTrigger;

/**
 * CronScheduleBuilder is a {@link ScheduleBuilder} that defines {@link CronExpression}-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);
 *
 * 
 */
public class CronTriggerBuilder extends TriggerBuilder {

  private String cronExpression;
  private TimeZone tz = null;
  private int misfireInstruction = CronTrigger.MISFIRE_INSTRUCTION_SMART_POLICY;

  /**
   * Constructor
   *
   * @param cronExpression
   */
  private CronTriggerBuilder(String cronExpression) {

    this.cronExpression = cronExpression;
  }

  /**
   * Create a CronScheduleBuilder with the given cron-expression.
   *
   * @param cronExpression the cron expression to base the schedule on.
   * @return the new CronScheduleBuilder
   * @throws ParseException
   * @see CronExpression
   */
  public static CronTriggerBuilder cronTriggerBuilder(String cronExpression) throws ParseException {

    CronExpression.validateExpression(cronExpression);
    return new CronTriggerBuilder(cronExpression);
  }

  /**
   * 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.
   */
  @Override
  public OperableTrigger instantiate() {

    CronTriggerImpl ct = new CronTriggerImpl();

    try {
      ct.setCronExpression(cronExpression);
    } catch (ParseException e) {
      // all methods of construction ensure the expression is valid by this point...
      throw new RuntimeException("CronExpression '" + cronExpression
          + "' is invalid, which should not be possible, please report bug to Quartz developers.");
    }
    ct.setTimeZone(tz);
    ct.setMisfireInstruction(misfireInstruction);

    return ct;
  }

  /**
   * The TimeZone in which to base the schedule.
   *
   * @param tz the time-zone for the schedule.
   * @return the updated CronScheduleBuilder
   * @see CronExpression#getTimeZone()
   */
  public CronTriggerBuilder inTimeZone(TimeZone tz) {

    this.tz = tz;
    return this;
  }

  /**
   * If the Trigger misfires, use the {@link CronTrigger#MISFIRE_INSTRUCTION_DO_NOTHING} instruction.
   *
   * @return the updated CronScheduleBuilder
   * @see CronTrigger#MISFIRE_INSTRUCTION_DO_NOTHING
   */
  public CronTriggerBuilder withMisfireHandlingInstructionDoNothing() {

    misfireInstruction = CronTrigger.MISFIRE_INSTRUCTION_DO_NOTHING;
    return this;
  }

  /**
   * If the Trigger misfires, use the {@link CronTrigger#MISFIRE_INSTRUCTION_FIRE_ONCE_NOW} instruction.
   *
   * @return the updated CronScheduleBuilder
   * @see CronTrigger#MISFIRE_INSTRUCTION_FIRE_ONCE_NOW
   */
  public CronTriggerBuilder withMisfireHandlingInstructionFireAndProceed() {

    misfireInstruction = CronTrigger.MISFIRE_INSTRUCTION_FIRE_ONCE_NOW;
    return this;
  }
}