2012-10-17 08:16:18 +02:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
< html lang = "en" >
< head >
2012-12-04 01:02:05 +01:00
<!-- Generated by javadoc (version 1.7.0_07) on Tue Dec 04 01:00:50 CET 2012 -->
2012-10-17 08:16:18 +02:00
< title > DelayedSingleTask< / title >
2012-12-04 00:58:16 +01:00
< meta name = "date" content = "2012-12-04" >
2012-10-17 08:16:18 +02:00
< link rel = "stylesheet" type = "text/css" href = "../../../../stylesheet.css" title = "Style" >
< / head >
< body >
< script type = "text/javascript" > < ! - -
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="DelayedSingleTask";
}
//-->
< / script >
< noscript >
< div > JavaScript is disabled on your browser.< / div >
< / noscript >
<!-- ========= START OF TOP NAVBAR ======= -->
< div class = "topNav" > < a name = "navbar_top" >
<!-- -->
< / a > < a href = "#skip-navbar_top" title = "Skip navigation links" > < / a > < a name = "navbar_top_firstrow" >
<!-- -->
< / a >
< ul class = "navList" title = "Navigation" >
< li > < a href = "../../../../overview-summary.html" > Overview< / a > < / li >
< li > < a href = "package-summary.html" > Package< / a > < / li >
< li class = "navBarCell1Rev" > Class< / li >
< li > < a href = "class-use/DelayedSingleTask.html" > Use< / a > < / li >
< li > < a href = "package-tree.html" > Tree< / a > < / li >
< li > < a href = "../../../../deprecated-list.html" > Deprecated< / a > < / li >
< li > < a href = "../../../../index-files/index-1.html" > Index< / a > < / li >
< li > < a href = "../../../../help-doc.html" > Help< / a > < / li >
< / ul >
< / div >
< div class = "subNav" >
< ul class = "navList" >
< li > < a href = "../../../../com/comphenix/protocol/injector/BukkitUnwrapper.html" title = "class in com.comphenix.protocol.injector" > < span class = "strong" > Prev Class< / span > < / a > < / li >
< li > < a href = "../../../../com/comphenix/protocol/injector/GamePhase.html" title = "enum in com.comphenix.protocol.injector" > < span class = "strong" > Next Class< / span > < / a > < / li >
< / ul >
< ul class = "navList" >
< li > < a href = "../../../../index.html?com/comphenix/protocol/injector/DelayedSingleTask.html" target = "_top" > Frames< / a > < / li >
< li > < a href = "DelayedSingleTask.html" target = "_top" > No Frames< / a > < / li >
< / ul >
< ul class = "navList" id = "allclasses_navbar_top" >
< li > < a href = "../../../../allclasses-noframe.html" > All Classes< / a > < / li >
< / ul >
< div >
< script type = "text/javascript" > < ! - -
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
< / script >
< / div >
< div >
< ul class = "subNavList" >
< li > Summary: < / li >
< li > Nested | < / li >
< li > < a href = "#field_summary" > Field< / a > | < / li >
< li > < a href = "#constructor_summary" > Constr< / a > | < / li >
< li > < a href = "#method_summary" > Method< / a > < / li >
< / ul >
< ul class = "subNavList" >
< li > Detail: < / li >
< li > < a href = "#field_detail" > Field< / a > | < / li >
< li > < a href = "#constructor_detail" > Constr< / a > | < / li >
< li > < a href = "#method_detail" > Method< / a > < / li >
< / ul >
< / div >
< a name = "skip-navbar_top" >
<!-- -->
< / a > < / div >
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
< div class = "header" >
< div class = "subTitle" > com.comphenix.protocol.injector< / div >
< h2 title = "Class DelayedSingleTask" class = "title" > Class DelayedSingleTask< / h2 >
< / div >
< div class = "contentContainer" >
< ul class = "inheritance" >
< li > java.lang.Object< / li >
< li >
< ul class = "inheritance" >
< li > com.comphenix.protocol.injector.DelayedSingleTask< / li >
< / ul >
< / li >
< / ul >
< div class = "description" >
< ul class = "blockList" >
< li class = "blockList" >
< hr >
< br >
< pre > public class < span class = "strong" > DelayedSingleTask< / span >
extends java.lang.Object< / pre >
< div class = "block" > Represents a single delayed task.< / div >
< dl > < dt > < span class = "strong" > Author:< / span > < / dt >
< dd > Kristian< / dd > < / dl >
< / li >
< / ul >
< / div >
< div class = "summary" >
< ul class = "blockList" >
< li class = "blockList" >
<!-- =========== FIELD SUMMARY =========== -->
< ul class = "blockList" >
< li class = "blockList" > < a name = "field_summary" >
<!-- -->
< / a >
< h3 > Field Summary< / h3 >
< table class = "overviewSummary" border = "0" cellpadding = "3" cellspacing = "0" summary = "Field Summary table, listing fields, and an explanation" >
< caption > < span > Fields< / span > < span class = "tabEnd" > < / span > < / caption >
< tr >
< th class = "colFirst" scope = "col" > Modifier and Type< / th >
< th class = "colLast" scope = "col" > Field and Description< / th >
< / tr >
< tr class = "altColor" >
< td class = "colFirst" > < code > protected boolean< / code > < / td >
< td class = "colLast" > < code > < strong > < a href = "../../../../com/comphenix/protocol/injector/DelayedSingleTask.html#closed" > closed< / a > < / strong > < / code > < / td >
< / tr >
< tr class = "rowColor" >
< td class = "colFirst" > < code > protected org.bukkit.plugin.Plugin< / code > < / td >
< td class = "colLast" > < code > < strong > < a href = "../../../../com/comphenix/protocol/injector/DelayedSingleTask.html#plugin" > plugin< / a > < / strong > < / code > < / td >
< / tr >
< tr class = "altColor" >
< td class = "colFirst" > < code > protected org.bukkit.scheduler.BukkitScheduler< / code > < / td >
< td class = "colLast" > < code > < strong > < a href = "../../../../com/comphenix/protocol/injector/DelayedSingleTask.html#scheduler" > scheduler< / a > < / strong > < / code > < / td >
< / tr >
< tr class = "rowColor" >
< td class = "colFirst" > < code > protected int< / code > < / td >
< td class = "colLast" > < code > < strong > < a href = "../../../../com/comphenix/protocol/injector/DelayedSingleTask.html#taskID" > taskID< / a > < / strong > < / code > < / td >
< / tr >
< / table >
< / li >
< / ul >
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
< ul class = "blockList" >
< li class = "blockList" > < a name = "constructor_summary" >
<!-- -->
< / a >
< h3 > Constructor Summary< / h3 >
< table class = "overviewSummary" border = "0" cellpadding = "3" cellspacing = "0" summary = "Constructor Summary table, listing constructors, and an explanation" >
< caption > < span > Constructors< / span > < span class = "tabEnd" > < / span > < / caption >
< tr >
< th class = "colOne" scope = "col" > Constructor and Description< / th >
< / tr >
< tr class = "altColor" >
< td class = "colOne" > < code > < strong > < a href = "../../../../com/comphenix/protocol/injector/DelayedSingleTask.html#DelayedSingleTask(org.bukkit.plugin.Plugin)" > DelayedSingleTask< / a > < / strong > (org.bukkit.plugin.Plugin plugin)< / code >
< div class = "block" > Create a single task scheduler.< / div >
< / td >
< / tr >
< tr class = "rowColor" >
< td class = "colOne" > < code > < strong > < a href = "../../../../com/comphenix/protocol/injector/DelayedSingleTask.html#DelayedSingleTask(org.bukkit.plugin.Plugin, org.bukkit.scheduler.BukkitScheduler)" > DelayedSingleTask< / a > < / strong > (org.bukkit.plugin.Plugin plugin,
org.bukkit.scheduler.BukkitScheduler scheduler)< / code >
< div class = "block" > Create a single task scheduler.< / div >
< / td >
< / tr >
< / table >
< / li >
< / ul >
<!-- ========== METHOD SUMMARY =========== -->
< ul class = "blockList" >
< li class = "blockList" > < a name = "method_summary" >
<!-- -->
< / a >
< h3 > Method Summary< / h3 >
< table class = "overviewSummary" border = "0" cellpadding = "3" cellspacing = "0" summary = "Method Summary table, listing methods, and an explanation" >
< caption > < span > Methods< / span > < span class = "tabEnd" > < / span > < / caption >
< tr >
< th class = "colFirst" scope = "col" > Modifier and Type< / th >
< th class = "colLast" scope = "col" > Method and Description< / th >
< / tr >
< tr class = "altColor" >
< td class = "colFirst" > < code > boolean< / code > < / td >
< td class = "colLast" > < code > < strong > < a href = "../../../../com/comphenix/protocol/injector/DelayedSingleTask.html#cancel()" > cancel< / a > < / strong > ()< / code >
< div class = "block" > Cancel a future task from being executed.< / div >
< / td >
< / tr >
< tr class = "rowColor" >
< td class = "colFirst" > < code > void< / code > < / td >
< td class = "colLast" > < code > < strong > < a href = "../../../../com/comphenix/protocol/injector/DelayedSingleTask.html#close()" > close< / a > < / strong > ()< / code >
< div class = "block" > Stop the current task and all future tasks scheduled by this instance.< / div >
< / td >
< / tr >
< tr class = "altColor" >
< td class = "colFirst" > < code > protected void< / code > < / td >
< td class = "colLast" > < code > < strong > < a href = "../../../../com/comphenix/protocol/injector/DelayedSingleTask.html#finalize()" > finalize< / a > < / strong > ()< / code > < / td >
< / tr >
< tr class = "rowColor" >
< td class = "colFirst" > < code > org.bukkit.plugin.Plugin< / code > < / td >
< td class = "colLast" > < code > < strong > < a href = "../../../../com/comphenix/protocol/injector/DelayedSingleTask.html#getPlugin()" > getPlugin< / a > < / strong > ()< / code >
< div class = "block" > Retrieve the plugin this task belongs to.< / div >
< / td >
< / tr >
< tr class = "altColor" >
< td class = "colFirst" > < code > int< / code > < / td >
< td class = "colLast" > < code > < strong > < a href = "../../../../com/comphenix/protocol/injector/DelayedSingleTask.html#getTaskID()" > getTaskID< / a > < / strong > ()< / code >
< div class = "block" > Retrieve the raw task ID.< / div >
< / td >
< / tr >
< tr class = "rowColor" >
< td class = "colFirst" > < code > boolean< / code > < / td >
< td class = "colLast" > < code > < strong > < a href = "../../../../com/comphenix/protocol/injector/DelayedSingleTask.html#isRunning()" > isRunning< / a > < / strong > ()< / code >
< div class = "block" > Whether or not a future task is scheduled to be executed.< / div >
< / td >
< / tr >
< tr class = "altColor" >
< td class = "colFirst" > < code > boolean< / code > < / td >
< td class = "colLast" > < code > < strong > < a href = "../../../../com/comphenix/protocol/injector/DelayedSingleTask.html#schedule(long, java.lang.Runnable)" > schedule< / a > < / strong > (long ticksDelay,
java.lang.Runnable task)< / code >
< div class = "block" > Schedule a single task for execution.< / div >
< / td >
< / tr >
< / table >
< ul class = "blockList" >
< li class = "blockList" > < a name = "methods_inherited_from_class_java.lang.Object" >
<!-- -->
< / a >
< h3 > Methods inherited from class java.lang.Object< / h3 >
< code > clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait< / code > < / li >
< / ul >
< / li >
< / ul >
< / li >
< / ul >
< / div >
< div class = "details" >
< ul class = "blockList" >
< li class = "blockList" >
<!-- ============ FIELD DETAIL =========== -->
< ul class = "blockList" >
< li class = "blockList" > < a name = "field_detail" >
<!-- -->
< / a >
< h3 > Field Detail< / h3 >
< a name = "taskID" >
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > taskID< / h4 >
< pre > protected int taskID< / pre >
< / li >
< / ul >
< a name = "plugin" >
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > plugin< / h4 >
< pre > protected org.bukkit.plugin.Plugin plugin< / pre >
< / li >
< / ul >
< a name = "scheduler" >
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > scheduler< / h4 >
< pre > protected org.bukkit.scheduler.BukkitScheduler scheduler< / pre >
< / li >
< / ul >
< a name = "closed" >
<!-- -->
< / a >
< ul class = "blockListLast" >
< li class = "blockList" >
< h4 > closed< / h4 >
< pre > protected boolean closed< / pre >
< / li >
< / ul >
< / li >
< / ul >
<!-- ========= CONSTRUCTOR DETAIL ======== -->
< ul class = "blockList" >
< li class = "blockList" > < a name = "constructor_detail" >
<!-- -->
< / a >
< h3 > Constructor Detail< / h3 >
< a name = "DelayedSingleTask(org.bukkit.plugin.Plugin)" >
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > DelayedSingleTask< / h4 >
< pre > public DelayedSingleTask(org.bukkit.plugin.Plugin plugin)< / pre >
< div class = "block" > Create a single task scheduler.< / div >
< dl > < dt > < span class = "strong" > Parameters:< / span > < / dt > < dd > < code > plugin< / code > - - owner plugin.< / dd > < / dl >
< / li >
< / ul >
< a name = "DelayedSingleTask(org.bukkit.plugin.Plugin, org.bukkit.scheduler.BukkitScheduler)" >
<!-- -->
< / a >
< ul class = "blockListLast" >
< li class = "blockList" >
< h4 > DelayedSingleTask< / h4 >
< pre > public DelayedSingleTask(org.bukkit.plugin.Plugin plugin,
org.bukkit.scheduler.BukkitScheduler scheduler)< / pre >
< div class = "block" > Create a single task scheduler.< / div >
< dl > < dt > < span class = "strong" > Parameters:< / span > < / dt > < dd > < code > plugin< / code > - - owner plugin.< / dd > < dd > < code > scheduler< / code > - - specialized scheduler.< / dd > < / dl >
< / li >
< / ul >
< / li >
< / ul >
<!-- ============ METHOD DETAIL ========== -->
< ul class = "blockList" >
< li class = "blockList" > < a name = "method_detail" >
<!-- -->
< / a >
< h3 > Method Detail< / h3 >
< a name = "schedule(long, java.lang.Runnable)" >
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > schedule< / h4 >
< pre > public boolean schedule(long ticksDelay,
java.lang.Runnable task)< / pre >
< div class = "block" > Schedule a single task for execution.
< p >
Any previously scheduled task will be automatically cancelled.
< p >
Note that a tick delay of zero will execute the task immediately.< / div >
< dl > < dt > < span class = "strong" > Parameters:< / span > < / dt > < dd > < code > ticksDelay< / code > - - number of ticks before the task is executed.< / dd > < dd > < code > task< / code > - - the task to schedule.< / dd >
< dt > < span class = "strong" > Returns:< / span > < / dt > < dd > TRUE if the task was successfully scheduled or executed, FALSE otherwise.< / dd > < / dl >
< / li >
< / ul >
< a name = "isRunning()" >
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > isRunning< / h4 >
< pre > public boolean isRunning()< / pre >
< div class = "block" > Whether or not a future task is scheduled to be executed.< / div >
< dl > < dt > < span class = "strong" > Returns:< / span > < / dt > < dd > TRUE if a current task has been scheduled for execution, FALSE otherwise.< / dd > < / dl >
< / li >
< / ul >
< a name = "cancel()" >
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > cancel< / h4 >
< pre > public boolean cancel()< / pre >
< div class = "block" > Cancel a future task from being executed.< / div >
< dl > < dt > < span class = "strong" > Returns:< / span > < / dt > < dd > TRUE if a task was cancelled, FALSE otherwise.< / dd > < / dl >
< / li >
< / ul >
< a name = "getTaskID()" >
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > getTaskID< / h4 >
< pre > public int getTaskID()< / pre >
< div class = "block" > Retrieve the raw task ID.< / div >
< dl > < dt > < span class = "strong" > Returns:< / span > < / dt > < dd > Raw task ID, or negative one if no task has been scheduled.< / dd > < / dl >
< / li >
< / ul >
< a name = "getPlugin()" >
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > getPlugin< / h4 >
< pre > public org.bukkit.plugin.Plugin getPlugin()< / pre >
< div class = "block" > Retrieve the plugin this task belongs to.< / div >
< dl > < dt > < span class = "strong" > Returns:< / span > < / dt > < dd > The plugin scheduling the current taks.< / dd > < / dl >
< / li >
< / ul >
< a name = "close()" >
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > close< / h4 >
< pre > public void close()< / pre >
< div class = "block" > Stop the current task and all future tasks scheduled by this instance.< / div >
< / li >
< / ul >
< a name = "finalize()" >
<!-- -->
< / a >
< ul class = "blockListLast" >
< li class = "blockList" >
< h4 > finalize< / h4 >
< pre > protected void finalize()
throws java.lang.Throwable< / pre >
< dl >
< dt > < strong > Overrides:< / strong > < / dt >
< dd > < code > finalize< / code > in class < code > java.lang.Object< / code > < / dd >
< dt > < span class = "strong" > Throws:< / span > < / dt >
< dd > < code > java.lang.Throwable< / code > < / dd > < / dl >
< / li >
< / ul >
< / li >
< / ul >
< / li >
< / ul >
< / div >
< / div >
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
< div class = "bottomNav" > < a name = "navbar_bottom" >
<!-- -->
< / a > < a href = "#skip-navbar_bottom" title = "Skip navigation links" > < / a > < a name = "navbar_bottom_firstrow" >
<!-- -->
< / a >
< ul class = "navList" title = "Navigation" >
< li > < a href = "../../../../overview-summary.html" > Overview< / a > < / li >
< li > < a href = "package-summary.html" > Package< / a > < / li >
< li class = "navBarCell1Rev" > Class< / li >
< li > < a href = "class-use/DelayedSingleTask.html" > Use< / a > < / li >
< li > < a href = "package-tree.html" > Tree< / a > < / li >
< li > < a href = "../../../../deprecated-list.html" > Deprecated< / a > < / li >
< li > < a href = "../../../../index-files/index-1.html" > Index< / a > < / li >
< li > < a href = "../../../../help-doc.html" > Help< / a > < / li >
< / ul >
< / div >
< div class = "subNav" >
< ul class = "navList" >
< li > < a href = "../../../../com/comphenix/protocol/injector/BukkitUnwrapper.html" title = "class in com.comphenix.protocol.injector" > < span class = "strong" > Prev Class< / span > < / a > < / li >
< li > < a href = "../../../../com/comphenix/protocol/injector/GamePhase.html" title = "enum in com.comphenix.protocol.injector" > < span class = "strong" > Next Class< / span > < / a > < / li >
< / ul >
< ul class = "navList" >
< li > < a href = "../../../../index.html?com/comphenix/protocol/injector/DelayedSingleTask.html" target = "_top" > Frames< / a > < / li >
< li > < a href = "DelayedSingleTask.html" target = "_top" > No Frames< / a > < / li >
< / ul >
< ul class = "navList" id = "allclasses_navbar_bottom" >
< li > < a href = "../../../../allclasses-noframe.html" > All Classes< / a > < / li >
< / ul >
< div >
< script type = "text/javascript" > < ! - -
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
< / script >
< / div >
< div >
< ul class = "subNavList" >
< li > Summary: < / li >
< li > Nested | < / li >
< li > < a href = "#field_summary" > Field< / a > | < / li >
< li > < a href = "#constructor_summary" > Constr< / a > | < / li >
< li > < a href = "#method_summary" > Method< / a > < / li >
< / ul >
< ul class = "subNavList" >
< li > Detail: < / li >
< li > < a href = "#field_detail" > Field< / a > | < / li >
< li > < a href = "#constructor_detail" > Constr< / a > | < / li >
< li > < a href = "#method_detail" > Method< / a > < / li >
< / ul >
< / div >
< a name = "skip-navbar_bottom" >
<!-- -->
< / a > < / div >
<!-- ======== END OF BOTTOM NAVBAR ======= -->
< / body >
< / html >
