Package ca.spottedleaf.concurrentutil.scheduler

Class ScheduledTaskThreadPool

java.lang.Object

ca.spottedleaf.concurrentutil.scheduler.ScheduledTaskThreadPool

public final class ScheduledTaskThreadPool
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ScheduledTaskThreadPool.SchedulableTick	Represents a tickable task that can be scheduled into a ScheduledTaskThreadPool.

Field Summary

Fields

Modifier and Type	Field	Description
static final long	DEADLINE_NOT_SET

Constructor Summary

Constructors

Constructor	Description
ScheduledTaskThreadPool(ThreadFactory threadFactory)

Method Summary

Modifier and Type	Method	Description
boolean	cancel(ScheduledTaskThreadPool.SchedulableTick tick)	Returns false if the task is not scheduled or is cancelled, returns true if the task was cancelled by this thread
void	halt()	Attempts to prevent further execution of tasks.
boolean	join(long msToWait)	Waits until all threads in this pool have shutdown, or until the specified time has passed.
boolean	joinInterruptable(long msToWait)	Waits until all threads in this pool have shutdown, or until the specified time has passed.
void	notifyTasks(ScheduledTaskThreadPool.SchedulableTick tick)	Indicates that intermediate tasks are available to be executed by the task.
void	schedule(ScheduledTaskThreadPool.SchedulableTick tick)	Schedules the specified task to be executed on this thread pool.

Methods inherited from class java.lang.Object

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

Field Details

DEADLINE_NOT_SET

public static final long DEADLINE_NOT_SET

See Also:

• Constant Field Values

Constructor Details

ScheduledTaskThreadPool

public ScheduledTaskThreadPool(ThreadFactory threadFactory)

Method Details

halt

public void halt()

Attempts to prevent further execution of tasks.

join

public boolean join(long msToWait)

Waits until all threads in this pool have shutdown, or until the specified time has passed.

Parameters:

msToWait - Maximum time to wait.

Returns:

false if the maximum time passed, true otherwise.

joinInterruptable

public boolean joinInterruptable(long msToWait)
                          throws InterruptedException

Waits until all threads in this pool have shutdown, or until the specified time has passed.

Parameters:

msToWait - Maximum time to wait.

Returns:

false if the maximum time passed, true otherwise.

Throws:

InterruptedException - If this thread is interrupted.

schedule

public void schedule(ScheduledTaskThreadPool.SchedulableTick tick)

Schedules the specified task to be executed on this thread pool.

Parameters:

tick - Specified task

Throws:

IllegalStateException - If the task is already scheduled

See Also:

• ScheduledTaskThreadPool.SchedulableTick

notifyTasks

public void notifyTasks(ScheduledTaskThreadPool.SchedulableTick tick)

Indicates that intermediate tasks are available to be executed by the task.

Parameters:

tick - The specified task

See Also:

• ScheduledTaskThreadPool.SchedulableTick

cancel

public boolean cancel(ScheduledTaskThreadPool.SchedulableTick tick)

Returns false if the task is not scheduled or is cancelled, returns true if the task was cancelled by this thread