com.cjcrafter.foliascheduler

Interface GlobalSchedulerImplementation

public interface GlobalSchedulerImplementation

Represents a scheduler that can schedule tasks to be run.

Method Summary

Modifier and Type	Method and Description
void	cancelTasks() Cancels all scheduled global tasks that were scheduled using your Plugin instance.
void	execute(@NotNull java.lang.Runnable run) Schedules a task to be run.
default @NotNull TaskImplementation<java.lang.Void>	run(@NotNull java.util.function.Consumer<TaskImplementation<java.lang.Void>> consumer) Schedules a task to be run after a delay.
<T> @NotNull TaskImplementation<T>	run(@NotNull java.util.function.Function<TaskImplementation<T>,T> function) Schedules a task to be run after a delay.
default @NotNull TaskImplementation<java.lang.Void>	run(@NotNull java.lang.Runnable runnable) Schedules a task to be run after a delay.
default @NotNull TaskImplementation<java.lang.Void>	runAtFixedRate(@NotNull java.util.function.Consumer<TaskImplementation<java.lang.Void>> consumer, long delay, long period) Schedules a task to be run after a delay.
<T> @NotNull TaskImplementation<T>	runAtFixedRate(@NotNull java.util.function.Function<TaskImplementation<T>,T> function, long delay, long period) Schedules a task to be run after a delay.
default @NotNull TaskImplementation<java.lang.Void>	runAtFixedRate(@NotNull java.lang.Runnable runnable, long delay, long period) Schedules a task to be run after a delay.
default @NotNull TaskImplementation<java.lang.Void>	runDelayed(@NotNull java.util.function.Consumer<TaskImplementation<java.lang.Void>> consumer, long delay) Schedules a task to be run after a delay.
<T> @NotNull TaskImplementation<T>	runDelayed(@NotNull java.util.function.Function<TaskImplementation<T>,T> function, long delay) Schedules a task to be run after a delay.
default @NotNull TaskImplementation<java.lang.Void>	runDelayed(@NotNull java.lang.Runnable runnable, long delay) Schedules a task to be run after a delay.

Method Detail

execute

void execute(@NotNull
             @NotNull java.lang.Runnable run)

Schedules a task to be run.

Parameters:

run - The task to run.

run

@NotNull
<T> @NotNull TaskImplementation<T> run(@NotNull
                                                @NotNull java.util.function.Function<TaskImplementation<T>,T> function)

Schedules a task to be run after a delay.

Parameters:

function - The task to run.

Returns:

The task that was scheduled.

run

@NotNull
default @NotNull TaskImplementation<java.lang.Void> run(@NotNull
                                                                 @NotNull java.util.function.Consumer<TaskImplementation<java.lang.Void>> consumer)

Schedules a task to be run after a delay.

Parameters:

consumer - The task to run.

Returns:

The task that was scheduled.

run

@NotNull
default @NotNull TaskImplementation<java.lang.Void> run(@NotNull
                                                                 @NotNull java.lang.Runnable runnable)

Schedules a task to be run after a delay.

Parameters:

runnable - The task to run.

Returns:

The task that was scheduled.

runDelayed

@NotNull
<T> @NotNull TaskImplementation<T> runDelayed(@NotNull
                                                       @NotNull java.util.function.Function<TaskImplementation<T>,T> function,
                                                       long delay)

Schedules a task to be run after a delay.

Parameters:

function - The task to run.

delay - The delay in ticks before the task is run.

Returns:

The task that was scheduled.

runDelayed

@NotNull
default @NotNull TaskImplementation<java.lang.Void> runDelayed(@NotNull
                                                                        @NotNull java.util.function.Consumer<TaskImplementation<java.lang.Void>> consumer,
                                                                        long delay)

Schedules a task to be run after a delay.

Parameters:

consumer - The task to run.

delay - The delay in ticks before the task is run.

Returns:

The task that was scheduled.

runDelayed

@NotNull
default @NotNull TaskImplementation<java.lang.Void> runDelayed(@NotNull
                                                                        @NotNull java.lang.Runnable runnable,
                                                                        long delay)

Schedules a task to be run after a delay.

Parameters:

runnable - The task to run.

delay - The delay in ticks before the task is run.

Returns:

The task that was scheduled.

runAtFixedRate

@NotNull
<T> @NotNull TaskImplementation<T> runAtFixedRate(@NotNull
                                                           @NotNull java.util.function.Function<TaskImplementation<T>,T> function,
                                                           long delay,
                                                           long period)

Schedules a task to be run after a delay.

Parameters:

function - The task to run.

delay - The delay before the task is run.

period - The time unit of the delay.

runAtFixedRate

@NotNull
default @NotNull TaskImplementation<java.lang.Void> runAtFixedRate(@NotNull
                                                                            @NotNull java.util.function.Consumer<TaskImplementation<java.lang.Void>> consumer,
                                                                            long delay,
                                                                            long period)

Schedules a task to be run after a delay.

Parameters:

consumer - The task to run.

delay - The delay before the task is run.

period - The time unit of the delay.

runAtFixedRate

@NotNull
default @NotNull TaskImplementation<java.lang.Void> runAtFixedRate(@NotNull
                                                                            @NotNull java.lang.Runnable runnable,
                                                                            long delay,
                                                                            long period)

Schedules a task to be run after a delay.

Parameters:

runnable - The task to run.

delay - The delay before the task is run.

period - The time unit of the delay.

cancelTasks

void cancelTasks()

Cancels all scheduled global tasks that were scheduled using your Plugin instance.

Note that the behavior of this method changes depending on the server implementation. For example, in Spigot, this method will cancel all tasks (sync + async) scheduled by the plugin, while in Paper/Folia, this method will only cancel tasks scheduled using the global scheduler.

See Also:

AsyncSchedulerImplementation.cancelTasks(), Issue #28