Package org.quartz

The main package of Quartz, containing the client-side interfaces.

See:
          Description

Interface Summary
Calendar An interface to be implemented by objects that define spaces of time during which an associated Trigger may (not) fire.
CalendarIntervalTrigger A concrete Trigger that is used to fire a JobDetail based upon repeating calendar time intervals.
CronTrigger The public interface for inspecting settings specific to a CronTrigger, .
DailyTimeIntervalTrigger A Trigger that is used to fire a JobDetail based upon daily repeating time intervals.
InterruptableJob The interface to be implemented by Jobs that provide a mechanism for having their execution interrupted.
Job The interface to be implemented by classes which represent a 'job' to be performed.
JobDetail Conveys the detail properties of a given Job instance.
JobExecutionContext A context bundle containing handles to various environment information, that is given to a JobDetail instance as it is executed, and to a Trigger instance after the execution completes.
JobListener The interface to be implemented by classes that want to be informed when a JobDetail executes.
ListenerManager Client programs may be interested in the 'listener' interfaces that are available from Quartz.
Matcher<T extends Key<?>> Matchers can be used in various Scheduler API methods to select the entities that should be operated upon.
Scheduler This is the main interface of a Quartz Scheduler.
SchedulerFactory Provides a mechanism for obtaining client-usable handles to Scheduler instances.
SchedulerListener The interface to be implemented by classes that want to be informed of major Scheduler events.
SimpleTrigger A Trigger that is used to fire a Job at a given moment in time, and optionally repeated at a specified interval.
StatefulJob Deprecated. use DisallowConcurrentExecution and/or PersistJobDataAfterExecution annotations instead.
Trigger The base interface with properties common to all Triggers - use TriggerBuilder to instantiate an actual Trigger.
TriggerListener The interface to be implemented by classes that want to be informed when a Trigger fires.
 

Class Summary
CalendarIntervalScheduleBuilder CalendarIntervalScheduleBuilder is a ScheduleBuilder that defines calendar time (day, week, month, year) interval-based schedules for Triggers.
CronExpression Provides a parser and evaluator for unix-like cron expressions.
CronScheduleBuilder CronScheduleBuilder is a ScheduleBuilder that defines CronExpression-based schedules for Triggers.
DailyTimeIntervalScheduleBuilder A ScheduleBuilder implementation that build schedule for DailyTimeIntervalTrigger.
DateBuilder DateBuilder is used to conveniently create java.util.Date instances that meet particular criteria.
JobBuilder JobBuilder is used to instantiate JobDetails.
JobDataMap Holds state information for Job instances.
JobKey Uniquely identifies a JobDetail.
ScheduleBuilder<T extends Trigger>  
SchedulerContext Holds context/environment data that can be made available to Jobs as they are executed.
SchedulerMetaData Describes the settings and capabilities of a given Scheduler instance.
SimpleScheduleBuilder SimpleScheduleBuilder is a ScheduleBuilder that defines strict/literal interval-based schedules for Triggers.
TimeOfDay Represents a time in hour, minute and second of any given day.
Trigger.TriggerTimeComparator A Comparator that compares trigger's next fire times, or in other words, sorts them according to earliest next fire time.
TriggerBuilder<T extends Trigger> TriggerBuilder is used to instantiate Triggers.
TriggerKey Uniquely identifies a Trigger.
TriggerUtils Convenience and utility methods for working with Triggers.
 

Enum Summary
DateBuilder.IntervalUnit  
Trigger.CompletedExecutionInstruction NOOP Instructs the Scheduler that the Trigger has no further instructions.
Trigger.TriggerState  
 

Exception Summary
JobExecutionException An exception that can be thrown by a Job to indicate to the Quartz Scheduler that an error occurred while executing, and whether or not the Job requests to be re-fired immediately (using the same JobExecutionContext, or whether it wants to be unscheduled.
JobPersistenceException An exception that is thrown to indicate that there has been a failure in the scheduler's underlying persistence mechanism.
ObjectAlreadyExistsException An exception that is thrown to indicate that an attempt to store a new object (i.e.
SchedulerConfigException An exception that is thrown to indicate that there is a misconfiguration of the SchedulerFactory- or one of the components it configures.
SchedulerException Base class for exceptions thrown by the Quartz Scheduler.
UnableToInterruptJobException An exception that is thrown to indicate that a call to InterruptableJob.interrupt() failed without interrupting the Job.
 

Annotation Types Summary
DisallowConcurrentExecution An annotation that marks a Job class as one that must not have multiple instances executed concurrently (where instance is based-upon a JobDetail definition - or in other words based upon a JobKey).
ExecuteInJTATransaction An annotation that marks a Job class as one that will have its execution wrapped by a JTA Transaction.
PersistJobDataAfterExecution An annotation that marks a Job class as one that makes updates to its JobDataMap during execution, and wishes the scheduler to re-store the JobDataMap when execution completes.
 

Package org.quartz Description

The main package of Quartz, containing the client-side interfaces.




See the Quartz project for more information.

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);



Copyright 2001-2013, Terracotta, Inc.