source: other-projects/trunk/gs3-release-maker/apache-ant-1.6.5/build/javadocs/org/apache/tools/ant/util/Watchdog.html@ 14627

Last change on this file since 14627 was 14627, checked in by oranfry, 17 years ago

initial import of the gs3-release-maker
File size: 13.9 KB
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<!--NewPage-->
3<HTML>
4<HEAD>
5<!-- Generated by javadoc (build 1.4.2_13) on Mon Oct 01 14:33:35 NZST 2007 -->
6<TITLE>
7Watchdog (Apache Ant API)
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.apache.tools.ant.util.Watchdog class">
11
12<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
13
14<SCRIPT type="text/javascript">
15function windowTitle()
16{
17 parent.document.title="Watchdog (Apache Ant API)";
18}
19</SCRIPT>
20
21</HEAD>
22
23<BODY BGCOLOR="white" onload="windowTitle();">
24
25
26<!-- ========= START OF TOP NAVBAR ======= -->
27<A NAME="navbar_top"><!-- --></A>
28<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
29<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
30<TR>
31<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
32<A NAME="navbar_top_firstrow"><!-- --></A>
33<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
34 <TR ALIGN="center" VALIGN="top">
35 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
36 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
37 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
38 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
39 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
40 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
42 </TR>
43</TABLE>
44</TD>
45<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
46</EM>
47</TD>
48</TR>
49
50<TR>
51<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
52&nbsp;<A HREF="../../../../../org/apache/tools/ant/util/UnPackageNameMapper.html" title="class in org.apache.tools.ant.util"><B>PREV CLASS</B></A>&nbsp;
53&nbsp;<A HREF="../../../../../org/apache/tools/ant/util/WeakishReference.html" title="class in org.apache.tools.ant.util"><B>NEXT CLASS</B></A></FONT></TD>
54<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
55 <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
56&nbsp;<A HREF="Watchdog.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
57&nbsp;<SCRIPT type="text/javascript">
58 <!--
59 if(window==top) {
60 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
61 }
62 //-->
63</SCRIPT>
64<NOSCRIPT>
65 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
66</NOSCRIPT>
67
68</FONT></TD>
69</TR>
70<TR>
71<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
72 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
73<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
74DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
75</TR>
76</TABLE>
77<A NAME="skip-navbar_top"></A>
78<!-- ========= END OF TOP NAVBAR ========= -->
79
80<HR>
81<!-- ======== START OF CLASS DATA ======== -->
82<H2>
83<FONT SIZE="-1">
84org.apache.tools.ant.util</FONT>
85<BR>
86Class Watchdog</H2>
87<PRE>
88java.lang.Object
89 <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.tools.ant.util.Watchdog</B>
90</PRE>
91<DL>
92<DT><B>All Implemented Interfaces:</B> <DD>java.lang.Runnable</DD>
93</DL>
94<HR>
95<DL>
96<DT>public class <B>Watchdog</B><DT>extends java.lang.Object<DT>implements java.lang.Runnable</DL>
97
98<P>
99Generalization of <code>ExecuteWatchdog</code>
100<P>
101
102<P>
103<DL>
104<DT><B>Since:</B></DT>
105 <DD>Ant 1.5</DD>
106<DT><B>See Also:</B><DD><A HREF="../../../../../org/apache/tools/ant/taskdefs/ExecuteWatchdog.html" title="class in org.apache.tools.ant.taskdefs"><CODE>ExecuteWatchdog</CODE></A></DL>
107<HR>
108
109<P>
110<!-- ======== NESTED CLASS SUMMARY ======== -->
111
112
113<!-- =========== FIELD SUMMARY =========== -->
114
115
116<!-- ======== CONSTRUCTOR SUMMARY ======== -->
117
118<A NAME="constructor_summary"><!-- --></A>
119<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
120<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
121<TD COLSPAN=2><FONT SIZE="+2">
122<B>Constructor Summary</B></FONT></TD>
123</TR>
124<TR BGCOLOR="white" CLASS="TableRowColor">
125<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/util/Watchdog.html#Watchdog(long)">Watchdog</A></B>(long&nbsp;timeout)</CODE>
126
127<BR>
128&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructor for Watchdog.</TD>
129</TR>
130</TABLE>
131&nbsp;
132<!-- ========== METHOD SUMMARY =========== -->
133
134<A NAME="method_summary"><!-- --></A>
135<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
136<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
137<TD COLSPAN=2><FONT SIZE="+2">
138<B>Method Summary</B></FONT></TD>
139</TR>
140<TR BGCOLOR="white" CLASS="TableRowColor">
141<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
142<CODE>&nbsp;void</CODE></FONT></TD>
143<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/util/Watchdog.html#addTimeoutObserver(org.apache.tools.ant.util.TimeoutObserver)">addTimeoutObserver</A></B>(<A HREF="../../../../../org/apache/tools/ant/util/TimeoutObserver.html" title="interface in org.apache.tools.ant.util">TimeoutObserver</A>&nbsp;to)</CODE>
144
145<BR>
146&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Add a timeout observer.</TD>
147</TR>
148<TR BGCOLOR="white" CLASS="TableRowColor">
149<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
150<CODE>protected &nbsp;void</CODE></FONT></TD>
151<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/util/Watchdog.html#fireTimeoutOccured()">fireTimeoutOccured</A></B>()</CODE>
152
153<BR>
154&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Inform the observers that a timeout has occured.</TD>
155</TR>
156<TR BGCOLOR="white" CLASS="TableRowColor">
157<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
158<CODE>&nbsp;void</CODE></FONT></TD>
159<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/util/Watchdog.html#removeTimeoutObserver(org.apache.tools.ant.util.TimeoutObserver)">removeTimeoutObserver</A></B>(<A HREF="../../../../../org/apache/tools/ant/util/TimeoutObserver.html" title="interface in org.apache.tools.ant.util">TimeoutObserver</A>&nbsp;to)</CODE>
160
161<BR>
162&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Remove a timeout observer.</TD>
163</TR>
164<TR BGCOLOR="white" CLASS="TableRowColor">
165<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
166<CODE>&nbsp;void</CODE></FONT></TD>
167<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/util/Watchdog.html#run()">run</A></B>()</CODE>
168
169<BR>
170&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The run method of the watch dog thread.</TD>
171</TR>
172<TR BGCOLOR="white" CLASS="TableRowColor">
173<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
174<CODE>&nbsp;void</CODE></FONT></TD>
175<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/util/Watchdog.html#start()">start</A></B>()</CODE>
176
177<BR>
178&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Start the watch dog.</TD>
179</TR>
180<TR BGCOLOR="white" CLASS="TableRowColor">
181<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
182<CODE>&nbsp;void</CODE></FONT></TD>
183<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/util/Watchdog.html#stop()">stop</A></B>()</CODE>
184
185<BR>
186&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Stop the watch dog.</TD>
187</TR>
188</TABLE>
189&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
190<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
191<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
192<TD><B>Methods inherited from class java.lang.Object</B></TD>
193</TR>
194<TR BGCOLOR="white" CLASS="TableRowColor">
195<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
196</TR>
197</TABLE>
198&nbsp;
199<P>
200
201<!-- ============ FIELD DETAIL =========== -->
202
203
204<!-- ========= CONSTRUCTOR DETAIL ======== -->
205
206<A NAME="constructor_detail"><!-- --></A>
207<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
208<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
209<TD COLSPAN=1><FONT SIZE="+2">
210<B>Constructor Detail</B></FONT></TD>
211</TR>
212</TABLE>
213
214<A NAME="Watchdog(long)"><!-- --></A><H3>
215Watchdog</H3>
216<PRE>
217public <B>Watchdog</B>(long&nbsp;timeout)</PRE>
218<DL>
219<DD>Constructor for Watchdog.
220<P>
221<DT><B>Parameters:</B><DD><CODE>timeout</CODE> - the timeout to use in milliseconds (must be >= 1).</DL>
222
223<!-- ============ METHOD DETAIL ========== -->
224
225<A NAME="method_detail"><!-- --></A>
226<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
227<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
228<TD COLSPAN=1><FONT SIZE="+2">
229<B>Method Detail</B></FONT></TD>
230</TR>
231</TABLE>
232
233<A NAME="addTimeoutObserver(org.apache.tools.ant.util.TimeoutObserver)"><!-- --></A><H3>
234addTimeoutObserver</H3>
235<PRE>
236public void <B>addTimeoutObserver</B>(<A HREF="../../../../../org/apache/tools/ant/util/TimeoutObserver.html" title="interface in org.apache.tools.ant.util">TimeoutObserver</A>&nbsp;to)</PRE>
237<DL>
238<DD>Add a timeout observer.
239<P>
240<DD><DL>
241</DL>
242</DD>
243<DD><DL>
244<DT><B>Parameters:</B><DD><CODE>to</CODE> - the timeout observer to add.</DL>
245</DD>
246</DL>
247<HR>
248
249<A NAME="removeTimeoutObserver(org.apache.tools.ant.util.TimeoutObserver)"><!-- --></A><H3>
250removeTimeoutObserver</H3>
251<PRE>
252public void <B>removeTimeoutObserver</B>(<A HREF="../../../../../org/apache/tools/ant/util/TimeoutObserver.html" title="interface in org.apache.tools.ant.util">TimeoutObserver</A>&nbsp;to)</PRE>
253<DL>
254<DD>Remove a timeout observer.
255<P>
256<DD><DL>
257</DL>
258</DD>
259<DD><DL>
260<DT><B>Parameters:</B><DD><CODE>to</CODE> - the timeout observer to remove.</DL>
261</DD>
262</DL>
263<HR>
264
265<A NAME="fireTimeoutOccured()"><!-- --></A><H3>
266fireTimeoutOccured</H3>
267<PRE>
268protected final void <B>fireTimeoutOccured</B>()</PRE>
269<DL>
270<DD>Inform the observers that a timeout has occured.
271<P>
272<DD><DL>
273</DL>
274</DD>
275<DD><DL>
276</DL>
277</DD>
278</DL>
279<HR>
280
281<A NAME="start()"><!-- --></A><H3>
282start</H3>
283<PRE>
284public void <B>start</B>()</PRE>
285<DL>
286<DD>Start the watch dog.
287<P>
288<DD><DL>
289</DL>
290</DD>
291<DD><DL>
292</DL>
293</DD>
294</DL>
295<HR>
296
297<A NAME="stop()"><!-- --></A><H3>
298stop</H3>
299<PRE>
300public void <B>stop</B>()</PRE>
301<DL>
302<DD>Stop the watch dog.
303<P>
304<DD><DL>
305</DL>
306</DD>
307<DD><DL>
308</DL>
309</DD>
310</DL>
311<HR>
312
313<A NAME="run()"><!-- --></A><H3>
314run</H3>
315<PRE>
316public void <B>run</B>()</PRE>
317<DL>
318<DD>The run method of the watch dog thread.
319 This simply does a wait for the timeout time, and
320 if the stop flag has not been set when the wait has returned or
321 has been interrupted, the watch dog listeners are informed.
322<P>
323<DD><DL>
324<DT><B>Specified by:</B><DD><CODE>run</CODE> in interface <CODE>java.lang.Runnable</CODE></DL>
325</DD>
326<DD><DL>
327</DL>
328</DD>
329</DL>
330<!-- ========= END OF CLASS DATA ========= -->
331<HR>
332
333
334<!-- ======= START OF BOTTOM NAVBAR ====== -->
335<A NAME="navbar_bottom"><!-- --></A>
336<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
337<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
338<TR>
339<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
340<A NAME="navbar_bottom_firstrow"><!-- --></A>
341<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
342 <TR ALIGN="center" VALIGN="top">
343 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
344 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
345 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
346 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
347 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
348 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
349 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
350 </TR>
351</TABLE>
352</TD>
353<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
354</EM>
355</TD>
356</TR>
357
358<TR>
359<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
360&nbsp;<A HREF="../../../../../org/apache/tools/ant/util/UnPackageNameMapper.html" title="class in org.apache.tools.ant.util"><B>PREV CLASS</B></A>&nbsp;
361&nbsp;<A HREF="../../../../../org/apache/tools/ant/util/WeakishReference.html" title="class in org.apache.tools.ant.util"><B>NEXT CLASS</B></A></FONT></TD>
362<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
363 <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
364&nbsp;<A HREF="Watchdog.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
365&nbsp;<SCRIPT type="text/javascript">
366 <!--
367 if(window==top) {
368 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
369 }
370 //-->
371</SCRIPT>
372<NOSCRIPT>
373 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
374</NOSCRIPT>
375
376</FONT></TD>
377</TR>
378<TR>
379<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
380 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
381<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
382DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
383</TR>
384</TABLE>
385<A NAME="skip-navbar_bottom"></A>
386<!-- ======== END OF BOTTOM NAVBAR ======= -->
387
388<HR>
389Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.
390</BODY>
391</HTML>
Note: See TracBrowser for help on using the repository browser.