Module com.aoapps.cron

Package com.aoapps.cron

Interface CronJob

public interface CronJob

One task that is performed on a routine basis.

Author:

AO Industries, Inc.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	CronJob.Executor	The various executors that may be selected to run this job.
static enum	CronJob.ScheduleMode	The set of possible concurrency settings for cron jobs.

Method Summary

Modifier and Type	Method	Description
default CronJob.Executor	getExecutor()	Gets the executor that should be used for this job.
default String	getName()	Gets the name for this cron job.
Schedule	getSchedule()	Gets the schedule for this cron job.
default CronJob.ScheduleMode	getScheduleMode()	Gets the job scheduling mode.
default int	getThreadPriority()	Gets the Thread priority for this job.
void	run(int minute, int hour, int dayOfMonth, int month, int dayOfWeek, int year)	Performs the scheduled task.

Method Details

getName

default String getName()

Gets the name for this cron job.

Defaults to getClass().getName().

getSchedule

Schedule getSchedule()

Gets the schedule for this cron job. This is called once per minute for each job.

getScheduleMode

default CronJob.ScheduleMode getScheduleMode()

Gets the job scheduling mode.

Defaults to CronJob.ScheduleMode.SKIP.

See Also:

• CronJob.ScheduleMode

getExecutor

default CronJob.Executor getExecutor()

Gets the executor that should be used for this job.

Defaults to CronJob.Executor.UNBOUNDED.

getThreadPriority

default int getThreadPriority()

Gets the Thread priority for this job.

Defaults to Thread.NORM_PRIORITY.

See Also:

• Thread.setPriority(int)

run

void run(int minute,
 int hour,
 int dayOfMonth,
 int month,
 int dayOfWeek,
 int year)

Performs the scheduled task.

See Also:

• Schedule.isScheduled(int, int, int, int, int, int)