Package org.kingdoms.scheduler

Interface TaskScheduler

All Known Implementing Classes:

AbstractJavaScheduler, BukkitSchedulerAdapter

public interface TaskScheduler

A scheduler for running tasks using the systems provided by the platform

Method Summary

Modifier and Type	Method	Description
Executor	async()	Gets an async executor instance
ScheduledTask	asyncLater(Duration delay, Runnable task)	Executes the given task with a delay.
ScheduledTask	asyncRepeating(Duration initialDelay, Duration interval, Runnable task)	Executes the given task repeatedly at a given interval.
default void	executeAsync(Runnable task)	Executes a task async
default void	executeSync(Runnable task)	Executes a task sync
default CompletableFuture<Void>	runFuture(Runnable runnable)
void	shutdownExecutor()	Shuts down the executor instance.
void	shutdownScheduler()	Shuts down the scheduler instance.
default <T> CompletableFuture<T>	supplyFuture(Callable<T> callable)
Executor	sync()	Gets a sync executor instance
void	syncLater(Runnable task, Duration startIn)

Method Details

async

Executor async()

Gets an async executor instance

Returns:

an async executor instance

sync

Executor sync()

Gets a sync executor instance

Returns:

a sync executor instance

executeAsync

default void executeAsync(Runnable task)

Executes a task async

Parameters:

task - the task

executeSync

default void executeSync(Runnable task)

Executes a task sync

Parameters:

task - the task

supplyFuture

default <T> CompletableFuture<T> supplyFuture(Callable<T> callable)

runFuture

default CompletableFuture<Void> runFuture(Runnable runnable)

syncLater

void syncLater(Runnable task,
 Duration startIn)

asyncLater

ScheduledTask asyncLater(Duration delay,
 Runnable task)

Executes the given task with a delay.

Parameters:

task - the task

Returns:

the resultant task instance

asyncRepeating

ScheduledTask asyncRepeating(Duration initialDelay,
 Duration interval,
 Runnable task)

Executes the given task repeatedly at a given interval.

Returns:

the resultant task instance

shutdownScheduler

void shutdownScheduler()

Shuts down the scheduler instance.

asyncLater(Duration, Runnable) and asyncRepeating(Duration, Duration, Runnable).

shutdownExecutor

void shutdownExecutor()

Shuts down the executor instance.

async() and executeAsync(Runnable).