website/full_javadoc/compbio/engine/local/LocalExecutorService.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">\r
   2 <!--NewPage-->\r
   3 <HTML>\r
   4 <HEAD>\r
   5 <!-- Generated by javadoc (build 1.6.0_14) on Wed Feb 17 16:46:50 GMT 2010 -->\r
   6 <TITLE>\r
   7 LocalExecutorService\r
   8 </TITLE>\r
   9 \r
  10 <META NAME="date" CONTENT="2010-02-17">\r
  11 \r
  12 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">\r
  13 \r
  14 <SCRIPT type="text/javascript">\r
  15 function windowTitle()\r
  16 {\r
  17     if (location.href.indexOf('is-external=true') == -1) {\r
  18         parent.document.title="LocalExecutorService";\r
  19     }\r
  20 }\r
  21 </SCRIPT>\r
  22 <NOSCRIPT>\r
  23 </NOSCRIPT>\r
  24 \r
  25 </HEAD>\r
  26 \r
  27 <BODY BGCOLOR="white" onload="windowTitle();">\r
  28 <HR>\r
  29 \r
  30 \r
  31 <!-- ========= START OF TOP NAVBAR ======= -->\r
  32 <A NAME="navbar_top"><!-- --></A>\r
  33 <A HREF="#skip-navbar_top" title="Skip navigation links"></A>\r
  34 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
  35 <TR>\r
  36 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
  37 <A NAME="navbar_top_firstrow"><!-- --></A>\r
  38 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
  39   <TR ALIGN="center" VALIGN="top">\r
  40   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
  41   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
  42   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
  43   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/LocalExecutorService.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>\r
  44   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
  45   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
  46   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
  47   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
  48   </TR>\r
  49 </TABLE>\r
  50 </TD>\r
  51 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
  52 </EM>\r
  53 </TD>\r
  54 </TR>\r
  55 \r
  56 <TR>\r
  57 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
  58 &nbsp;<A HREF="../../../compbio/engine/local/LocalEngineUtil.html" title="class in compbio.engine.local"><B>PREV CLASS</B></A>&nbsp;\r
  59 &nbsp;<A HREF="../../../compbio/engine/local/LocalRunner.html" title="class in compbio.engine.local"><B>NEXT CLASS</B></A></FONT></TD>\r
  60 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
  61   <A HREF="../../../index.html?compbio/engine/local/LocalExecutorService.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
  62 &nbsp;<A HREF="LocalExecutorService.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
  63 &nbsp;<SCRIPT type="text/javascript">\r
  64   <!--\r
  65   if(window==top) {\r
  66     document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
  67   }\r
  68   //-->\r
  69 </SCRIPT>\r
  70 <NOSCRIPT>\r
  71   <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>\r
  72 </NOSCRIPT>\r
  73 \r
  74 \r
  75 </FONT></TD>\r
  76 </TR>\r
  77 <TR>\r
  78 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
  79   SUMMARY:&nbsp;<A HREF="#nested_classes_inherited_from_class_java.util.concurrent.ThreadPoolExecutor">NESTED</A>&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
  80 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
  81 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
  82 </TR>\r
  83 </TABLE>\r
  84 <A NAME="skip-navbar_top"></A>\r
  85 <!-- ========= END OF TOP NAVBAR ========= -->\r
  86 \r
  87 <HR>\r
  88 <!-- ======== START OF CLASS DATA ======== -->\r
  89 <H2>\r
  90 <FONT SIZE="-1">\r
  91 compbio.engine.local</FONT>\r
  92 <BR>\r
  93 Class LocalExecutorService</H2>\r
  94 <PRE>\r
  95 java.lang.Object\r
  96   <IMG SRC="../../../resources/inherit.gif" ALT="extended by ">java.util.concurrent.AbstractExecutorService\r
  97       <IMG SRC="../../../resources/inherit.gif" ALT="extended by ">java.util.concurrent.ThreadPoolExecutor\r
  98           <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>compbio.engine.local.LocalExecutorService</B>\r
  99 </PRE>\r
 100 <DL>\r
 101 <DT><B>All Implemented Interfaces:</B> <DD>java.util.concurrent.Executor, java.util.concurrent.ExecutorService</DD>\r
 102 </DL>\r
 103 <HR>\r
 104 <DL>\r
 105 <DT><PRE>public final class <B>LocalExecutorService</B><DT>extends java.util.concurrent.ThreadPoolExecutor</DL>\r
 106 </PRE>\r
 107 \r
 108 <P>\r
 109 <HR>\r
 110 \r
 111 <P>\r
 112 <!-- ======== NESTED CLASS SUMMARY ======== -->\r
 113 \r
 114 <A NAME="nested_class_summary"><!-- --></A>\r
 115 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 116 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 117 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
 118 <B>Nested Class Summary</B></FONT></TH>\r
 119 </TR>\r
 120 </TABLE>\r
 121 &nbsp;<A NAME="nested_classes_inherited_from_class_java.util.concurrent.ThreadPoolExecutor"><!-- --></A>\r
 122 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 123 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
 124 <TH ALIGN="left"><B>Nested classes/interfaces inherited from class java.util.concurrent.ThreadPoolExecutor</B></TH>\r
 125 </TR>\r
 126 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 127 <TD><CODE>java.util.concurrent.ThreadPoolExecutor.AbortPolicy, java.util.concurrent.ThreadPoolExecutor.CallerRunsPolicy, java.util.concurrent.ThreadPoolExecutor.DiscardOldestPolicy, java.util.concurrent.ThreadPoolExecutor.DiscardPolicy</CODE></TD>\r
 128 </TR>\r
 129 </TABLE>\r
 130 &nbsp;\r
 131 \r
 132 <!-- ========== METHOD SUMMARY =========== -->\r
 133 \r
 134 <A NAME="method_summary"><!-- --></A>\r
 135 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 136 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 137 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
 138 <B>Method Summary</B></FONT></TH>\r
 139 </TR>\r
 140 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 141 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 142 <CODE>&nbsp;boolean</CODE></FONT></TD>\r
 143 <TD><CODE><B><A HREF="../../../compbio/engine/local/LocalExecutorService.html#canAcceptMoreWork()">canAcceptMoreWork</A></B>()</CODE>\r
 144 \r
 145 <BR>\r
 146 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;If the Executor queue is empty</TD>\r
 147 </TR>\r
 148 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 149 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 150 <CODE>static&nbsp;<A HREF="../../../compbio/engine/local/LocalExecutorService.html" title="class in compbio.engine.local">LocalExecutorService</A></CODE></FONT></TD>\r
 151 <TD><CODE><B><A HREF="../../../compbio/engine/local/LocalExecutorService.html#getExecutor()">getExecutor</A></B>()</CODE>\r
 152 \r
 153 <BR>\r
 154 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This method returns the single instance of CachedThreadPoolExecutor which
 155  it cashes internally</TD>\r
 156 </TR>\r
 157 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 158 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 159 <CODE>static&nbsp;void</CODE></FONT></TD>\r
 160 <TD><CODE><B><A HREF="../../../compbio/engine/local/LocalExecutorService.html#shutDown()">shutDown</A></B>()</CODE>\r
 161 \r
 162 <BR>\r
 163 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This stops all executing processes via interruption.</TD>\r
 164 </TR>\r
 165 </TABLE>\r
 166 &nbsp;<A NAME="methods_inherited_from_class_java.util.concurrent.ThreadPoolExecutor"><!-- --></A>\r
 167 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 168 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
 169 <TH ALIGN="left"><B>Methods inherited from class java.util.concurrent.ThreadPoolExecutor</B></TH>\r
 170 </TR>\r
 171 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 172 <TD><CODE>allowCoreThreadTimeOut, allowsCoreThreadTimeOut, awaitTermination, execute, getActiveCount, getCompletedTaskCount, getCorePoolSize, getKeepAliveTime, getLargestPoolSize, getMaximumPoolSize, getPoolSize, getQueue, getRejectedExecutionHandler, getTaskCount, getThreadFactory, isShutdown, isTerminated, isTerminating, prestartAllCoreThreads, prestartCoreThread, purge, remove, setCorePoolSize, setKeepAliveTime, setMaximumPoolSize, setRejectedExecutionHandler, setThreadFactory, shutdown, shutdownNow</CODE></TD>\r
 173 </TR>\r
 174 </TABLE>\r
 175 &nbsp;<A NAME="methods_inherited_from_class_java.util.concurrent.AbstractExecutorService"><!-- --></A>\r
 176 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 177 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
 178 <TH ALIGN="left"><B>Methods inherited from class java.util.concurrent.AbstractExecutorService</B></TH>\r
 179 </TR>\r
 180 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 181 <TD><CODE>invokeAll, invokeAll, invokeAny, invokeAny, submit, submit, submit</CODE></TD>\r
 182 </TR>\r
 183 </TABLE>\r
 184 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>\r
 185 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 186 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
 187 <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>\r
 188 </TR>\r
 189 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 190 <TD><CODE>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>\r
 191 </TR>\r
 192 </TABLE>\r
 193 &nbsp;\r
 194 <P>\r
 195 \r
 196 <!-- ============ METHOD DETAIL ========== -->\r
 197 \r
 198 <A NAME="method_detail"><!-- --></A>\r
 199 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 200 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 201 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
 202 <B>Method Detail</B></FONT></TH>\r
 203 </TR>\r
 204 </TABLE>\r
 205 \r
 206 <A NAME="getExecutor()"><!-- --></A><H3>\r
 207 getExecutor</H3>\r
 208 <PRE>\r
 209 public static <A HREF="../../../compbio/engine/local/LocalExecutorService.html" title="class in compbio.engine.local">LocalExecutorService</A> <B>getExecutor</B>()</PRE>\r
 210 <DL>\r
 211 <DD>This method returns the single instance of CachedThreadPoolExecutor which
 212  it cashes internally\r
 213 <P>\r
 214 <DD><DL>\r
 215 \r
 216 <DT><B>Returns:</B><DD></DL>\r
 217 </DD>\r
 218 </DL>\r
 219 <HR>\r
 220 \r
 221 <A NAME="shutDown()"><!-- --></A><H3>\r
 222 shutDown</H3>\r
 223 <PRE>\r
 224 public static void <B>shutDown</B>()</PRE>\r
 225 <DL>\r
 226 <DD>This stops all executing processes via interruption. Thus it is vital
 227  that all processes that use this service respond to interruption\r
 228 <P>\r
 229 <DD><DL>\r
 230 </DL>\r
 231 </DD>\r
 232 </DL>\r
 233 <HR>\r
 234 \r
 235 <A NAME="canAcceptMoreWork()"><!-- --></A><H3>\r
 236 canAcceptMoreWork</H3>\r
 237 <PRE>\r
 238 public boolean <B>canAcceptMoreWork</B>()</PRE>\r
 239 <DL>\r
 240 <DD>If the Executor queue is empty\r
 241 <P>\r
 242 <DD><DL>\r
 243 \r
 244 <DT><B>Returns:</B><DD>true is not all threads are busy, false overwise</DL>\r
 245 </DD>\r
 246 </DL>\r
 247 <!-- ========= END OF CLASS DATA ========= -->\r
 248 <HR>\r
 249 \r
 250 \r
 251 <!-- ======= START OF BOTTOM NAVBAR ====== -->\r
 252 <A NAME="navbar_bottom"><!-- --></A>\r
 253 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>\r
 254 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
 255 <TR>\r
 256 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
 257 <A NAME="navbar_bottom_firstrow"><!-- --></A>\r
 258 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
 259   <TR ALIGN="center" VALIGN="top">\r
 260   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
 261   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
 262   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
 263   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/LocalExecutorService.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>\r
 264   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
 265   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
 266   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
 267   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
 268   </TR>\r
 269 </TABLE>\r
 270 </TD>\r
 271 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
 272 </EM>\r
 273 </TD>\r
 274 </TR>\r
 275 \r
 276 <TR>\r
 277 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
 278 &nbsp;<A HREF="../../../compbio/engine/local/LocalEngineUtil.html" title="class in compbio.engine.local"><B>PREV CLASS</B></A>&nbsp;\r
 279 &nbsp;<A HREF="../../../compbio/engine/local/LocalRunner.html" title="class in compbio.engine.local"><B>NEXT CLASS</B></A></FONT></TD>\r
 280 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
 281   <A HREF="../../../index.html?compbio/engine/local/LocalExecutorService.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
 282 &nbsp;<A HREF="LocalExecutorService.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
 283 &nbsp;<SCRIPT type="text/javascript">\r
 284   <!--\r
 285   if(window==top) {\r
 286     document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
 287   }\r
 288   //-->\r
 289 </SCRIPT>\r
 290 <NOSCRIPT>\r
 291   <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>\r
 292 </NOSCRIPT>\r
 293 \r
 294 \r
 295 </FONT></TD>\r
 296 </TR>\r
 297 <TR>\r
 298 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
 299   SUMMARY:&nbsp;<A HREF="#nested_classes_inherited_from_class_java.util.concurrent.ThreadPoolExecutor">NESTED</A>&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
 300 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
 301 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
 302 </TR>\r
 303 </TABLE>\r
 304 <A NAME="skip-navbar_bottom"></A>\r
 305 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
 306 \r
 307 <HR>\r
 308 \r
 309 </BODY>\r
 310 </HTML>\r