2012-10-17 08:07:20 +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 >
2013-03-05 17:07:09 +01:00
<!-- Generated by javadoc (version 1.7.0_13) on Tue Mar 05 17:05:45 CET 2013 -->
2012-10-17 08:07:20 +02:00
< title > AsyncRunnable< / title >
2013-03-05 17:07:09 +01:00
< meta name = "date" content = "2013-03-05" >
2012-10-17 08:07:20 +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="AsyncRunnable";
}
//-->
< / 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/AsyncRunnable.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/async/AsyncMarker.html" title = "class in com.comphenix.protocol.async" > < span class = "strong" > Prev Class< / span > < / a > < / li >
< li > Next Class< / li >
< / ul >
< ul class = "navList" >
< li > < a href = "../../../../index.html?com/comphenix/protocol/async/AsyncRunnable.html" target = "_top" > Frames< / a > < / li >
< li > < a href = "AsyncRunnable.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 > Field | < / li >
< li > Constr | < / li >
< li > < a href = "#method_summary" > Method< / a > < / li >
< / ul >
< ul class = "subNavList" >
< li > Detail: < / li >
< li > Field | < / li >
< li > Constr | < / 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.async< / div >
< h2 title = "Interface AsyncRunnable" class = "title" > Interface AsyncRunnable< / h2 >
< / div >
< div class = "contentContainer" >
< div class = "description" >
< ul class = "blockList" >
< li class = "blockList" >
< dl >
< dt > All Superinterfaces:< / dt >
< dd > java.lang.Runnable< / dd >
< / dl >
< hr >
< br >
< pre > public interface < span class = "strong" > AsyncRunnable< / span >
extends java.lang.Runnable< / pre >
< div class = "block" > A runnable representing a asynchronous event listener.< / 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" >
<!-- ========== 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 > int< / code > < / td >
< td class = "colLast" > < code > < strong > < a href = "../../../../com/comphenix/protocol/async/AsyncRunnable.html#getID()" > getID< / a > < / strong > ()< / code >
< div class = "block" > Retrieve a unique worker ID.< / div >
< / td >
< / tr >
< tr class = "rowColor" >
< td class = "colFirst" > < code > boolean< / code > < / td >
< td class = "colLast" > < code > < strong > < a href = "../../../../com/comphenix/protocol/async/AsyncRunnable.html#isFinished()" > isFinished< / a > < / strong > ()< / code >
< div class = "block" > Determine if this runnable has already run its course.< / div >
< / td >
< / tr >
< tr class = "altColor" >
< td class = "colFirst" > < code > boolean< / code > < / td >
< td class = "colLast" > < code > < strong > < a href = "../../../../com/comphenix/protocol/async/AsyncRunnable.html#isRunning()" > isRunning< / a > < / strong > ()< / code >
< div class = "block" > Determine if we're running or not.< / div >
< / td >
< / tr >
< tr class = "rowColor" >
< td class = "colFirst" > < code > boolean< / code > < / td >
< td class = "colLast" > < code > < strong > < a href = "../../../../com/comphenix/protocol/async/AsyncRunnable.html#stop()" > stop< / a > < / strong > ()< / code >
< div class = "block" > Stop the given runnable.< / div >
< / td >
< / tr >
< / table >
< ul class = "blockList" >
< li class = "blockList" > < a name = "methods_inherited_from_class_java.lang.Runnable" >
<!-- -->
< / a >
< h3 > Methods inherited from interface java.lang.Runnable< / h3 >
< code > run< / code > < / li >
< / ul >
< / li >
< / ul >
< / li >
< / ul >
< / div >
< div class = "details" >
< ul class = "blockList" >
< li class = "blockList" >
<!-- ============ METHOD DETAIL ========== -->
< ul class = "blockList" >
< li class = "blockList" > < a name = "method_detail" >
<!-- -->
< / a >
< h3 > Method Detail< / h3 >
< a name = "getID()" >
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > getID< / h4 >
< pre > int getID()< / pre >
< div class = "block" > Retrieve a unique worker ID.< / div >
< dl > < dt > < span class = "strong" > Returns:< / span > < / dt > < dd > Unique worker ID.< / dd > < / dl >
< / li >
< / ul >
< a name = "stop()" >
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > stop< / h4 >
< pre > boolean stop()
throws java.lang.InterruptedException< / pre >
< div class = "block" > Stop the given runnable.
< p >
This may not occur right away.< / div >
< dl > < dt > < span class = "strong" > Returns:< / span > < / dt > < dd > TRUE if the thread was stopped, FALSE if it was already stopped.< / dd >
< dt > < span class = "strong" > Throws:< / span > < / dt >
< dd > < code > java.lang.InterruptedException< / code > < / dd > < / dl >
< / li >
< / ul >
< a name = "isRunning()" >
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > isRunning< / h4 >
< pre > boolean isRunning()< / pre >
< div class = "block" > Determine if we're running or not.< / div >
< dl > < dt > < span class = "strong" > Returns:< / span > < / dt > < dd > TRUE if we're running, FALSE otherwise.< / dd > < / dl >
< / li >
< / ul >
< a name = "isFinished()" >
<!-- -->
< / a >
< ul class = "blockListLast" >
< li class = "blockList" >
< h4 > isFinished< / h4 >
< pre > boolean isFinished()< / pre >
< div class = "block" > Determine if this runnable has already run its course.< / div >
< dl > < dt > < span class = "strong" > Returns:< / span > < / dt > < dd > TRUE if it has been stopped, FALSE otherwise.< / 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/AsyncRunnable.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/async/AsyncMarker.html" title = "class in com.comphenix.protocol.async" > < span class = "strong" > Prev Class< / span > < / a > < / li >
< li > Next Class< / li >
< / ul >
< ul class = "navList" >
< li > < a href = "../../../../index.html?com/comphenix/protocol/async/AsyncRunnable.html" target = "_top" > Frames< / a > < / li >
< li > < a href = "AsyncRunnable.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 > Field | < / li >
< li > Constr | < / li >
< li > < a href = "#method_summary" > Method< / a > < / li >
< / ul >
< ul class = "subNavList" >
< li > Detail: < / li >
< li > Field | < / li >
< li > Constr | < / li >
< li > < a href = "#method_detail" > Method< / a > < / li >
< / ul >
< / div >
< a name = "skip-navbar_bottom" >
<!-- -->
< / a > < / div >
<!-- ======== END OF BOTTOM NAVBAR ======= -->
< / body >
< / html >
