Package com.helger.quartz

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

See: Description

Interface Summary

Interface	Description
ICalendar	An interface to be implemented by objects that define spaces of time during which an associated ITrigger may (not) fire.
ICalendarIntervalTrigger	A concrete ITrigger that is used to fire a IJobDetail based upon repeating calendar time intervals.
ICronTrigger	The public interface for inspecting settings specific to a CronTrigger, .
IDailyTimeIntervalTrigger	A ITrigger that is used to fire a IJobDetail based upon daily repeating time intervals.
IInterruptableJob	The interface to be implemented by IJobs that provide a mechanism for having their execution interrupted.
IJob	The interface to be implemented by classes which represent a 'job' to be performed.
IJobDetail	Conveys the detail properties of a given Job instance.
IJobExecutionContext	A context bundle containing handles to various environment information, that is given to a IJobDetail instance as it is executed, and to a ITrigger instance after the execution completes.
IJobListener	The interface to be implemented by classes that want to be informed when a IJobDetail executes.
IListenerManager	Client programs may be interested in the 'listener' interfaces that are available from Quartz.
IMatcher<T extends Key<T>>	Matchers can be used in various IScheduler API methods to select the entities that should be operated upon.
IScheduleBuilder<T extends IMutableTrigger>
IScheduler	This is the main interface of a Quartz Scheduler.
ISchedulerFactory	Provides a mechanism for obtaining client-usable handles to Scheduler instances.
ISchedulerListener	The interface to be implemented by classes that want to be informed of major IScheduler events.
ISimpleTrigger	A ITrigger that is used to fire a Job at a given moment in time, and optionally repeated at a specified interval.
ITrigger	The base interface with properties common to all Triggers - use TriggerBuilder to instantiate an actual Trigger.
ITriggerListener	The interface to be implemented by classes that want to be informed when a ITrigger fires.

Class Summary

Class	Description
CalendarIntervalScheduleBuilder	CalendarIntervalScheduleBuilder is a IScheduleBuilder that defines calendar time (day, week, month, year) interval-based schedules for Triggers.
CQuartz	Quartz constants
CronExpression	Provides a parser and evaluator for unix-like cron expressions.
CronScheduleBuilder	CronScheduleBuilder is a IScheduleBuilder that defines CronExpression-based schedules for Triggers.
DailyTimeIntervalScheduleBuilder	A IScheduleBuilder 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 IJobDetails.
JobDataMap	Holds state information for Job instances.
JobKey	Uniquely identifies a IJobDetail.
QCloneUtils	Internal clone helper class.
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 IScheduler instance.
SimpleScheduleBuilder	SimpleScheduleBuilder is a IScheduleBuilder that defines strict/literal interval-based schedules for Triggers.
TriggerBuilder<T extends ITrigger>	TriggerBuilder is used to instantiate ITriggers.
TriggerKey	Uniquely identifies a ITrigger.
TriggerTimeComparator	A Comparator that compares trigger's next fire times, or in other words, sorts them according to earliest next fire time.
TriggerUtils	Convenience and utility methods for working with ITriggers.

Enum Summary

Enum	Description
EIntervalUnit
ITrigger.ECompletedExecutionInstruction	NOOP Instructs the IScheduler that the ITrigger has no further instructions.
ITrigger.EMisfireInstruction
ITrigger.ETriggerState

Exception Summary

Exception	Description
JobExecutionException	An exception that can be thrown by a IJob to indicate to the Quartz IScheduler that an error occurred while executing, and whether or not the Job requests to be re-fired immediately (using the same IJobExecutionContext, 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 IScheduler.
UnableToInterruptJobException	An exception that is thrown to indicate that a call to InterruptableJob.interrupt() failed without interrupting the Job.

Annotation Types Summary

Annotation Type	Description
DisallowConcurrentExecution	An annotation that marks a IJob class as one that must not have multiple instances executed concurrently (where instance is based-upon a IJobDetail definition - or in other words based upon a JobKey).
PersistJobDataAfterExecution	An annotation that marks a IJob class as one that makes updates to its JobDataMap during execution, and wishes the scheduler to re-store the JobDataMap when execution completes.

Package com.helger.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);