org.jminor.common

Class TaskScheduler

java.lang.Object

org.jminor.common.TaskScheduler

public final class TaskScheduler
extends java.lang.Object

A task scheduler based on a ScheduledExecutorService, scheduled at a fixed rate, using a daemon thread by default. A TaskScheduler can be stopped and restarted.

   TaskScheduler scheduler = new TaskScheduler(new Runnable() {
     public void run() {
       System.out.println("Running wild...");
     }
   }, 2, TimeUnit.SECONDS);

   scheduler.start();
   ...
   scheduler.setInterval(1);//task restarted using the new interval
   ...
   scheduler.stop();
 

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	INTERVAL_PROPERTY

Constructor Summary

Constructors

Constructor and Description
TaskScheduler(java.lang.Runnable task, int interval, int initialDelay, java.util.concurrent.TimeUnit timeUnit) Instantiates a new TaskScheduler instance with a daemon thread.
TaskScheduler(java.lang.Runnable task, int interval, int initialDelay, java.util.concurrent.TimeUnit timeUnit, java.util.concurrent.ThreadFactory threadFactory) Instantiates a new TaskScheduler instance.
TaskScheduler(java.lang.Runnable task, int interval, java.util.concurrent.TimeUnit timeUnit) Instantiates a new TaskScheduler instance, with no initial delay and a daemon thread

Method Summary

Modifier and Type	Method and Description
int	getInterval()
EventObserver<java.lang.Integer>	getIntervalObserver()
boolean	isRunning()
void	setInterval(int interval) Sets the new task interval and re-schedules the task, note that if the scheduler was stopped it will be restarted.
TaskScheduler	start() Starts this TaskScheduler, if it is running it is restarted, using the initial delay specified during construction.
void	stop() Stops this TaskScheduler, if it is not running calling this method has no effect.

Methods inherited from class java.lang.Object

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

Field Detail

INTERVAL_PROPERTY

public static final java.lang.String INTERVAL_PROPERTY

See Also:

Constant Field Values

Constructor Detail

TaskScheduler

public TaskScheduler(java.lang.Runnable task,
                     int interval,
                     java.util.concurrent.TimeUnit timeUnit)

Instantiates a new TaskScheduler instance, with no initial delay and a daemon thread

Parameters:

task - the task to run

interval - the interval

timeUnit - the time unit to use

TaskScheduler

public TaskScheduler(java.lang.Runnable task,
                     int interval,
                     int initialDelay,
                     java.util.concurrent.TimeUnit timeUnit)

Instantiates a new TaskScheduler instance with a daemon thread.

Parameters:

task - the task to run

interval - the interval

initialDelay - the initial start delay, used on restarts as well

timeUnit - the time unit to use

TaskScheduler

public TaskScheduler(java.lang.Runnable task,
                     int interval,
                     int initialDelay,
                     java.util.concurrent.TimeUnit timeUnit,
                     java.util.concurrent.ThreadFactory threadFactory)

Instantiates a new TaskScheduler instance.

Parameters:

task - the task to run

interval - the interval

initialDelay - the initial start delay, used on restarts as well

timeUnit - the time unit to use

threadFactory - the thread factory to use

Method Detail

getInterval

public int getInterval()

Returns:

the interval

setInterval

public void setInterval(int interval)

Sets the new task interval and re-schedules the task, note that if the scheduler was stopped it will be restarted.

Parameters:

interval - the interval

Throws:

java.lang.IllegalArgumentException - in case interval isn't a positive integer

getIntervalObserver

public EventObserver<java.lang.Integer> getIntervalObserver()

Returns:

an EventObserver notified each time the interval is set

start

public TaskScheduler start()

Starts this TaskScheduler, if it is running it is restarted, using the initial delay specified during construction.

Returns:

this TaskScheduler instance

stop

public void stop()

Stops this TaskScheduler, if it is not running calling this method has no effect.

isRunning

public boolean isRunning()

Returns:

true if this TaskScheduler is running