C D E F G I R S T U V X

C

com.jarretttaylor.cron - package com.jarretttaylor.cron

com.jarretttaylor.cron.xml - package com.jarretttaylor.cron.xml

compareTo(CronJob) - Method in class com.jarretttaylor.cron.CronJobImpl

compares job id's

convertSchedule(String) - Static method in class com.jarretttaylor.cron.Utils

Cron - Class in com.jarretttaylor.cron

Manages cron jobs.

Cron(Set<CronJob>, long, boolean) - Constructor for class com.jarretttaylor.cron.Cron

creates a new Cron scheduler.

CronClass - Interface in com.jarretttaylor.cron

Inteface allowing access to information about individual cron classes.

CronClassImpl - Class in com.jarretttaylor.cron

represents one of potentially many classes in a cron job. serves as a data holder for information that will be needed when executing the specific class.

CronClassImpl(String, boolean, Map) - Constructor for class com.jarretttaylor.cron.CronClassImpl

creates a new instance of this class

CronJob - Interface in com.jarretttaylor.cron

Inteface allowing access to information about individual cron jobs.

CronJobImpl - Class in com.jarretttaylor.cron

represents a single cron job.

CronJobImpl(String, String, String, boolean, boolean, List) - Constructor for class com.jarretttaylor.cron.CronJobImpl

creates a new instance of this class.

CronRunnable - Interface in com.jarretttaylor.cron

Any class that should be run by Cron must implement CronRunnable.

D

disable() - Method in class com.jarretttaylor.cron.Cron

disables cron (pause)

disable() - Method in interface com.jarretttaylor.cron.CronJob

disable() - Method in class com.jarretttaylor.cron.CronJobImpl

sets the disabled flag to true

disableCronJob(String) - Method in class com.jarretttaylor.cron.Cron

disabled the specified cron job

E

enable() - Method in class com.jarretttaylor.cron.Cron

enables cron

enable() - Method in interface com.jarretttaylor.cron.CronJob

enable() - Method in class com.jarretttaylor.cron.CronJobImpl

sets the disabled flag to false

enableCronJob(String) - Method in class com.jarretttaylor.cron.Cron

disabled the specified cron job

equals(CronJob) - Method in class com.jarretttaylor.cron.CronJobImpl

compares job id's

execute(Map) - Method in interface com.jarretttaylor.cron.CronRunnable

execute returns true/false representing the success/failure of the action.

execute(Map) - Method in class com.jarretttaylor.cron.SystemCommand

F

forceRunCronJob(String) - Method in class com.jarretttaylor.cron.Cron

Runs the specificed job immediately if is not already running (even if it is disabled.

G

getClassName() - Method in interface com.jarretttaylor.cron.CronClass

returns the className

getClassName() - Method in class com.jarretttaylor.cron.CronClassImpl

returns the className

getContinuable() - Method in interface com.jarretttaylor.cron.CronClass

true if the next class is allowed to execute in the event this one fails

getContinuable() - Method in class com.jarretttaylor.cron.CronClassImpl

true if the next class is allowed to execute in the event this one fails

getCronClasses() - Method in interface com.jarretttaylor.cron.CronJob

returns the list of CronClass objects associated with this job

getCronClasses() - Method in class com.jarretttaylor.cron.CronJobImpl

returns the list of CronClass objects associated with this job

getCronJobs() - Method in class com.jarretttaylor.cron.Cron

returns a set of CronJob objects

getDisabled() - Method in interface com.jarretttaylor.cron.CronJob

returns true if this job is disabled and should not be run

getDisabled() - Method in class com.jarretttaylor.cron.CronJobImpl

returns true if this job is disabled and should not be run

getExecutingClassName() - Method in interface com.jarretttaylor.cron.CronJob

returns the cron class name that is currently executing

getExecutingClassName() - Method in class com.jarretttaylor.cron.CronJobImpl

returns the cron class name that us currently executing

getJobId() - Method in interface com.jarretttaylor.cron.CronJob

returns the id of the job

getJobId() - Method in class com.jarretttaylor.cron.CronJobImpl

returns the id of the job

getJobName() - Method in interface com.jarretttaylor.cron.CronJob

returns the name of the job

getJobName() - Method in class com.jarretttaylor.cron.CronJobImpl

returns the name of the job

getNextRun(String, Date) - Static method in class com.jarretttaylor.cron.Utils

gets the next run date for the supplied schedule, starting from the supplied date

getNextRunDate() - Method in interface com.jarretttaylor.cron.CronJob

convenience method to return next run date/time for this job.

getNextRunDate() - Method in class com.jarretttaylor.cron.CronJobImpl

returns next run date of this job by calling Utils.getNextRun(schedule, new Date())

getParameters() - Method in interface com.jarretttaylor.cron.CronClass

the key/value pairs specified with this cron entry

getParameters() - Method in class com.jarretttaylor.cron.CronClassImpl

the key/value pairs specified with this cron entry

getRunning() - Method in interface com.jarretttaylor.cron.CronJob

returns true if this job should be run on startup

getRunning() - Method in class com.jarretttaylor.cron.CronJobImpl

returns true if the job is currently running

getSchedule() - Method in interface com.jarretttaylor.cron.CronJob

returns the cron schedule

getSchedule() - Method in class com.jarretttaylor.cron.CronJobImpl

returns the cron schedule

getStartup() - Method in interface com.jarretttaylor.cron.CronJob

returns true if this job is running

getStartup() - Method in class com.jarretttaylor.cron.CronJobImpl

returns true if this job should be run on startup

I

isDisabled() - Method in class com.jarretttaylor.cron.Cron

returns true if cron is not allowed to kick off CronRunner processes

isProcessing() - Method in class com.jarretttaylor.cron.Cron

returns true if cron is kicking off CronRunner processes

isReboot(String) - Static method in class com.jarretttaylor.cron.Utils

R

reload(Set<CronJob>, long, boolean) - Method in class com.jarretttaylor.cron.Cron

Reloads the cron settings.

reload(String, boolean) - Method in class com.jarretttaylor.cron.xml.XmlCron

Reloads the cron settings with the supplied file uri by parsing the document and calling the (Document document, boolean terminateRunningJobs) method.

reload(Document, boolean) - Method in class com.jarretttaylor.cron.xml.XmlCron

Reloads the cron settings with the supplied document.

reset() - Method in class com.jarretttaylor.cron.Cron

sets the killed flag to false and resets all CronJob objects.

reset() - Method in interface com.jarretttaylor.cron.CronJob

reset() - Method in class com.jarretttaylor.cron.CronJobImpl

sets the killed flag to false

run() - Method in class com.jarretttaylor.cron.Cron

This loops while "killed" is false (i.e. terminate() has not been called).

run() - Method in class com.jarretttaylor.cron.CronJobImpl

loops throught cronClasses and creates an instance the class specified, calling execute.

S

setFirstRun(boolean) - Method in class com.jarretttaylor.cron.Cron

if firstRun is true, all the enabled startup jobs will be run.

SystemCommand - Class in com.jarretttaylor.cron

Used to execute programs or commands via a system shell.

SystemCommand() - Constructor for class com.jarretttaylor.cron.SystemCommand

T

terminate() - Method in class com.jarretttaylor.cron.Cron

calls terminate on all CronRunners and CronJobs.

terminate() - Method in interface com.jarretttaylor.cron.CronJob

terminate() - Method in class com.jarretttaylor.cron.CronJobImpl

attempts to interrupt the current process

terminate() - Method in interface com.jarretttaylor.cron.CronRunnable

requests that the class cease executing

terminate() - Method in class com.jarretttaylor.cron.SystemCommand

terminateCronJob(String) - Method in class com.jarretttaylor.cron.Cron

requests for the specified cron job to terminate. actual terminate depends on the implementing class

U

Utils - Class in com.jarretttaylor.cron

provides static utility methods.

V

validateSchedule(CronJob) - Static method in class com.jarretttaylor.cron.Utils

validates a cron job's schedule. returns true if the schedule validates.

X

XmlCron - Class in com.jarretttaylor.cron.xml

XmlCron(String, boolean) - Constructor for class com.jarretttaylor.cron.xml.XmlCron

creates a new Cron scheduler with the supplied uri by parsing the document and calling the (Document document, boolean fork) constructor.

XmlCron(Document, boolean) - Constructor for class com.jarretttaylor.cron.xml.XmlCron

creates a new Cron scheduler with the supplied document.

C D E F G I R S T U V X