net.lenni0451.commons.threading

Class ThreadScheduler

java.lang.Object

net.lenni0451.commons.threading.ThreadScheduler

public class ThreadScheduler
extends java.lang.Object

A thread scheduler that can execute tasks with a delay or repeat them.
Internally a ScheduledExecutorService is used.

Constructor Summary

Constructors

Constructor and Description
ThreadScheduler(boolean daemon, boolean taskThreads) Create a new task scheduler.

Method Summary

Modifier and Type	Method and Description
java.lang.Thread	execute(java.lang.Runnable task) Directly execute a task.
java.util.concurrent.ScheduledFuture<?>	repeat(java.lang.Runnable task, long repeatDelay) Repeat a task with a fixed delay.
java.util.concurrent.ScheduledFuture<?>	repeat(java.lang.Runnable task, long startDelay, long repeatDelay) Repeat a task with a fixed delay.
java.util.concurrent.ScheduledFuture<?>	repeat(java.lang.Runnable task, long startDelay, long repeatDelay, java.util.concurrent.TimeUnit timeUnit) Repeat a task with a fixed delay.
java.util.concurrent.ScheduledFuture<?>	repeat(java.lang.Runnable task, long repeatDelay, java.util.concurrent.TimeUnit timeUnit) Repeat a task with a fixed delay.
java.util.concurrent.ScheduledFuture<?>	schedule(java.lang.Runnable task, long delay) Schedule a task to be executed after a delay.
java.util.concurrent.ScheduledFuture<?>	schedule(java.lang.Runnable task, long delay, java.util.concurrent.TimeUnit timeUnit) Schedule a task to be executed after a delay.
void	shutdown() Shutdown the scheduler.
boolean	shutdown(long timeout) Shutdown the scheduler and wait for all tasks to finish.
boolean	shutdown(long timeout, java.util.concurrent.TimeUnit timeUnit) Shutdown the scheduler and wait for all tasks to finish.

Methods inherited from class java.lang.Object

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

Constructor Detail

ThreadScheduler

public ThreadScheduler(boolean daemon,
                       boolean taskThreads)

Create a new task scheduler.

Parameters:

daemon - Whether the scheduler should use daemon threads

taskThreads - Whether the scheduler should use a new thread for each task

Method Detail

execute

public java.lang.Thread execute(java.lang.Runnable task)

Directly execute a task.

Parameters:

task - The task to execute

Returns:

The thread that is executing the task

schedule

public java.util.concurrent.ScheduledFuture<?> schedule(java.lang.Runnable task,
                                                        long delay)

Schedule a task to be executed after a delay.

Parameters:

task - The task to execute

delay - The delay in milliseconds

Returns:

The ScheduledFuture of the task

schedule

public java.util.concurrent.ScheduledFuture<?> schedule(java.lang.Runnable task,
                                                        long delay,
                                                        java.util.concurrent.TimeUnit timeUnit)

Schedule a task to be executed after a delay.

Parameters:

task - The task to execute

delay - The delay

timeUnit - The time unit of the delay

Returns:

The ScheduledFuture of the task

repeat

public java.util.concurrent.ScheduledFuture<?> repeat(java.lang.Runnable task,
                                                      long repeatDelay)

Repeat a task with a fixed delay.

Parameters:

task - The task to execute

repeatDelay - The delay between each execution in milliseconds

Returns:

The ScheduledFuture of the task

repeat

public java.util.concurrent.ScheduledFuture<?> repeat(java.lang.Runnable task,
                                                      long startDelay,
                                                      long repeatDelay)

Repeat a task with a fixed delay.

Parameters:

task - The task to execute

startDelay - The delay before the first execution in milliseconds

repeatDelay - The delay between each execution in milliseconds

Returns:

The ScheduledFuture of the task

repeat

public java.util.concurrent.ScheduledFuture<?> repeat(java.lang.Runnable task,
                                                      long repeatDelay,
                                                      java.util.concurrent.TimeUnit timeUnit)

Repeat a task with a fixed delay.

Parameters:

task - The task to execute

repeatDelay - The delay between each execution

timeUnit - The time unit of the delay

Returns:

The ScheduledFuture of the task

repeat

public java.util.concurrent.ScheduledFuture<?> repeat(java.lang.Runnable task,
                                                      long startDelay,
                                                      long repeatDelay,
                                                      java.util.concurrent.TimeUnit timeUnit)

Repeat a task with a fixed delay.

Parameters:

task - The task to execute

startDelay - The delay before the first execution

repeatDelay - The delay between each execution

timeUnit - The time unit of the delay

Returns:

The ScheduledFuture of the task

shutdown

public void shutdown()

Shutdown the scheduler.
All tasks that are currently running will be finished but no new tasks will be accepted.

shutdown

public boolean shutdown(long timeout)
                 throws java.lang.InterruptedException

Shutdown the scheduler and wait for all tasks to finish.

Parameters:

timeout - The maximum time to wait for the tasks to finish in milliseconds

Returns:

Whether all tasks finished before the timeout

Throws:

java.lang.InterruptedException - If the current thread was interrupted while waiting

shutdown

public boolean shutdown(long timeout,
                        java.util.concurrent.TimeUnit timeUnit)
                 throws java.lang.InterruptedException

Shutdown the scheduler and wait for all tasks to finish.

Parameters:

timeout - The maximum time to wait for the tasks to finish

timeUnit - The time unit of the timeout

Returns:

Whether all tasks finished before the timeout

Throws:

java.lang.InterruptedException - If the current thread was interrupted while waiting