1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
\r
5 <!-- Generated by javadoc (build 1.6.0_14) on Wed Feb 17 16:46:50 GMT 2010 -->
\r
10 <META NAME="date" CONTENT="2010-02-17">
\r
12 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
\r
14 <SCRIPT type="text/javascript">
\r
15 function windowTitle()
\r
17 if (location.href.indexOf('is-external=true') == -1) {
\r
18 parent.document.title="LocalExecutorService";
\r
27 <BODY BGCOLOR="white" onload="windowTitle();">
\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
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> </TD>
\r
41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
\r
42 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
\r
43 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/LocalExecutorService.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
\r
44 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
\r
45 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
\r
46 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
\r
47 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
\r
51 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
\r
57 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
58 <A HREF="../../../compbio/engine/local/LocalEngineUtil.html" title="class in compbio.engine.local"><B>PREV CLASS</B></A>
\r
59 <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>
\r
62 <A HREF="LocalExecutorService.html" target="_top"><B>NO FRAMES</B></A>
\r
63 <SCRIPT type="text/javascript">
\r
66 document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
\r
71 <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
\r
78 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
79 SUMMARY: <A HREF="#nested_classes_inherited_from_class_java.util.concurrent.ThreadPoolExecutor">NESTED</A> | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
\r
80 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
81 DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
\r
84 <A NAME="skip-navbar_top"></A>
\r
85 <!-- ========= END OF TOP NAVBAR ========= -->
\r
88 <!-- ======== START OF CLASS DATA ======== -->
\r
91 compbio.engine.local</FONT>
\r
93 Class LocalExecutorService</H2>
\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
101 <DT><B>All Implemented Interfaces:</B> <DD>java.util.concurrent.Executor, java.util.concurrent.ExecutorService</DD>
\r
105 <DT><PRE>public final class <B>LocalExecutorService</B><DT>extends java.util.concurrent.ThreadPoolExecutor</DL>
\r
112 <!-- ======== NESTED CLASS SUMMARY ======== -->
\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
121 <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
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
132 <!-- ========== METHOD SUMMARY =========== -->
\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
140 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
141 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
142 <CODE> boolean</CODE></FONT></TD>
\r
143 <TD><CODE><B><A HREF="../../../compbio/engine/local/LocalExecutorService.html#canAcceptMoreWork()">canAcceptMoreWork</A></B>()</CODE>
\r
146 If the Executor queue is empty</TD>
\r
148 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
149 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
150 <CODE>static <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
154 This method returns the single instance of CachedThreadPoolExecutor which
155 it cashes internally</TD>
\r
157 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
158 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
159 <CODE>static void</CODE></FONT></TD>
\r
160 <TD><CODE><B><A HREF="../../../compbio/engine/local/LocalExecutorService.html#shutDown()">shutDown</A></B>()</CODE>
\r
163 This stops all executing processes via interruption.</TD>
\r
166 <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
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
175 <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
180 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
181 <TD><CODE>invokeAll, invokeAll, invokeAny, invokeAny, submit, submit, submit</CODE></TD>
\r
184 <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
189 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
190 <TD><CODE>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
\r
196 <!-- ============ METHOD DETAIL ========== -->
\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
206 <A NAME="getExecutor()"><!-- --></A><H3>
\r
209 public static <A HREF="../../../compbio/engine/local/LocalExecutorService.html" title="class in compbio.engine.local">LocalExecutorService</A> <B>getExecutor</B>()</PRE>
\r
211 <DD>This method returns the single instance of CachedThreadPoolExecutor which
212 it cashes internally
\r
216 <DT><B>Returns:</B><DD></DL>
\r
221 <A NAME="shutDown()"><!-- --></A><H3>
\r
224 public static void <B>shutDown</B>()</PRE>
\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
235 <A NAME="canAcceptMoreWork()"><!-- --></A><H3>
\r
236 canAcceptMoreWork</H3>
\r
238 public boolean <B>canAcceptMoreWork</B>()</PRE>
\r
240 <DD>If the Executor queue is empty
\r
244 <DT><B>Returns:</B><DD>true is not all threads are busy, false overwise</DL>
\r
247 <!-- ========= END OF CLASS DATA ========= -->
\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
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> </TD>
\r
261 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
\r
262 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
\r
263 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/LocalExecutorService.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
\r
264 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
\r
265 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
\r
266 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
\r
267 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
\r
271 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
\r
277 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
278 <A HREF="../../../compbio/engine/local/LocalEngineUtil.html" title="class in compbio.engine.local"><B>PREV CLASS</B></A>
\r
279 <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>
\r
282 <A HREF="LocalExecutorService.html" target="_top"><B>NO FRAMES</B></A>
\r
283 <SCRIPT type="text/javascript">
\r
286 document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
\r
291 <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
\r
298 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
299 SUMMARY: <A HREF="#nested_classes_inherited_from_class_java.util.concurrent.ThreadPoolExecutor">NESTED</A> | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
\r
300 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
301 DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
\r
304 <A NAME="skip-navbar_bottom"></A>
\r
305 <!-- ======== END OF BOTTOM NAVBAR ======= -->
\r