org.rapidcontext.core.task

Class Scheduler

java.lang.Object

org.rapidcontext.core.task.Scheduler

public class Scheduler
extends java.lang.Object

A task scheduler for asynchronous tasks and background jobs. This class handles all global background threads and task execution and provides a simple time thread implementation to avoid multiple background threads.

Version:

1.0

Author:

Per Cederberg

Constructor Summary

Constructors

Constructor and Description
Scheduler()

Method Summary

Modifier and Type	Method and Description
static boolean	schedule(Task task, long delay, long period) Schedules a recurring task.
static boolean	unschedule(Task task) Removes a task from the scheduler queue.
static void	unscheduleAll() Removes all tasks from the scheduler queue.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Scheduler

public Scheduler()

Method Detail

schedule

public static boolean schedule(Task task,
                               long delay,
                               long period)

Schedules a recurring task. Only a single task with the same task id is allowed, later tasks with the same id will be ignored (if the first one is still scheduled).

Parameters:

task - the task to run

delay - the first execution delay (in millis)

period - the waiting period (in millis)

Returns:

true if the task was scheduled, or false if an identical task was already in the queue

unschedule

public static boolean unschedule(Task task)

Removes a task from the scheduler queue.

Parameters:

task - the task to remove

Returns:

true if the task was unscheduled, or false if it had already been removed

unscheduleAll

public static void unscheduleAll()

Removes all tasks from the scheduler queue.