Azimkin/Bukkit
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

add isQueued() to allow plugins to know a task is still in the queue.

Browse Source 
Currently, there is no way to know if a task is still being handled by
the scheduler. This method, along with isCurrentlyRunning() allows a
plugin author to determine if a task is waiting to be executed, being
executed, or neither.
This commit is contained in:
Andrew Ardill 2011-02-21 12:33:40 +11:00
parent b2847fdf8c
commit b93f044983
1 changed files with 14 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
src/main/java/org/bukkit/scheduler/BukkitScheduler.java
View File

@ -105,17 +105,28 @@ public interface BukkitScheduler {
public void cancelAllTasks(); public void cancelAllTasks();
/** /**
* Is the task currently running. * Check if the task currently running.
* *
* A repeating task might not be running currently, but will be running in the future. * A repeating task might not be running currently, but will be running in the future.
* A task that has finished, and does not repeat, will not be running ever again. * A task that has finished, and does not repeat, will not be running ever again.
* *
* Explicitly, a task is running if there exists a thread for it, and that thread is alive. * Explicitly, a task is running if there exists a thread for it, and that thread is alive.
* *
* @param taskId the task to check. * @param taskId The task to check.
* *
* @return if the task is currently running. * @return If the task is currently running.
*/ */
public boolean isCurrentlyRunning(int taskId); public boolean isCurrentlyRunning(int taskId);
/**
* Check if the task queued to be run later.
*
* If a repeating task is currently running, it might not be queued now but could be in the future.
* A task that is not queued, and not running, will not be queued again.
*
* @param taskId The task to check.
*
* @return If the task is queued to be run.
*/
public boolean isQueued(int taskId);
} }