org.spongepowered.api.scheduler

Interface Scheduler

public interface Scheduler

Represents a scheduler for running Tasks.

Method Summary

Modifier and Type	Method and Description
SpongeExecutorService	createAsyncExecutor(Object plugin) Creates a new ExecutorService that can be used to schedule asynchronous tasks through the standard Java concurrency interfaces.
SpongeExecutorService	createSyncExecutor(Object plugin) Creates a new ExecutorService that can be used to schedule synchronous tasks through the standard Java concurrency interfaces.
Task.Builder	createTaskBuilder() Gets a new instance of a Task.Builder.
int	getPreferredTickInterval() Gets the ideal delay between ticks in milliseconds.
Set<Task>	getScheduledTasks() Returns a set of all currently scheduled tasks.
Set<Task>	getScheduledTasks(boolean async) Returns a set of all currently scheduled tasks for either asynchronous or synchronous execution.
Set<Task>	getScheduledTasks(Object plugin) Returns a set of all currently scheduled tasks owned by the given plugin.
Optional<Task>	getTaskById(UUID id) Retrieves a scheduled or running task by its unique ID.
Set<Task>	getTasksByName(String pattern) Returns a set of Tasks that match the Regular Expression pattern.

Method Detail

createTaskBuilder

Task.Builder createTaskBuilder()

Gets a new instance of a Task.Builder.

Returns:

A new task builder

getTaskById

Optional<Task> getTaskById(UUID id)

Retrieves a scheduled or running task by its unique ID.

Parameters:

id - The id of the task

Returns:

The scheduled or running task, or Optional.empty()

getTasksByName

Set<Task> getTasksByName(String pattern)

Returns a set of Tasks that match the Regular Expression pattern.

Parameters:

pattern - The regular expression pattern applied to the name of tasks

Returns:

A set of Tasks that have names that match the pattern, the set will be empty if no names match

getScheduledTasks

Set<Task> getScheduledTasks()

Returns a set of all currently scheduled tasks.

Returns:

A set of scheduled tasks

getScheduledTasks

Set<Task> getScheduledTasks(boolean async)

Returns a set of all currently scheduled tasks for either asynchronous or synchronous execution.

Parameters:

async - True to get all async tasks, false to get all sync tasks

Returns:

A set of scheduled tasks for the given sync type

getScheduledTasks

Set<Task> getScheduledTasks(Object plugin)

Returns a set of all currently scheduled tasks owned by the given plugin.

Parameters:

plugin - The plugin that created the tasks

Returns:

A set of scheduled tasks

getPreferredTickInterval

int getPreferredTickInterval()

Gets the ideal delay between ticks in milliseconds. The server aims to stabilise at this value.

Returns:

The preferred tick interval

createSyncExecutor

SpongeExecutorService createSyncExecutor(Object plugin)

Creates a new ExecutorService that can be used to schedule synchronous tasks through the standard Java concurrency interfaces.

Parameters:

plugin - The plugin that will own the created tasks

Returns:

A new executor service that can be used to execute synchronous tasks

createAsyncExecutor

SpongeExecutorService createAsyncExecutor(Object plugin)

Creates a new ExecutorService that can be used to schedule asynchronous tasks through the standard Java concurrency interfaces.

Parameters:

plugin - The plugin that will own the created tasks

Returns:

A new executor service that can be used to execute asynchronous tasks

See Also:

Task.Builder.async()