org.quartz |
Package org.quartz
The main package of Quartz, containing the client-side interfaces.
See the Quartz project
at Open Symphony for more information.
|
Java Source File Name | Type | Comment |
AnnualCalendarTest.java | Class | Unit test for AnnualCalendar serialization backwards compatibility. |
Calendar.java | Interface |
An interface to be implemented by objects that define spaces of time during
which an associated
Trigger may fire. |
CriticalSchedulerException.java | Class |
An exception that is thrown to indicate that there has been a critical
failure within the scheduler's core services (such as loss of database
connectivity). |
CronExpression.java | Class | Provides a parser and evaluator for unix-like cron expressions. |
CronExpressionTest.java | Class | |
CronTrigger.java | Class |
A concrete
Trigger that is used to fire a
org.quartz.JobDetail
at given moments in time, defined with Unix 'cron-like' definitions. |
InterruptableJob.java | Interface |
The interface to be implemented by
Job s that provide a
mechanism for having their execution interrupted. |
Job.java | Interface |
The interface to be implemented by classes which represent a 'job' to be
performed. |
JobDataMap.java | Class |
Holds state information for Job instances.
JobDataMap instances are stored once when the Job
is added to a scheduler. |
JobDataMapTest.java | Class | Unit test for JobDataMap serialization backwards compatibility. |
JobDetail.java | Class |
Conveys the detail properties of a given Job instance.
Quartz does not store an actual instance of a Job class, but
instead allows you to define an instance of one, through the use of a JobDetail .
Job s have a name and group associated with them, which
should uniquely identify them within a single
Scheduler .
Trigger s are the 'mechanism' by which Job s
are scheduled. |
JobDetailTest.java | Class | Unit test for JobDetail. |
JobExecutionContext.java | Class |
A context bundle containing handles to various environment information, that
is given to a
org.quartz.JobDetail instance as it is
executed, and to a
Trigger instance after the
execution completes.
The JobDataMap found on this object (via the
getMergedJobDataMap() method) serves as a convenience -
it is a merge of the JobDataMap found on the
JobDetail and the one found on the Trigger , with
the value in the latter overriding any same-named values in the former.
It is thus considered a 'best practice' that the execute code of a Job
retrieve data from the JobDataMap found on this object NOTE: Do not
expect value 'set' into this JobDataMap to somehow be set back onto a
StatefulJob 's own JobDataMap.
JobExecutionContext s are also returned from the
Scheduler.getCurrentlyExecutingJobs()
method. |
JobExecutionException.java | Class |
An exception that can be thrown by a
org.quartz.Job
to indicate to the Quartz
Scheduler that an error
occured 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. |
JobListener.java | Interface |
The interface to be implemented by classes that want to be informed when a
org.quartz.JobDetail executes. |
JobPersistenceException.java | Class |
An exception that is thrown to indicate that there has been a failure in the
scheduler's underlying persistence mechanism. |
NthIncludedDayTrigger.java | Class | A trigger which fires on the Nth day of every interval type
(
NthIncludedDayTrigger.INTERVAL_TYPE_WEEKLY ,
NthIncludedDayTrigger.INTERVAL_TYPE_MONTHLY or
NthIncludedDayTrigger.INTERVAL_TYPE_YEARLY ) that is not excluded by the associated
calendar. |
NthIncludedDayTriggerTest.java | Class | Unit test for NthIncludedDayTrigger serialization backwards compatibility. |
ObjectAlreadyExistsException.java | Class |
An exception that is thrown to indicate that an attempt to store a new
object (i.e. |
PriorityTest.java | Class | Test Trigger priority support. |
Scheduler.java | Interface |
This is the main interface of a Quartz Scheduler.
A Scheduler maintains a registery of
org.quartz.JobDetail
s and
Trigger s. |
SchedulerConfigException.java | Class |
An exception that is thrown to indicate that there is a misconfiguration of
the SchedulerFactory - or one of the components it
configures. |
SchedulerContext.java | Class |
Holds context/environment data that can be made available to Jobs as they
are executed. |
SchedulerException.java | Class |
Base class for exceptions thrown by the Quartz
Scheduler . |
SchedulerFactory.java | Interface |
Provides a mechanism for obtaining client-usable handles to Scheduler
instances. |
SchedulerListener.java | Interface |
The interface to be implemented by classes that want to be informed of major
Scheduler events. |
SchedulerMetaData.java | Class |
Describes the settings and capabilities of a given
Scheduler
instance. |
SerializationTestSupport.java | Class | Base class for unit tests that wish to verify
backwards compatibily of serialization with earlier versions
of Quartz. |
SimpleTrigger.java | Class |
A concrete
Trigger that is used to fire a
org.quartz.JobDetail
at a given moment in time, and optionally repeated at a specified interval. |
SimpleTriggerTest.java | Class | Unit test for SimpleTrigger serialization backwards compatibility. |
StatefulJob.java | Interface |
A marker interface for
org.quartz.JobDetail s that
wish to have their state maintained between executions.
StatefulJob instances follow slightly different rules from
regular Job instances. |
Trigger.java | Class |
The base abstract class to be extended by all Trigger s.
Triggers s have a name and group associated with them, which
should uniquely identify them within a single
Scheduler .
Trigger s are the 'mechanism' by which Job s
are scheduled. |
TriggerListener.java | Interface |
The interface to be implemented by classes that want to be informed when a
Trigger fires. |
TriggerUtils.java | Class |
Convenience and utility methods for simplifying the construction and
configuration of
Trigger s . |
UnableToInterruptJobException.java | Class |
An exception that is thrown to indicate that a call to
InterruptableJob.interrupt() failed without interrupting the Job. |