Package be.seeseemelk.mockbukkit.scheduler

Class BukkitSchedulerMock

java.lang.Object

be.seeseemelk.mockbukkit.scheduler.BukkitSchedulerMock

All Implemented Interfaces:

BukkitScheduler

public class BukkitSchedulerMock
extends Object
implements BukkitScheduler

Mock implementation of a BukkitScheduler.

Constructor Summary

Constructors

Constructor	Description
BukkitSchedulerMock()

Method Summary

Modifier and Type	Method	Description
void	assertNoOverdueTasks()	Asserts that there were no overdue tasks from saveOverdueTasks().
<T> @NotNull Future<T>	callSyncMethod(@NotNull Plugin plugin, @NotNull Callable<T> task)
void	cancelTask(int taskId)
void	cancelTasks(@NotNull Plugin plugin)
@NotNull Future<?>	executeAsyncEvent(@NotNull Event event)	Executes an asynchronous event.
<T extends Event> @NotNull Future<?>	executeAsyncEvent(T event, @Nullable Consumer<T> func)	Executes an asynchronous event.
protected int	getActiveRunningCount()	Gets the amount of thread currently executing asynchronous tasks.
@NotNull List<BukkitWorker>	getActiveWorkers()
long	getCurrentTick()	Get the current tick of the server.
@NotNull Executor	getMainThreadExecutor(@NotNull Plugin plugin)
int	getNumberOfQueuedAsyncTasks()	Gets the number of async tasks which are awaiting execution.
@NotNull @UnmodifiableView List<BukkitWorker>	getOverdueTasks()
@NotNull List<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 BukkitTask	runTask(@NotNull Plugin plugin, @NotNull Runnable task)
void	runTask(@NotNull Plugin plugin, @NotNull Consumer<? super BukkitTask> task)
@NotNull BukkitTask	runTask(@NotNull Plugin plugin, @NotNull BukkitRunnable task)	Deprecated.
@NotNull BukkitTask	runTaskAsynchronously(@NotNull Plugin plugin, @NotNull Runnable task)
void	runTaskAsynchronously(@NotNull Plugin plugin, @NotNull Consumer<? super BukkitTask> task)
@NotNull BukkitTask	runTaskAsynchronously(@NotNull Plugin plugin, @NotNull BukkitRunnable task)
@NotNull BukkitTask	runTaskLater(@NotNull Plugin plugin, @NotNull Runnable task, long delay)
void	runTaskLater(@NotNull Plugin plugin, @NotNull Consumer<? super BukkitTask> task, long delay)
@NotNull BukkitTask	runTaskLater(@NotNull Plugin plugin, @NotNull BukkitRunnable task, long delay)
@NotNull BukkitTask	runTaskLaterAsynchronously(@NotNull Plugin plugin, @NotNull Runnable task, long delay)
void	runTaskLaterAsynchronously(@NotNull Plugin plugin, @NotNull Consumer<? super BukkitTask> task, long delay)
@NotNull BukkitTask	runTaskLaterAsynchronously(@NotNull Plugin plugin, @NotNull BukkitRunnable task, long delay)
@NotNull BukkitTask	runTaskTimer(@NotNull Plugin plugin, @NotNull Runnable task, long delay, long period)
void	runTaskTimer(@NotNull Plugin plugin, @NotNull Consumer<? super BukkitTask> task, long delay, long period)
@NotNull BukkitTask	runTaskTimer(@NotNull Plugin plugin, @NotNull BukkitRunnable task, long delay, long period)	Deprecated.
@NotNull BukkitTask	runTaskTimerAsynchronously(@NotNull Plugin plugin, @NotNull Runnable task, long delay, long period)
void	runTaskTimerAsynchronously(@NotNull Plugin plugin, @NotNull Consumer<? super BukkitTask> task, long delay, long period)
@NotNull BukkitTask	runTaskTimerAsynchronously(@NotNull Plugin plugin, @NotNull BukkitRunnable task, long delay, long period)
void	saveOverdueTasks()	Adds any active workers to the overdue tasks list.
int	scheduleAsyncDelayedTask(@NotNull Plugin plugin, @NotNull Runnable task)	Deprecated.
int	scheduleAsyncDelayedTask(@NotNull Plugin plugin, @NotNull Runnable task, long delay)	Deprecated.
int	scheduleAsyncRepeatingTask(@NotNull Plugin plugin, @NotNull Runnable task, long delay, long period)	Deprecated.
int	scheduleSyncDelayedTask(@NotNull Plugin plugin, @NotNull Runnable task)
int	scheduleSyncDelayedTask(@NotNull Plugin plugin, @NotNull Runnable task, long delay)
int	scheduleSyncDelayedTask(@NotNull Plugin plugin, @NotNull BukkitRunnable task)	Deprecated.
int	scheduleSyncDelayedTask(@NotNull Plugin plugin, @NotNull BukkitRunnable task, long delay)	Deprecated.
int	scheduleSyncRepeatingTask(@NotNull Plugin plugin, @NotNull Runnable task, long delay, long period)
int	scheduleSyncRepeatingTask(@NotNull Plugin plugin, @NotNull BukkitRunnable task, long delay, long period)	Deprecated.
void	setShutdownTimeout(long timeout)	Sets the maximum time to wait for async tasks to finish before terminating them.
void	shutdown()	Shuts the scheduler down.
void	waitAsyncEventsFinished()	Blocks until all asynchronous event invocations are finished.
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 Details

BukkitSchedulerMock

public BukkitSchedulerMock()

Method Details

setShutdownTimeout

public void setShutdownTimeout(long timeout)

Sets the maximum time to wait for async tasks to finish before terminating them.

Parameters:

timeout - The timeout in milliseconds.

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 Future<?> executeAsyncEvent(@NotNull
 @NotNull Event event)

Executes an asynchronous event.

Parameters:

event - The event to execute.

Returns:

A future representing the task.

executeAsyncEvent

@NotNull
public <T extends Event> @NotNull Future<?> executeAsyncEvent(@NotNull
 T event,
 @Nullable
 @Nullable Consumer<T> func)

Executes an asynchronous event.

Type Parameters:

T - The event type.

Parameters:

event - The event to execute.

func - A consumer to call after the event is invoked.

Returns:

A future representing the task.

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. Note that this will not wait for async events to finish.

waitAsyncEventsFinished

public void waitAsyncEventsFinished()

Blocks until all asynchronous event invocations are finished.

runTask

@NotNull
public @NotNull BukkitTask runTask(@NotNull
 @NotNull Plugin plugin,
 @NotNull
 @NotNull Runnable task)

Specified by:

runTask in interface BukkitScheduler

runTask

@Deprecated(since="1.7.10")
@NotNull
public @NotNull BukkitTask runTask(@NotNull
 @NotNull Plugin plugin,
 @NotNull
 @NotNull BukkitRunnable task)

Deprecated.

Specified by:

runTask in interface BukkitScheduler

runTaskLater

@NotNull
public @NotNull BukkitTask runTaskLater(@NotNull
 @NotNull Plugin plugin,
 @NotNull
 @NotNull Runnable task,
 long delay)

Specified by:

runTaskLater in interface BukkitScheduler

runTaskTimer

@NotNull
public @NotNull BukkitTask runTaskTimer(@NotNull
 @NotNull Plugin plugin,
 @NotNull
 @NotNull Runnable task,
 long delay,
 long period)

Specified by:

runTaskTimer in interface BukkitScheduler

runTaskTimer

@Deprecated(since="1.7.10")
@NotNull
public @NotNull BukkitTask runTaskTimer(@NotNull
 @NotNull Plugin plugin,
 @NotNull
 @NotNull BukkitRunnable task,
 long delay,
 long period)

Deprecated.

Specified by:

runTaskTimer in interface BukkitScheduler

scheduleSyncDelayedTask

public int scheduleSyncDelayedTask(@NotNull
 @NotNull Plugin plugin,
 @NotNull
 @NotNull Runnable task,
 long delay)

Specified by:

scheduleSyncDelayedTask in interface BukkitScheduler

scheduleSyncDelayedTask

@Deprecated(since="1.7.10")
public int scheduleSyncDelayedTask(@NotNull
 @NotNull Plugin plugin,
 @NotNull
 @NotNull BukkitRunnable task,
 long delay)

Deprecated.

Specified by:

scheduleSyncDelayedTask in interface BukkitScheduler

scheduleSyncDelayedTask

public int scheduleSyncDelayedTask(@NotNull
 @NotNull Plugin plugin,
 @NotNull
 @NotNull Runnable task)

Specified by:

scheduleSyncDelayedTask in interface BukkitScheduler

scheduleSyncDelayedTask

@Deprecated(since="1.7.10")
public int scheduleSyncDelayedTask(@NotNull
 @NotNull Plugin plugin,
 @NotNull
 @NotNull BukkitRunnable task)

Deprecated.

Specified by:

scheduleSyncDelayedTask in interface BukkitScheduler

scheduleSyncRepeatingTask

public int scheduleSyncRepeatingTask(@NotNull
 @NotNull Plugin plugin,
 @NotNull
 @NotNull Runnable task,
 long delay,
 long period)

Specified by:

scheduleSyncRepeatingTask in interface BukkitScheduler

scheduleSyncRepeatingTask

@Deprecated(since="1.7.10")
public int scheduleSyncRepeatingTask(@NotNull
 @NotNull Plugin plugin,
 @NotNull
 @NotNull BukkitRunnable task,
 long delay,
 long period)

Deprecated.

Specified by:

scheduleSyncRepeatingTask in interface BukkitScheduler

scheduleAsyncDelayedTask

@Deprecated(since="1.5")
public int scheduleAsyncDelayedTask(@NotNull
 @NotNull Plugin plugin,
 @NotNull
 @NotNull Runnable task,
 long delay)

Deprecated.

Specified by:

scheduleAsyncDelayedTask in interface BukkitScheduler

scheduleAsyncDelayedTask

@Deprecated(since="1.5")
public int scheduleAsyncDelayedTask(@NotNull
 @NotNull Plugin plugin,
 @NotNull
 @NotNull Runnable task)

Deprecated.

Specified by:

scheduleAsyncDelayedTask in interface BukkitScheduler

scheduleAsyncRepeatingTask

@Deprecated(since="1.5")
public int scheduleAsyncRepeatingTask(@NotNull
 @NotNull Plugin plugin,
 @NotNull
 @NotNull Runnable task,
 long delay,
 long period)

Deprecated.

Specified by:

scheduleAsyncRepeatingTask in interface BukkitScheduler

callSyncMethod

@NotNull
public <T> @NotNull Future<T> callSyncMethod(@NotNull
 @NotNull Plugin plugin,
 @NotNull
 @NotNull Callable<T> task)

Specified by:

callSyncMethod in interface BukkitScheduler

cancelTask

public void cancelTask(int taskId)

Specified by:

cancelTask in interface BukkitScheduler

cancelTasks

public void cancelTasks(@NotNull
 @NotNull Plugin plugin)

Specified by:

cancelTasks in interface BukkitScheduler

isCurrentlyRunning

public boolean isCurrentlyRunning(int taskId)

Specified by:

isCurrentlyRunning in interface BukkitScheduler

isQueued

public boolean isQueued(int taskId)

Specified by:

isQueued in interface BukkitScheduler

getActiveWorkers

@NotNull
public @NotNull List<BukkitWorker> getActiveWorkers()

Specified by:

getActiveWorkers in interface BukkitScheduler

getPendingTasks

@NotNull
public @NotNull List<BukkitTask> getPendingTasks()

Specified by:

getPendingTasks in interface BukkitScheduler

runTaskAsynchronously

@NotNull
public @NotNull BukkitTask runTaskAsynchronously(@NotNull
 @NotNull Plugin plugin,
 @NotNull
 @NotNull Runnable task)

Specified by:

runTaskAsynchronously in interface BukkitScheduler

runTaskAsynchronously

@NotNull
public @NotNull BukkitTask runTaskAsynchronously(@NotNull
 @NotNull Plugin plugin,
 @NotNull
 @NotNull BukkitRunnable task)

Specified by:

runTaskAsynchronously in interface BukkitScheduler

runTaskLater

@NotNull
public @NotNull BukkitTask runTaskLater(@NotNull
 @NotNull Plugin plugin,
 @NotNull
 @NotNull BukkitRunnable task,
 long delay)

Specified by:

runTaskLater in interface BukkitScheduler

runTaskLaterAsynchronously

@NotNull
public @NotNull BukkitTask runTaskLaterAsynchronously(@NotNull
 @NotNull Plugin plugin,
 @NotNull
 @NotNull Runnable task,
 long delay)

Specified by:

runTaskLaterAsynchronously in interface BukkitScheduler

runTaskLaterAsynchronously

@NotNull
public @NotNull BukkitTask runTaskLaterAsynchronously(@NotNull
 @NotNull Plugin plugin,
 @NotNull
 @NotNull BukkitRunnable task,
 long delay)

Specified by:

runTaskLaterAsynchronously in interface BukkitScheduler

runTaskTimerAsynchronously

@NotNull
public @NotNull BukkitTask runTaskTimerAsynchronously(@NotNull
 @NotNull Plugin plugin,
 @NotNull
 @NotNull Runnable task,
 long delay,
 long period)

Specified by:

runTaskTimerAsynchronously in interface BukkitScheduler

runTaskTimerAsynchronously

@NotNull
public @NotNull BukkitTask runTaskTimerAsynchronously(@NotNull
 @NotNull Plugin plugin,
 @NotNull
 @NotNull BukkitRunnable task,
 long delay,
 long period)

Specified by:

runTaskTimerAsynchronously in interface BukkitScheduler

runTask

public void runTask(@NotNull
 @NotNull Plugin plugin,
 @NotNull
 @NotNull Consumer<? super BukkitTask> task)

Specified by:

runTask in interface BukkitScheduler

runTaskAsynchronously

public void runTaskAsynchronously(@NotNull
 @NotNull Plugin plugin,
 @NotNull
 @NotNull Consumer<? super BukkitTask> task)

Specified by:

runTaskAsynchronously in interface BukkitScheduler

runTaskLater

public void runTaskLater(@NotNull
 @NotNull Plugin plugin,
 @NotNull
 @NotNull Consumer<? super BukkitTask> task,
 long delay)

Specified by:

runTaskLater in interface BukkitScheduler

runTaskLaterAsynchronously

public void runTaskLaterAsynchronously(@NotNull
 @NotNull Plugin plugin,
 @NotNull
 @NotNull Consumer<? super BukkitTask> task,
 long delay)

Specified by:

runTaskLaterAsynchronously in interface BukkitScheduler

runTaskTimer

public void runTaskTimer(@NotNull
 @NotNull Plugin plugin,
 @NotNull
 @NotNull Consumer<? super BukkitTask> task,
 long delay,
 long period)

Specified by:

runTaskTimer in interface BukkitScheduler

runTaskTimerAsynchronously

public void runTaskTimerAsynchronously(@NotNull
 @NotNull Plugin plugin,
 @NotNull
 @NotNull Consumer<? super BukkitTask> task,
 long delay,
 long period)

Specified by:

runTaskTimerAsynchronously in interface BukkitScheduler

getMainThreadExecutor

@NotNull
public @NotNull Executor getMainThreadExecutor(@NotNull
 @NotNull Plugin plugin)

Specified by:

getMainThreadExecutor in interface BukkitScheduler

getActiveRunningCount

protected int getActiveRunningCount()

Gets the amount of thread currently executing asynchronous tasks.

Returns:

The amount of active task threads.

saveOverdueTasks

public void saveOverdueTasks()

Adds any active workers to the overdue tasks list.

getOverdueTasks

@NotNull
public @NotNull @UnmodifiableView List<BukkitWorker> getOverdueTasks()

Returns:

A list of overdue tasks saved by saveOverdueTasks().

assertNoOverdueTasks

public void assertNoOverdueTasks()

Asserts that there were no overdue tasks from saveOverdueTasks().