Details | Last modification | View Log | RSS feed
| Rev | Author | Line No. | Line |
|---|---|---|---|
| 1777 | jmachado | 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.5.0_09) on Thu Nov 02 11:46:42 EST 2006 --> |
||
| 6 | <TITLE> |
||
| 7 | Limit (Ant Contrib) |
||
| 8 | </TITLE> |
||
| 9 | |||
| 10 | <META NAME="keywords" CONTENT="net.sf.antcontrib.process.Limit class"> |
||
| 11 | |||
| 12 | <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> |
||
| 13 | |||
| 14 | <SCRIPT type="text/javascript"> |
||
| 15 | function windowTitle() |
||
| 16 | { |
||
| 17 | parent.document.title="Limit (Ant Contrib)"; |
||
| 18 | } |
||
| 19 | </SCRIPT> |
||
| 20 | <NOSCRIPT> |
||
| 21 | </NOSCRIPT> |
||
| 22 | |||
| 23 | </HEAD> |
||
| 24 | |||
| 25 | <BODY BGCOLOR="white" onload="windowTitle();"> |
||
| 26 | |||
| 27 | |||
| 28 | <!-- ========= START OF TOP NAVBAR ======= --> |
||
| 29 | <A NAME="navbar_top"><!-- --></A> |
||
| 30 | <A HREF="#skip-navbar_top" title="Skip navigation links"></A> |
||
| 31 | <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
||
| 32 | <TR> |
||
| 33 | <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
||
| 34 | <A NAME="navbar_top_firstrow"><!-- --></A> |
||
| 35 | <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
||
| 36 | <TR ALIGN="center" VALIGN="top"> |
||
| 37 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
||
| 38 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
||
| 39 | <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
||
| 40 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
||
| 41 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
||
| 42 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
||
| 43 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
||
| 44 | </TR> |
||
| 45 | </TABLE> |
||
| 46 | </TD> |
||
| 47 | <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
||
| 48 | </EM> |
||
| 49 | </TD> |
||
| 50 | </TR> |
||
| 51 | |||
| 52 | <TR> |
||
| 53 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
||
| 54 | <A HREF="../../../../net/sf/antcontrib/process/ForgetTask.html" title="class in net.sf.antcontrib.process"><B>PREV CLASS</B></A> |
||
| 55 | <A HREF="../../../../net/sf/antcontrib/process/Limit.TimeUnit.html" title="class in net.sf.antcontrib.process"><B>NEXT CLASS</B></A></FONT></TD> |
||
| 56 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
||
| 57 | <A HREF="../../../../index.html?net/sf/antcontrib/process/Limit.html" target="_top"><B>FRAMES</B></A> |
||
| 58 | <A HREF="Limit.html" target="_top"><B>NO FRAMES</B></A> |
||
| 59 | <SCRIPT type="text/javascript"> |
||
| 60 | <!-- |
||
| 61 | if(window==top) { |
||
| 62 | document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
||
| 63 | } |
||
| 64 | //--> |
||
| 65 | </SCRIPT> |
||
| 66 | <NOSCRIPT> |
||
| 67 | <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> |
||
| 68 | </NOSCRIPT> |
||
| 69 | |||
| 70 | |||
| 71 | </FONT></TD> |
||
| 72 | </TR> |
||
| 73 | <TR> |
||
| 74 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
||
| 75 | SUMMARY: <A HREF="#nested_class_summary">NESTED</A> | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
||
| 76 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
||
| 77 | DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
||
| 78 | </TR> |
||
| 79 | </TABLE> |
||
| 80 | <A NAME="skip-navbar_top"></A> |
||
| 81 | <!-- ========= END OF TOP NAVBAR ========= --> |
||
| 82 | |||
| 83 | <HR> |
||
| 84 | <!-- ======== START OF CLASS DATA ======== --> |
||
| 85 | <H2> |
||
| 86 | <FONT SIZE="-1"> |
||
| 87 | net.sf.antcontrib.process</FONT> |
||
| 88 | <BR> |
||
| 89 | Class Limit</H2> |
||
| 90 | <PRE> |
||
| 91 | java.lang.Object |
||
| 92 | <IMG SRC="../../../../resources/inherit.gif" ALT="extended by ">org.apache.tools.ant.ProjectComponent |
||
| 93 | <IMG SRC="../../../../resources/inherit.gif" ALT="extended by ">org.apache.tools.ant.Task |
||
| 94 | <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>net.sf.antcontrib.process.Limit</B> |
||
| 95 | </PRE> |
||
| 96 | <DL> |
||
| 97 | <DT><B>All Implemented Interfaces:</B> <DD>org.apache.tools.ant.TaskContainer</DD> |
||
| 98 | </DL> |
||
| 99 | <HR> |
||
| 100 | <DL> |
||
| 101 | <DT><PRE>public class <B>Limit</B><DT>extends org.apache.tools.ant.Task<DT>implements org.apache.tools.ant.TaskContainer</DL> |
||
| 102 | </PRE> |
||
| 103 | |||
| 104 | <P> |
||
| 105 | Limits the amount of time that a task or set of tasks can run. This is useful |
||
| 106 | for tasks that may "hang" or otherwise not complete in a timely fashion. This |
||
| 107 | task is done when either the maxwait time has expired or all nested tasks are |
||
| 108 | complete, whichever is first. |
||
| 109 | |||
| 110 | <p>Developed for use with Antelope, migrated to ant-contrib Oct 2003. |
||
| 111 | <P> |
||
| 112 | |||
| 113 | <P> |
||
| 114 | <DL> |
||
| 115 | <DT><B>Since:</B></DT> |
||
| 116 | <DD>Ant 1.5</DD> |
||
| 117 | <DT><B>Version:</B></DT> |
||
| 118 | <DD>$Revision: 1.6 $</DD> |
||
| 119 | <DT><B>Author:</B></DT> |
||
| 120 | <DD>Dale Anson, Robert D. Rice</DD> |
||
| 121 | </DL> |
||
| 122 | <HR> |
||
| 123 | |||
| 124 | <P> |
||
| 125 | <!-- ======== NESTED CLASS SUMMARY ======== --> |
||
| 126 | |||
| 127 | <A NAME="nested_class_summary"><!-- --></A> |
||
| 128 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
||
| 129 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
||
| 130 | <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
||
| 131 | <B>Nested Class Summary</B></FONT></TH> |
||
| 132 | </TR> |
||
| 133 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
||
| 134 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
||
| 135 | <CODE>static class</CODE></FONT></TD> |
||
| 136 | <TD><CODE><B><A HREF="../../../../net/sf/antcontrib/process/Limit.TimeUnit.html" title="class in net.sf.antcontrib.process">Limit.TimeUnit</A></B></CODE> |
||
| 137 | |||
| 138 | <BR> |
||
| 139 | The enumeration of units: |
||
| 140 | millisecond, second, minute, hour, day, week |
||
| 141 | Todo: we use timestamps in many places, why not factor this out</TD> |
||
| 142 | </TR> |
||
| 143 | </TABLE> |
||
| 144 | <!-- =========== FIELD SUMMARY =========== --> |
||
| 145 | |||
| 146 | <A NAME="field_summary"><!-- --></A> |
||
| 147 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
||
| 148 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
||
| 149 | <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
||
| 150 | <B>Field Summary</B></FONT></TH> |
||
| 151 | </TR> |
||
| 152 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
||
| 153 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
||
| 154 | <CODE>protected <A HREF="../../../../net/sf/antcontrib/process/Limit.TimeUnit.html" title="class in net.sf.antcontrib.process">Limit.TimeUnit</A></CODE></FONT></TD> |
||
| 155 | <TD><CODE><B><A HREF="../../../../net/sf/antcontrib/process/Limit.html#unit">unit</A></B></CODE> |
||
| 156 | |||
| 157 | <BR> |
||
| 158 | </TD> |
||
| 159 | </TR> |
||
| 160 | </TABLE> |
||
| 161 | <A NAME="fields_inherited_from_class_org.apache.tools.ant.Task"><!-- --></A> |
||
| 162 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
||
| 163 | <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
||
| 164 | <TH ALIGN="left"><B>Fields inherited from class org.apache.tools.ant.Task</B></TH> |
||
| 165 | </TR> |
||
| 166 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
||
| 167 | <TD><CODE>description, location, target, taskName, taskType, wrapper</CODE></TD> |
||
| 168 | </TR> |
||
| 169 | </TABLE> |
||
| 170 | <A NAME="fields_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></A> |
||
| 171 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
||
| 172 | <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
||
| 173 | <TH ALIGN="left"><B>Fields inherited from class org.apache.tools.ant.ProjectComponent</B></TH> |
||
| 174 | </TR> |
||
| 175 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
||
| 176 | <TD><CODE>project</CODE></TD> |
||
| 177 | </TR> |
||
| 178 | </TABLE> |
||
| 179 | |
||
| 180 | <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
||
| 181 | |||
| 182 | <A NAME="constructor_summary"><!-- --></A> |
||
| 183 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
||
| 184 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
||
| 185 | <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
||
| 186 | <B>Constructor Summary</B></FONT></TH> |
||
| 187 | </TR> |
||
| 188 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
||
| 189 | <TD><CODE><B><A HREF="../../../../net/sf/antcontrib/process/Limit.html#Limit()">Limit</A></B>()</CODE> |
||
| 190 | |||
| 191 | <BR> |
||
| 192 | </TD> |
||
| 193 | </TR> |
||
| 194 | </TABLE> |
||
| 195 | |
||
| 196 | <!-- ========== METHOD SUMMARY =========== --> |
||
| 197 | |||
| 198 | <A NAME="method_summary"><!-- --></A> |
||
| 199 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
||
| 200 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
||
| 201 | <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
||
| 202 | <B>Method Summary</B></FONT></TH> |
||
| 203 | </TR> |
||
| 204 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
||
| 205 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
||
| 206 | <CODE> void</CODE></FONT></TD> |
||
| 207 | <TD><CODE><B><A HREF="../../../../net/sf/antcontrib/process/Limit.html#addTask(org.apache.tools.ant.Task)">addTask</A></B>(org.apache.tools.ant.Task task)</CODE> |
||
| 208 | |||
| 209 | <BR> |
||
| 210 | Add a task to wait on.</TD> |
||
| 211 | </TR> |
||
| 212 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
||
| 213 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
||
| 214 | <CODE> void</CODE></FONT></TD> |
||
| 215 | <TD><CODE><B><A HREF="../../../../net/sf/antcontrib/process/Limit.html#execute()">execute</A></B>()</CODE> |
||
| 216 | |||
| 217 | <BR> |
||
| 218 | Execute all nested tasks, but stopping execution of nested tasks after |
||
| 219 | maxwait or when all tasks are done, whichever is first.</TD> |
||
| 220 | </TR> |
||
| 221 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
||
| 222 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
||
| 223 | <CODE> void</CODE></FONT></TD> |
||
| 224 | <TD><CODE><B><A HREF="../../../../net/sf/antcontrib/process/Limit.html#setDays(int)">setDays</A></B>(int value)</CODE> |
||
| 225 | |||
| 226 | <BR> |
||
| 227 | Set a day wait value.</TD> |
||
| 228 | </TR> |
||
| 229 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
||
| 230 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
||
| 231 | <CODE> void</CODE></FONT></TD> |
||
| 232 | <TD><CODE><B><A HREF="../../../../net/sf/antcontrib/process/Limit.html#setFailonerror(boolean)">setFailonerror</A></B>(boolean fail)</CODE> |
||
| 233 | |||
| 234 | <BR> |
||
| 235 | Determines whether the build should fail if the time limit has |
||
| 236 | expired on this task.</TD> |
||
| 237 | </TR> |
||
| 238 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
||
| 239 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
||
| 240 | <CODE> void</CODE></FONT></TD> |
||
| 241 | <TD><CODE><B><A HREF="../../../../net/sf/antcontrib/process/Limit.html#setHours(int)">setHours</A></B>(int value)</CODE> |
||
| 242 | |||
| 243 | <BR> |
||
| 244 | Set an hours wait value.</TD> |
||
| 245 | </TR> |
||
| 246 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
||
| 247 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
||
| 248 | <CODE> void</CODE></FONT></TD> |
||
| 249 | <TD><CODE><B><A HREF="../../../../net/sf/antcontrib/process/Limit.html#setMaxwait(int)">setMaxwait</A></B>(int wait)</CODE> |
||
| 250 | |||
| 251 | <BR> |
||
| 252 | How long to wait for all nested tasks to complete, in units.</TD> |
||
| 253 | </TR> |
||
| 254 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
||
| 255 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
||
| 256 | <CODE> void</CODE></FONT></TD> |
||
| 257 | <TD><CODE><B><A HREF="../../../../net/sf/antcontrib/process/Limit.html#setMaxWaitUnit(net.sf.antcontrib.process.Limit.TimeUnit)">setMaxWaitUnit</A></B>(<A HREF="../../../../net/sf/antcontrib/process/Limit.TimeUnit.html" title="class in net.sf.antcontrib.process">Limit.TimeUnit</A> unit)</CODE> |
||
| 258 | |||
| 259 | <BR> |
||
| 260 | Set the max wait time unit, default is minutes.</TD> |
||
| 261 | </TR> |
||
| 262 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
||
| 263 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
||
| 264 | <CODE> void</CODE></FONT></TD> |
||
| 265 | <TD><CODE><B><A HREF="../../../../net/sf/antcontrib/process/Limit.html#setMilliseconds(int)">setMilliseconds</A></B>(int value)</CODE> |
||
| 266 | |||
| 267 | <BR> |
||
| 268 | Set a millisecond wait value.</TD> |
||
| 269 | </TR> |
||
| 270 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
||
| 271 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
||
| 272 | <CODE> void</CODE></FONT></TD> |
||
| 273 | <TD><CODE><B><A HREF="../../../../net/sf/antcontrib/process/Limit.html#setMinutes(int)">setMinutes</A></B>(int value)</CODE> |
||
| 274 | |||
| 275 | <BR> |
||
| 276 | Set a minute wait value.</TD> |
||
| 277 | </TR> |
||
| 278 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
||
| 279 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
||
| 280 | <CODE> void</CODE></FONT></TD> |
||
| 281 | <TD><CODE><B><A HREF="../../../../net/sf/antcontrib/process/Limit.html#setProperty(java.lang.String)">setProperty</A></B>(java.lang.String p)</CODE> |
||
| 282 | |||
| 283 | <BR> |
||
| 284 | Name the property to set after a timeout.</TD> |
||
| 285 | </TR> |
||
| 286 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
||
| 287 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
||
| 288 | <CODE> void</CODE></FONT></TD> |
||
| 289 | <TD><CODE><B><A HREF="../../../../net/sf/antcontrib/process/Limit.html#setSeconds(int)">setSeconds</A></B>(int value)</CODE> |
||
| 290 | |||
| 291 | <BR> |
||
| 292 | Set a second wait value.</TD> |
||
| 293 | </TR> |
||
| 294 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
||
| 295 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
||
| 296 | <CODE> void</CODE></FONT></TD> |
||
| 297 | <TD><CODE><B><A HREF="../../../../net/sf/antcontrib/process/Limit.html#setUnit(java.lang.String)">setUnit</A></B>(java.lang.String unit)</CODE> |
||
| 298 | |||
| 299 | <BR> |
||
| 300 | Sets the unit for the max wait.</TD> |
||
| 301 | </TR> |
||
| 302 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
||
| 303 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
||
| 304 | <CODE> void</CODE></FONT></TD> |
||
| 305 | <TD><CODE><B><A HREF="../../../../net/sf/antcontrib/process/Limit.html#setValue(java.lang.String)">setValue</A></B>(java.lang.String v)</CODE> |
||
| 306 | |||
| 307 | <BR> |
||
| 308 | The value for the property to set after a timeout, defaults to true.</TD> |
||
| 309 | </TR> |
||
| 310 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
||
| 311 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
||
| 312 | <CODE> void</CODE></FONT></TD> |
||
| 313 | <TD><CODE><B><A HREF="../../../../net/sf/antcontrib/process/Limit.html#setWeeks(int)">setWeeks</A></B>(int value)</CODE> |
||
| 314 | |||
| 315 | <BR> |
||
| 316 | Set a week wait value.</TD> |
||
| 317 | </TR> |
||
| 318 | </TABLE> |
||
| 319 | <A NAME="methods_inherited_from_class_org.apache.tools.ant.Task"><!-- --></A> |
||
| 320 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
||
| 321 | <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
||
| 322 | <TH ALIGN="left"><B>Methods inherited from class org.apache.tools.ant.Task</B></TH> |
||
| 323 | </TR> |
||
| 324 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
||
| 325 | <TD><CODE>getDescription, getLocation, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, maybeConfigure, perform, reconfigure, setDescription, setLocation, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType</CODE></TD> |
||
| 326 | </TR> |
||
| 327 | </TABLE> |
||
| 328 | <A NAME="methods_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></A> |
||
| 329 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
||
| 330 | <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
||
| 331 | <TH ALIGN="left"><B>Methods inherited from class org.apache.tools.ant.ProjectComponent</B></TH> |
||
| 332 | </TR> |
||
| 333 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
||
| 334 | <TD><CODE>getProject, setProject</CODE></TD> |
||
| 335 | </TR> |
||
| 336 | </TABLE> |
||
| 337 | <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> |
||
| 338 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
||
| 339 | <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
||
| 340 | <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH> |
||
| 341 | </TR> |
||
| 342 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
||
| 343 | <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD> |
||
| 344 | </TR> |
||
| 345 | </TABLE> |
||
| 346 | |
||
| 347 | <P> |
||
| 348 | |||
| 349 | <!-- ============ FIELD DETAIL =========== --> |
||
| 350 | |||
| 351 | <A NAME="field_detail"><!-- --></A> |
||
| 352 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
||
| 353 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
||
| 354 | <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
||
| 355 | <B>Field Detail</B></FONT></TH> |
||
| 356 | </TR> |
||
| 357 | </TABLE> |
||
| 358 | |||
| 359 | <A NAME="unit"><!-- --></A><H3> |
||
| 360 | unit</H3> |
||
| 361 | <PRE> |
||
| 362 | protected <A HREF="../../../../net/sf/antcontrib/process/Limit.TimeUnit.html" title="class in net.sf.antcontrib.process">Limit.TimeUnit</A> <B>unit</B></PRE> |
||
| 363 | <DL> |
||
| 364 | <DL> |
||
| 365 | </DL> |
||
| 366 | </DL> |
||
| 367 | |||
| 368 | <!-- ========= CONSTRUCTOR DETAIL ======== --> |
||
| 369 | |||
| 370 | <A NAME="constructor_detail"><!-- --></A> |
||
| 371 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
||
| 372 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
||
| 373 | <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
||
| 374 | <B>Constructor Detail</B></FONT></TH> |
||
| 375 | </TR> |
||
| 376 | </TABLE> |
||
| 377 | |||
| 378 | <A NAME="Limit()"><!-- --></A><H3> |
||
| 379 | Limit</H3> |
||
| 380 | <PRE> |
||
| 381 | public <B>Limit</B>()</PRE> |
||
| 382 | <DL> |
||
| 383 | </DL> |
||
| 384 | |||
| 385 | <!-- ============ METHOD DETAIL ========== --> |
||
| 386 | |||
| 387 | <A NAME="method_detail"><!-- --></A> |
||
| 388 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
||
| 389 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
||
| 390 | <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
||
| 391 | <B>Method Detail</B></FONT></TH> |
||
| 392 | </TR> |
||
| 393 | </TABLE> |
||
| 394 | |||
| 395 | <A NAME="addTask(org.apache.tools.ant.Task)"><!-- --></A><H3> |
||
| 396 | addTask</H3> |
||
| 397 | <PRE> |
||
| 398 | public void <B>addTask</B>(org.apache.tools.ant.Task task) |
||
| 399 | throws org.apache.tools.ant.BuildException</PRE> |
||
| 400 | <DL> |
||
| 401 | <DD>Add a task to wait on. |
||
| 402 | <P> |
||
| 403 | <DD><DL> |
||
| 404 | <DT><B>Specified by:</B><DD><CODE>addTask</CODE> in interface <CODE>org.apache.tools.ant.TaskContainer</CODE></DL> |
||
| 405 | </DD> |
||
| 406 | <DD><DL> |
||
| 407 | <DT><B>Parameters:</B><DD><CODE>task</CODE> - A task to execute |
||
| 408 | <DT><B>Throws:</B> |
||
| 409 | <DD><CODE>org.apache.tools.ant.BuildException</CODE> - won't happen</DL> |
||
| 410 | </DD> |
||
| 411 | </DL> |
||
| 412 | <HR> |
||
| 413 | |||
| 414 | <A NAME="setMaxwait(int)"><!-- --></A><H3> |
||
| 415 | setMaxwait</H3> |
||
| 416 | <PRE> |
||
| 417 | public void <B>setMaxwait</B>(int wait)</PRE> |
||
| 418 | <DL> |
||
| 419 | <DD>How long to wait for all nested tasks to complete, in units. |
||
| 420 | Default is to wait 3 minutes. |
||
| 421 | <P> |
||
| 422 | <DD><DL> |
||
| 423 | </DL> |
||
| 424 | </DD> |
||
| 425 | <DD><DL> |
||
| 426 | <DT><B>Parameters:</B><DD><CODE>wait</CODE> - time to wait, set to 0 to wait forever.</DL> |
||
| 427 | </DD> |
||
| 428 | </DL> |
||
| 429 | <HR> |
||
| 430 | |||
| 431 | <A NAME="setUnit(java.lang.String)"><!-- --></A><H3> |
||
| 432 | setUnit</H3> |
||
| 433 | <PRE> |
||
| 434 | public void <B>setUnit</B>(java.lang.String unit)</PRE> |
||
| 435 | <DL> |
||
| 436 | <DD>Sets the unit for the max wait. Default is minutes. |
||
| 437 | <P> |
||
| 438 | <DD><DL> |
||
| 439 | </DL> |
||
| 440 | </DD> |
||
| 441 | <DD><DL> |
||
| 442 | <DT><B>Parameters:</B><DD><CODE>unit</CODE> - valid values are "millisecond", "second", "minute", "hour", "day", and "week".</DL> |
||
| 443 | </DD> |
||
| 444 | </DL> |
||
| 445 | <HR> |
||
| 446 | |||
| 447 | <A NAME="setMilliseconds(int)"><!-- --></A><H3> |
||
| 448 | setMilliseconds</H3> |
||
| 449 | <PRE> |
||
| 450 | public void <B>setMilliseconds</B>(int value)</PRE> |
||
| 451 | <DL> |
||
| 452 | <DD>Set a millisecond wait value. |
||
| 453 | <P> |
||
| 454 | <DD><DL> |
||
| 455 | </DL> |
||
| 456 | </DD> |
||
| 457 | <DD><DL> |
||
| 458 | <DT><B>Parameters:</B><DD><CODE>value</CODE> - the number of milliseconds to wait.</DL> |
||
| 459 | </DD> |
||
| 460 | </DL> |
||
| 461 | <HR> |
||
| 462 | |||
| 463 | <A NAME="setSeconds(int)"><!-- --></A><H3> |
||
| 464 | setSeconds</H3> |
||
| 465 | <PRE> |
||
| 466 | public void <B>setSeconds</B>(int value)</PRE> |
||
| 467 | <DL> |
||
| 468 | <DD>Set a second wait value. |
||
| 469 | <P> |
||
| 470 | <DD><DL> |
||
| 471 | </DL> |
||
| 472 | </DD> |
||
| 473 | <DD><DL> |
||
| 474 | <DT><B>Parameters:</B><DD><CODE>value</CODE> - the number of seconds to wait.</DL> |
||
| 475 | </DD> |
||
| 476 | </DL> |
||
| 477 | <HR> |
||
| 478 | |||
| 479 | <A NAME="setMinutes(int)"><!-- --></A><H3> |
||
| 480 | setMinutes</H3> |
||
| 481 | <PRE> |
||
| 482 | public void <B>setMinutes</B>(int value)</PRE> |
||
| 483 | <DL> |
||
| 484 | <DD>Set a minute wait value. |
||
| 485 | <P> |
||
| 486 | <DD><DL> |
||
| 487 | </DL> |
||
| 488 | </DD> |
||
| 489 | <DD><DL> |
||
| 490 | <DT><B>Parameters:</B><DD><CODE>value</CODE> - the number of milliseconds to wait.</DL> |
||
| 491 | </DD> |
||
| 492 | </DL> |
||
| 493 | <HR> |
||
| 494 | |||
| 495 | <A NAME="setHours(int)"><!-- --></A><H3> |
||
| 496 | setHours</H3> |
||
| 497 | <PRE> |
||
| 498 | public void <B>setHours</B>(int value)</PRE> |
||
| 499 | <DL> |
||
| 500 | <DD>Set an hours wait value. |
||
| 501 | <P> |
||
| 502 | <DD><DL> |
||
| 503 | </DL> |
||
| 504 | </DD> |
||
| 505 | <DD><DL> |
||
| 506 | <DT><B>Parameters:</B><DD><CODE>value</CODE> - the number of hours to wait.</DL> |
||
| 507 | </DD> |
||
| 508 | </DL> |
||
| 509 | <HR> |
||
| 510 | |||
| 511 | <A NAME="setDays(int)"><!-- --></A><H3> |
||
| 512 | setDays</H3> |
||
| 513 | <PRE> |
||
| 514 | public void <B>setDays</B>(int value)</PRE> |
||
| 515 | <DL> |
||
| 516 | <DD>Set a day wait value. |
||
| 517 | <P> |
||
| 518 | <DD><DL> |
||
| 519 | </DL> |
||
| 520 | </DD> |
||
| 521 | <DD><DL> |
||
| 522 | <DT><B>Parameters:</B><DD><CODE>value</CODE> - the number of days to wait.</DL> |
||
| 523 | </DD> |
||
| 524 | </DL> |
||
| 525 | <HR> |
||
| 526 | |||
| 527 | <A NAME="setWeeks(int)"><!-- --></A><H3> |
||
| 528 | setWeeks</H3> |
||
| 529 | <PRE> |
||
| 530 | public void <B>setWeeks</B>(int value)</PRE> |
||
| 531 | <DL> |
||
| 532 | <DD>Set a week wait value. |
||
| 533 | <P> |
||
| 534 | <DD><DL> |
||
| 535 | </DL> |
||
| 536 | </DD> |
||
| 537 | <DD><DL> |
||
| 538 | <DT><B>Parameters:</B><DD><CODE>value</CODE> - the number of weeks to wait.</DL> |
||
| 539 | </DD> |
||
| 540 | </DL> |
||
| 541 | <HR> |
||
| 542 | |||
| 543 | <A NAME="setMaxWaitUnit(net.sf.antcontrib.process.Limit.TimeUnit)"><!-- --></A><H3> |
||
| 544 | setMaxWaitUnit</H3> |
||
| 545 | <PRE> |
||
| 546 | public void <B>setMaxWaitUnit</B>(<A HREF="../../../../net/sf/antcontrib/process/Limit.TimeUnit.html" title="class in net.sf.antcontrib.process">Limit.TimeUnit</A> unit)</PRE> |
||
| 547 | <DL> |
||
| 548 | <DD>Set the max wait time unit, default is minutes. |
||
| 549 | <P> |
||
| 550 | <DD><DL> |
||
| 551 | </DL> |
||
| 552 | </DD> |
||
| 553 | <DD><DL> |
||
| 554 | </DL> |
||
| 555 | </DD> |
||
| 556 | </DL> |
||
| 557 | <HR> |
||
| 558 | |||
| 559 | <A NAME="setFailonerror(boolean)"><!-- --></A><H3> |
||
| 560 | setFailonerror</H3> |
||
| 561 | <PRE> |
||
| 562 | public void <B>setFailonerror</B>(boolean fail)</PRE> |
||
| 563 | <DL> |
||
| 564 | <DD>Determines whether the build should fail if the time limit has |
||
| 565 | expired on this task. |
||
| 566 | Default is no. |
||
| 567 | <P> |
||
| 568 | <DD><DL> |
||
| 569 | </DL> |
||
| 570 | </DD> |
||
| 571 | <DD><DL> |
||
| 572 | <DT><B>Parameters:</B><DD><CODE>fail</CODE> - if true, fail the build if the time limit has been reached.</DL> |
||
| 573 | </DD> |
||
| 574 | </DL> |
||
| 575 | <HR> |
||
| 576 | |||
| 577 | <A NAME="setProperty(java.lang.String)"><!-- --></A><H3> |
||
| 578 | setProperty</H3> |
||
| 579 | <PRE> |
||
| 580 | public void <B>setProperty</B>(java.lang.String p)</PRE> |
||
| 581 | <DL> |
||
| 582 | <DD>Name the property to set after a timeout. |
||
| 583 | <P> |
||
| 584 | <DD><DL> |
||
| 585 | </DL> |
||
| 586 | </DD> |
||
| 587 | <DD><DL> |
||
| 588 | <DT><B>Parameters:</B><DD><CODE>p</CODE> - of property to set if the time limit has been reached.</DL> |
||
| 589 | </DD> |
||
| 590 | </DL> |
||
| 591 | <HR> |
||
| 592 | |||
| 593 | <A NAME="setValue(java.lang.String)"><!-- --></A><H3> |
||
| 594 | setValue</H3> |
||
| 595 | <PRE> |
||
| 596 | public void <B>setValue</B>(java.lang.String v)</PRE> |
||
| 597 | <DL> |
||
| 598 | <DD>The value for the property to set after a timeout, defaults to true. |
||
| 599 | <P> |
||
| 600 | <DD><DL> |
||
| 601 | </DL> |
||
| 602 | </DD> |
||
| 603 | <DD><DL> |
||
| 604 | <DT><B>Parameters:</B><DD><CODE>v</CODE> - for the property to set if the time limit has been reached.</DL> |
||
| 605 | </DD> |
||
| 606 | </DL> |
||
| 607 | <HR> |
||
| 608 | |||
| 609 | <A NAME="execute()"><!-- --></A><H3> |
||
| 610 | execute</H3> |
||
| 611 | <PRE> |
||
| 612 | public void <B>execute</B>() |
||
| 613 | throws org.apache.tools.ant.BuildException</PRE> |
||
| 614 | <DL> |
||
| 615 | <DD>Execute all nested tasks, but stopping execution of nested tasks after |
||
| 616 | maxwait or when all tasks are done, whichever is first. |
||
| 617 | <P> |
||
| 618 | <DD><DL> |
||
| 619 | <DT><B>Overrides:</B><DD><CODE>execute</CODE> in class <CODE>org.apache.tools.ant.Task</CODE></DL> |
||
| 620 | </DD> |
||
| 621 | <DD><DL> |
||
| 622 | |||
| 623 | <DT><B>Throws:</B> |
||
| 624 | <DD><CODE>org.apache.tools.ant.BuildException</CODE> - Description of the Exception</DL> |
||
| 625 | </DD> |
||
| 626 | </DL> |
||
| 627 | <!-- ========= END OF CLASS DATA ========= --> |
||
| 628 | <HR> |
||
| 629 | |||
| 630 | |||
| 631 | <!-- ======= START OF BOTTOM NAVBAR ====== --> |
||
| 632 | <A NAME="navbar_bottom"><!-- --></A> |
||
| 633 | <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> |
||
| 634 | <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
||
| 635 | <TR> |
||
| 636 | <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
||
| 637 | <A NAME="navbar_bottom_firstrow"><!-- --></A> |
||
| 638 | <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
||
| 639 | <TR ALIGN="center" VALIGN="top"> |
||
| 640 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
||
| 641 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
||
| 642 | <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
||
| 643 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
||
| 644 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
||
| 645 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
||
| 646 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
||
| 647 | </TR> |
||
| 648 | </TABLE> |
||
| 649 | </TD> |
||
| 650 | <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
||
| 651 | </EM> |
||
| 652 | </TD> |
||
| 653 | </TR> |
||
| 654 | |||
| 655 | <TR> |
||
| 656 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
||
| 657 | <A HREF="../../../../net/sf/antcontrib/process/ForgetTask.html" title="class in net.sf.antcontrib.process"><B>PREV CLASS</B></A> |
||
| 658 | <A HREF="../../../../net/sf/antcontrib/process/Limit.TimeUnit.html" title="class in net.sf.antcontrib.process"><B>NEXT CLASS</B></A></FONT></TD> |
||
| 659 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
||
| 660 | <A HREF="../../../../index.html?net/sf/antcontrib/process/Limit.html" target="_top"><B>FRAMES</B></A> |
||
| 661 | <A HREF="Limit.html" target="_top"><B>NO FRAMES</B></A> |
||
| 662 | <SCRIPT type="text/javascript"> |
||
| 663 | <!-- |
||
| 664 | if(window==top) { |
||
| 665 | document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
||
| 666 | } |
||
| 667 | //--> |
||
| 668 | </SCRIPT> |
||
| 669 | <NOSCRIPT> |
||
| 670 | <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> |
||
| 671 | </NOSCRIPT> |
||
| 672 | |||
| 673 | |||
| 674 | </FONT></TD> |
||
| 675 | </TR> |
||
| 676 | <TR> |
||
| 677 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
||
| 678 | SUMMARY: <A HREF="#nested_class_summary">NESTED</A> | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
||
| 679 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
||
| 680 | DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
||
| 681 | </TR> |
||
| 682 | </TABLE> |
||
| 683 | <A NAME="skip-navbar_bottom"></A> |
||
| 684 | <!-- ======== END OF BOTTOM NAVBAR ======= --> |
||
| 685 | |||
| 686 | <HR> |
||
| 687 | |||
| 688 | </BODY> |
||
| 689 | </HTML> |