be.seeseemelk.mockbukkit.scheduler

Class BukkitSchedulerMock

java.lang.Object

be.seeseemelk.mockbukkit.scheduler.BukkitSchedulerMock

All Implemented Interfaces:

org.bukkit.scheduler.BukkitScheduler

public class BukkitSchedulerMock
extends java.lang.Object
implements org.bukkit.scheduler.BukkitScheduler

Constructor Summary

Constructors

Constructor and Description
BukkitSchedulerMock()

Method Summary

Modifier and Type	Method and Description
<T> @NotNull java.util.concurrent.Future<T>	callSyncMethod(@NotNull org.bukkit.plugin.Plugin plugin, @NotNull java.util.concurrent.Callable<T> task)
void	cancelTask(int taskId)
void	cancelTasks(@NotNull org.bukkit.plugin.Plugin plugin)
@NotNull java.util.concurrent.Future<?>	executeAsyncEvent(org.bukkit.event.Event event)
protected int	getActiveRunningCount()
@NotNull java.util.List<org.bukkit.scheduler.BukkitWorker>	getActiveWorkers()
long	getCurrentTick() Get the current tick of the server.
int	getNumberOfQueuedAsyncTasks() Gets the number of async tasks which are awaiting execution.
@NotNull java.util.List<org.bukkit.scheduler.BukkitTask>	getPendingTasks()
boolean	isCurrentlyRunning(int taskId)
boolean	isQueued(int taskId)
void	performOneTick() Perform one tick on the server.
void	performTicks(long ticks) Perform a number of ticks on the server.
@NotNull org.bukkit.scheduler.BukkitTask	runTask(@NotNull org.bukkit.plugin.Plugin plugin, @NotNull org.bukkit.scheduler.BukkitRunnable task)
void	runTask(@NotNull org.bukkit.plugin.Plugin plugin, @NotNull java.util.function.Consumer<org.bukkit.scheduler.BukkitTask> task)
@NotNull org.bukkit.scheduler.BukkitTask	runTask(@NotNull org.bukkit.plugin.Plugin plugin, @NotNull java.lang.Runnable task)
@NotNull org.bukkit.scheduler.BukkitTask	runTaskAsynchronously(@NotNull org.bukkit.plugin.Plugin plugin, @NotNull org.bukkit.scheduler.BukkitRunnable task)
void	runTaskAsynchronously(@NotNull org.bukkit.plugin.Plugin plugin, @NotNull java.util.function.Consumer<org.bukkit.scheduler.BukkitTask> task)
@NotNull org.bukkit.scheduler.BukkitTask	runTaskAsynchronously(@NotNull org.bukkit.plugin.Plugin plugin, @NotNull java.lang.Runnable task)
@NotNull org.bukkit.scheduler.BukkitTask	runTaskLater(@NotNull org.bukkit.plugin.Plugin plugin, @NotNull org.bukkit.scheduler.BukkitRunnable task, long delay)
void	runTaskLater(@NotNull org.bukkit.plugin.Plugin plugin, @NotNull java.util.function.Consumer<org.bukkit.scheduler.BukkitTask> task, long delay)
@NotNull org.bukkit.scheduler.BukkitTask	runTaskLater(@NotNull org.bukkit.plugin.Plugin plugin, @NotNull java.lang.Runnable task, long delay)
@NotNull org.bukkit.scheduler.BukkitTask	runTaskLaterAsynchronously(@NotNull org.bukkit.plugin.Plugin plugin, @NotNull org.bukkit.scheduler.BukkitRunnable task, long delay)
void	runTaskLaterAsynchronously(@NotNull org.bukkit.plugin.Plugin plugin, @NotNull java.util.function.Consumer<org.bukkit.scheduler.BukkitTask> task, long delay)
@NotNull org.bukkit.scheduler.BukkitTask	runTaskLaterAsynchronously(@NotNull org.bukkit.plugin.Plugin plugin, @NotNull java.lang.Runnable task, long delay)
@NotNull org.bukkit.scheduler.BukkitTask	runTaskTimer(@NotNull org.bukkit.plugin.Plugin plugin, @NotNull org.bukkit.scheduler.BukkitRunnable task, long delay, long period)
void	runTaskTimer(@NotNull org.bukkit.plugin.Plugin plugin, @NotNull java.util.function.Consumer<org.bukkit.scheduler.BukkitTask> task, long delay, long period)
@NotNull org.bukkit.scheduler.BukkitTask	runTaskTimer(@NotNull org.bukkit.plugin.Plugin plugin, @NotNull java.lang.Runnable task, long delay, long period)
@NotNull org.bukkit.scheduler.BukkitTask	runTaskTimerAsynchronously(@NotNull org.bukkit.plugin.Plugin plugin, @NotNull org.bukkit.scheduler.BukkitRunnable task, long delay, long period)
void	runTaskTimerAsynchronously(@NotNull org.bukkit.plugin.Plugin plugin, @NotNull java.util.function.Consumer<org.bukkit.scheduler.BukkitTask> task, long delay, long period)
@NotNull org.bukkit.scheduler.BukkitTask	runTaskTimerAsynchronously(@NotNull org.bukkit.plugin.Plugin plugin, @NotNull java.lang.Runnable task, long delay, long period)
int	scheduleAsyncDelayedTask(@NotNull org.bukkit.plugin.Plugin plugin, @NotNull java.lang.Runnable task)
int	scheduleAsyncDelayedTask(@NotNull org.bukkit.plugin.Plugin plugin, @NotNull java.lang.Runnable task, long delay)
int	scheduleAsyncRepeatingTask(@NotNull org.bukkit.plugin.Plugin plugin, @NotNull java.lang.Runnable task, long delay, long period)
int	scheduleSyncDelayedTask(@NotNull org.bukkit.plugin.Plugin plugin, @NotNull org.bukkit.scheduler.BukkitRunnable task)
int	scheduleSyncDelayedTask(@NotNull org.bukkit.plugin.Plugin plugin, @NotNull org.bukkit.scheduler.BukkitRunnable task, long delay)
int	scheduleSyncDelayedTask(@NotNull org.bukkit.plugin.Plugin plugin, @NotNull java.lang.Runnable task)
int	scheduleSyncDelayedTask(@NotNull org.bukkit.plugin.Plugin plugin, @NotNull java.lang.Runnable task, long delay)
int	scheduleSyncRepeatingTask(@NotNull org.bukkit.plugin.Plugin plugin, @NotNull org.bukkit.scheduler.BukkitRunnable task, long delay, long period)
int	scheduleSyncRepeatingTask(@NotNull org.bukkit.plugin.Plugin plugin, @NotNull java.lang.Runnable task, long delay, long period)
void	setShutdownTimeout(long timeout)
void	shutdown() Shuts the scheduler down.
void	waitAsyncTasksFinished() Waits until all asynchronous tasks have finished executing.

Methods inherited from class java.lang.Object

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

Constructor Detail

BukkitSchedulerMock

public BukkitSchedulerMock()

Method Detail

setShutdownTimeout

public void setShutdownTimeout(long timeout)

shutdown

public void shutdown()

Shuts the scheduler down. Note that this function will throw exception that where thrown by old asynchronous tasks.

executeAsyncEvent

@NotNull
public @NotNull java.util.concurrent.Future<?> executeAsyncEvent(org.bukkit.event.Event event)

getCurrentTick

public long getCurrentTick()

Get the current tick of the server.

Returns:

The current tick of the server.

performOneTick

public void performOneTick()

Perform one tick on the server.

performTicks

public void performTicks(long ticks)

Perform a number of ticks on the server.

Parameters:

ticks - The number of ticks to executed.

getNumberOfQueuedAsyncTasks

public int getNumberOfQueuedAsyncTasks()

Gets the number of async tasks which are awaiting execution.

Returns:

The number of async tasks which are pending execution.

waitAsyncTasksFinished

public void waitAsyncTasksFinished()

Waits until all asynchronous tasks have finished executing. If you have an asynchronous task that runs indefinitely, this function will never return.

runTask

@NotNull
public @NotNull org.bukkit.scheduler.BukkitTask runTask(@NotNull
                                                                 @NotNull org.bukkit.plugin.Plugin plugin,
                                                                 @NotNull
                                                                 @NotNull java.lang.Runnable task)

Specified by:

runTask in interface org.bukkit.scheduler.BukkitScheduler

runTask

@NotNull
public @NotNull org.bukkit.scheduler.BukkitTask runTask(@NotNull
                                                                 @NotNull org.bukkit.plugin.Plugin plugin,
                                                                 @NotNull
                                                                 @NotNull org.bukkit.scheduler.BukkitRunnable task)

Specified by:

runTask in interface org.bukkit.scheduler.BukkitScheduler

runTaskLater

@NotNull
public @NotNull org.bukkit.scheduler.BukkitTask runTaskLater(@NotNull
                                                                      @NotNull org.bukkit.plugin.Plugin plugin,
                                                                      @NotNull
                                                                      @NotNull java.lang.Runnable task,
                                                                      long delay)

Specified by:

runTaskLater in interface org.bukkit.scheduler.BukkitScheduler

runTaskTimer

@NotNull
public @NotNull org.bukkit.scheduler.BukkitTask runTaskTimer(@NotNull
                                                                      @NotNull org.bukkit.plugin.Plugin plugin,
                                                                      @NotNull
                                                                      @NotNull java.lang.Runnable task,
                                                                      long delay,
                                                                      long period)

Specified by:

runTaskTimer in interface org.bukkit.scheduler.BukkitScheduler

runTaskTimer

@NotNull
public @NotNull org.bukkit.scheduler.BukkitTask runTaskTimer(@NotNull
                                                                      @NotNull org.bukkit.plugin.Plugin plugin,
                                                                      @NotNull
                                                                      @NotNull org.bukkit.scheduler.BukkitRunnable task,
                                                                      long delay,
                                                                      long period)

Specified by:

runTaskTimer in interface org.bukkit.scheduler.BukkitScheduler

scheduleSyncDelayedTask

public int scheduleSyncDelayedTask(@NotNull
                                   @NotNull org.bukkit.plugin.Plugin plugin,
                                   @NotNull
                                   @NotNull java.lang.Runnable task,
                                   long delay)

Specified by:

scheduleSyncDelayedTask in interface org.bukkit.scheduler.BukkitScheduler

scheduleSyncDelayedTask

public int scheduleSyncDelayedTask(@NotNull
                                   @NotNull org.bukkit.plugin.Plugin plugin,
                                   @NotNull
                                   @NotNull org.bukkit.scheduler.BukkitRunnable task,
                                   long delay)

Specified by:

scheduleSyncDelayedTask in interface org.bukkit.scheduler.BukkitScheduler

scheduleSyncDelayedTask

public int scheduleSyncDelayedTask(@NotNull
                                   @NotNull org.bukkit.plugin.Plugin plugin,
                                   @NotNull
                                   @NotNull java.lang.Runnable task)

Specified by:

scheduleSyncDelayedTask in interface org.bukkit.scheduler.BukkitScheduler

scheduleSyncDelayedTask

public int scheduleSyncDelayedTask(@NotNull
                                   @NotNull org.bukkit.plugin.Plugin plugin,
                                   @NotNull
                                   @NotNull org.bukkit.scheduler.BukkitRunnable task)

Specified by:

scheduleSyncDelayedTask in interface org.bukkit.scheduler.BukkitScheduler

scheduleSyncRepeatingTask

public int scheduleSyncRepeatingTask(@NotNull
                                     @NotNull org.bukkit.plugin.Plugin plugin,
                                     @NotNull
                                     @NotNull java.lang.Runnable task,
                                     long delay,
                                     long period)

Specified by:

scheduleSyncRepeatingTask in interface org.bukkit.scheduler.BukkitScheduler

scheduleSyncRepeatingTask

public int scheduleSyncRepeatingTask(@NotNull
                                     @NotNull org.bukkit.plugin.Plugin plugin,
                                     @NotNull
                                     @NotNull org.bukkit.scheduler.BukkitRunnable task,
                                     long delay,
                                     long period)

Specified by:

scheduleSyncRepeatingTask in interface org.bukkit.scheduler.BukkitScheduler

scheduleAsyncDelayedTask

public int scheduleAsyncDelayedTask(@NotNull
                                    @NotNull org.bukkit.plugin.Plugin plugin,
                                    @NotNull
                                    @NotNull java.lang.Runnable task,
                                    long delay)

Specified by:

scheduleAsyncDelayedTask in interface org.bukkit.scheduler.BukkitScheduler

scheduleAsyncDelayedTask

public int scheduleAsyncDelayedTask(@NotNull
                                    @NotNull org.bukkit.plugin.Plugin plugin,
                                    @NotNull
                                    @NotNull java.lang.Runnable task)

Specified by:

scheduleAsyncDelayedTask in interface org.bukkit.scheduler.BukkitScheduler

scheduleAsyncRepeatingTask

public int scheduleAsyncRepeatingTask(@NotNull
                                      @NotNull org.bukkit.plugin.Plugin plugin,
                                      @NotNull
                                      @NotNull java.lang.Runnable task,
                                      long delay,
                                      long period)

Specified by:

scheduleAsyncRepeatingTask in interface org.bukkit.scheduler.BukkitScheduler

callSyncMethod

@NotNull
public <T> @NotNull java.util.concurrent.Future<T> callSyncMethod(@NotNull
                                                                           @NotNull org.bukkit.plugin.Plugin plugin,
                                                                           @NotNull
                                                                           @NotNull java.util.concurrent.Callable<T> task)

Specified by:

callSyncMethod in interface org.bukkit.scheduler.BukkitScheduler

cancelTask

public void cancelTask(int taskId)

Specified by:

cancelTask in interface org.bukkit.scheduler.BukkitScheduler

cancelTasks

public void cancelTasks(@NotNull
                        @NotNull org.bukkit.plugin.Plugin plugin)

Specified by:

cancelTasks in interface org.bukkit.scheduler.BukkitScheduler

isCurrentlyRunning

public boolean isCurrentlyRunning(int taskId)

Specified by:

isCurrentlyRunning in interface org.bukkit.scheduler.BukkitScheduler

isQueued

public boolean isQueued(int taskId)

Specified by:

isQueued in interface org.bukkit.scheduler.BukkitScheduler

getActiveWorkers

@NotNull
public @NotNull java.util.List<org.bukkit.scheduler.BukkitWorker> getActiveWorkers()

Specified by:

getActiveWorkers in interface org.bukkit.scheduler.BukkitScheduler

getPendingTasks

@NotNull
public @NotNull java.util.List<org.bukkit.scheduler.BukkitTask> getPendingTasks()

Specified by:

getPendingTasks in interface org.bukkit.scheduler.BukkitScheduler

runTaskAsynchronously

@NotNull
public @NotNull org.bukkit.scheduler.BukkitTask runTaskAsynchronously(@NotNull
                                                                               @NotNull org.bukkit.plugin.Plugin plugin,
                                                                               @NotNull
                                                                               @NotNull java.lang.Runnable task)

Specified by:

runTaskAsynchronously in interface org.bukkit.scheduler.BukkitScheduler

runTaskAsynchronously

@NotNull
public @NotNull org.bukkit.scheduler.BukkitTask runTaskAsynchronously(@NotNull
                                                                               @NotNull org.bukkit.plugin.Plugin plugin,
                                                                               @NotNull
                                                                               @NotNull org.bukkit.scheduler.BukkitRunnable task)

Specified by:

runTaskAsynchronously in interface org.bukkit.scheduler.BukkitScheduler

runTaskLater

@NotNull
public @NotNull org.bukkit.scheduler.BukkitTask runTaskLater(@NotNull
                                                                      @NotNull org.bukkit.plugin.Plugin plugin,
                                                                      @NotNull
                                                                      @NotNull org.bukkit.scheduler.BukkitRunnable task,
                                                                      long delay)

Specified by:

runTaskLater in interface org.bukkit.scheduler.BukkitScheduler

runTaskLaterAsynchronously

@NotNull
public @NotNull org.bukkit.scheduler.BukkitTask runTaskLaterAsynchronously(@NotNull
                                                                                    @NotNull org.bukkit.plugin.Plugin plugin,
                                                                                    @NotNull
                                                                                    @NotNull java.lang.Runnable task,
                                                                                    long delay)

Specified by:

runTaskLaterAsynchronously in interface org.bukkit.scheduler.BukkitScheduler

runTaskLaterAsynchronously

@NotNull
public @NotNull org.bukkit.scheduler.BukkitTask runTaskLaterAsynchronously(@NotNull
                                                                                    @NotNull org.bukkit.plugin.Plugin plugin,
                                                                                    @NotNull
                                                                                    @NotNull org.bukkit.scheduler.BukkitRunnable task,
                                                                                    long delay)

Specified by:

runTaskLaterAsynchronously in interface org.bukkit.scheduler.BukkitScheduler

runTaskTimerAsynchronously

@NotNull
public @NotNull org.bukkit.scheduler.BukkitTask runTaskTimerAsynchronously(@NotNull
                                                                                    @NotNull org.bukkit.plugin.Plugin plugin,
                                                                                    @NotNull
                                                                                    @NotNull java.lang.Runnable task,
                                                                                    long delay,
                                                                                    long period)

Specified by:

runTaskTimerAsynchronously in interface org.bukkit.scheduler.BukkitScheduler

runTaskTimerAsynchronously

@NotNull
public @NotNull org.bukkit.scheduler.BukkitTask runTaskTimerAsynchronously(@NotNull
                                                                                    @NotNull org.bukkit.plugin.Plugin plugin,
                                                                                    @NotNull
                                                                                    @NotNull org.bukkit.scheduler.BukkitRunnable task,
                                                                                    long delay,
                                                                                    long period)

Specified by:

runTaskTimerAsynchronously in interface org.bukkit.scheduler.BukkitScheduler

runTask

public void runTask(@NotNull
                    @NotNull org.bukkit.plugin.Plugin plugin,
                    @NotNull
                    @NotNull java.util.function.Consumer<org.bukkit.scheduler.BukkitTask> task)

Specified by:

runTask in interface org.bukkit.scheduler.BukkitScheduler

runTaskAsynchronously

public void runTaskAsynchronously(@NotNull
                                  @NotNull org.bukkit.plugin.Plugin plugin,
                                  @NotNull
                                  @NotNull java.util.function.Consumer<org.bukkit.scheduler.BukkitTask> task)

Specified by:

runTaskAsynchronously in interface org.bukkit.scheduler.BukkitScheduler

runTaskLater

public void runTaskLater(@NotNull
                         @NotNull org.bukkit.plugin.Plugin plugin,
                         @NotNull
                         @NotNull java.util.function.Consumer<org.bukkit.scheduler.BukkitTask> task,
                         long delay)

Specified by:

runTaskLater in interface org.bukkit.scheduler.BukkitScheduler

runTaskLaterAsynchronously

public void runTaskLaterAsynchronously(@NotNull
                                       @NotNull org.bukkit.plugin.Plugin plugin,
                                       @NotNull
                                       @NotNull java.util.function.Consumer<org.bukkit.scheduler.BukkitTask> task,
                                       long delay)

Specified by:

runTaskLaterAsynchronously in interface org.bukkit.scheduler.BukkitScheduler

runTaskTimer

public void runTaskTimer(@NotNull
                         @NotNull org.bukkit.plugin.Plugin plugin,
                         @NotNull
                         @NotNull java.util.function.Consumer<org.bukkit.scheduler.BukkitTask> task,
                         long delay,
                         long period)

Specified by:

runTaskTimer in interface org.bukkit.scheduler.BukkitScheduler

runTaskTimerAsynchronously

public void runTaskTimerAsynchronously(@NotNull
                                       @NotNull org.bukkit.plugin.Plugin plugin,
                                       @NotNull
                                       @NotNull java.util.function.Consumer<org.bukkit.scheduler.BukkitTask> task,
                                       long delay,
                                       long period)

Specified by:

runTaskTimerAsynchronously in interface org.bukkit.scheduler.BukkitScheduler

getActiveRunningCount

protected int getActiveRunningCount()