You can not select more than 25 topics Topics must start with a chinese character,a letter or number, can include dashes ('-') and can be up to 35 characters long.

Task.html 18 kB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Frameset//EN""http://www.w3.org/TR/REC-html40/frameset.dtd">
  2. <!--NewPage-->
  3. <HTML>
  4. <HEAD>
  5. <!-- Generated by javadoc on Sat Dec 16 22:19:46 EST 2000 -->
  6. <TITLE>
  7. : Interface Task
  8. </TITLE>
  9. <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
  10. </HEAD>
  11. <BODY BGCOLOR="white">
  12. <!-- ========== START OF NAVBAR ========== -->
  13. <A NAME="navbar_top"><!-- --></A>
  14. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
  15. <TR>
  16. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  17. <A NAME="navbar_top_firstrow"><!-- --></A>
  18. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
  19. <TR ALIGN="center" VALIGN="top">
  20. <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  21. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  22. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  23. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  24. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  25. </TR>
  26. </TABLE>
  27. </TD>
  28. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  29. </EM>
  30. </TD>
  31. </TR>
  32. <TR>
  33. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  34. &nbsp;PREV CLASS&nbsp;
  35. &nbsp;NEXT CLASS</FONT></TD>
  36. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  37. <A HREF="../../../../index.html" TARGET="_top"><B>FRAMES</B></A> &nbsp;
  38. &nbsp;<A HREF="Task.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
  39. </TR>
  40. <TR>
  41. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  42. SUMMARY: &nbsp;INNER&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  43. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  44. DETAIL: &nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  45. </TR>
  46. </TABLE>
  47. <!-- =========== END OF NAVBAR =========== -->
  48. <HR>
  49. <!-- ======== START OF CLASS DATA ======== -->
  50. <H2>
  51. <FONT SIZE="-1">
  52. org.apache.ant.tasks</FONT>
  53. <BR>
  54. Interface Task</H2>
  55. <HR>
  56. <DL>
  57. <DT>public interface <B>Task</B></DL>
  58. <P>
  59. Task is the core interface for all structures that will be processed by the
  60. TaskEngine.
  61. <P>
  62. <HR>
  63. <P>
  64. <!-- ======== INNER CLASS SUMMARY ======== -->
  65. <!-- =========== FIELD SUMMARY =========== -->
  66. <A NAME="field_summary"><!-- --></A>
  67. <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
  68. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  69. <TD COLSPAN=2><FONT SIZE="+2">
  70. <B>Field Summary</B></FONT></TD>
  71. </TR>
  72. <TR BGCOLOR="white" CLASS="TableRowColor">
  73. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  74. <CODE>static&nbsp;int</CODE></FONT></TD>
  75. <TD><CODE><B><A HREF="../../../../org/apache/ant/tasks/Task.html#EXECUTION_MODE_EXPLICIT">EXECUTION_MODE_EXPLICIT</A></B></CODE>
  76. <BR>
  77. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
  78. </TR>
  79. <TR BGCOLOR="white" CLASS="TableRowColor">
  80. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  81. <CODE>static&nbsp;int</CODE></FONT></TD>
  82. <TD><CODE><B><A HREF="../../../../org/apache/ant/tasks/Task.html#EXECUTION_MODE_IMPLICIT">EXECUTION_MODE_IMPLICIT</A></B></CODE>
  83. <BR>
  84. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
  85. </TR>
  86. <TR BGCOLOR="white" CLASS="TableRowColor">
  87. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  88. <CODE>static&nbsp;int</CODE></FONT></TD>
  89. <TD><CODE><B><A HREF="../../../../org/apache/ant/tasks/Task.html#EXECUTION_MODE_PRIORITY">EXECUTION_MODE_PRIORITY</A></B></CODE>
  90. <BR>
  91. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
  92. </TR>
  93. <TR BGCOLOR="white" CLASS="TableRowColor">
  94. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  95. <CODE>static&nbsp;char</CODE></FONT></TD>
  96. <TD><CODE><B><A HREF="../../../../org/apache/ant/tasks/Task.html#NAME_SEPARATOR">NAME_SEPARATOR</A></B></CODE>
  97. <BR>
  98. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
  99. </TR>
  100. </TABLE>
  101. &nbsp;
  102. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  103. <!-- ========== METHOD SUMMARY =========== -->
  104. <A NAME="method_summary"><!-- --></A>
  105. <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
  106. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  107. <TD COLSPAN=2><FONT SIZE="+2">
  108. <B>Method Summary</B></FONT></TD>
  109. </TR>
  110. <TR BGCOLOR="white" CLASS="TableRowColor">
  111. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  112. <CODE>&nbsp;void</CODE></FONT></TD>
  113. <TD><CODE><B><A HREF="../../../../org/apache/ant/tasks/Task.html#execute(org.apache.ant.engine.TaskEngine)">execute</A></B>(org.apache.ant.engine.TaskEngine&nbsp;engine)</CODE>
  114. <BR>
  115. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Causes the existing Task implementation to execute.</TD>
  116. </TR>
  117. <TR BGCOLOR="white" CLASS="TableRowColor">
  118. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  119. <CODE>&nbsp;java.lang.String</CODE></FONT></TD>
  120. <TD><CODE><B><A HREF="../../../../org/apache/ant/tasks/Task.html#getAttributeValue(java.lang.String)">getAttributeValue</A></B>(java.lang.String&nbsp;name)</CODE>
  121. <BR>
  122. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Each Task will hold its attributes in some manner.</TD>
  123. </TR>
  124. <TR BGCOLOR="white" CLASS="TableRowColor">
  125. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  126. <CODE>&nbsp;<A HREF="../../../../org/apache/ant/tasks/Task.html">Task</A>[]</CODE></FONT></TD>
  127. <TD><CODE><B><A HREF="../../../../org/apache/ant/tasks/Task.html#getChildren()">getChildren</A></B>()</CODE>
  128. <BR>
  129. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the an array of Task objects that are subordinate to this Task.</TD>
  130. </TR>
  131. <TR BGCOLOR="white" CLASS="TableRowColor">
  132. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  133. <CODE>&nbsp;int</CODE></FONT></TD>
  134. <TD><CODE><B><A HREF="../../../../org/apache/ant/tasks/Task.html#getExecutionMode()">getExecutionMode</A></B>()</CODE>
  135. <BR>
  136. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Determines whether this Task is executed whenever its parent is executed,
  137. or if its execution must be specifically requested.</TD>
  138. </TR>
  139. <TR BGCOLOR="white" CLASS="TableRowColor">
  140. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  141. <CODE>&nbsp;java.lang.String</CODE></FONT></TD>
  142. <TD><CODE><B><A HREF="../../../../org/apache/ant/tasks/Task.html#getFullyQualifiedName()">getFullyQualifiedName</A></B>()</CODE>
  143. <BR>
  144. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The "fully-qualified" name of a Task is the Task's name, prepended by its
  145. parent's name, prepended by its parent's name, etc.</TD>
  146. </TR>
  147. <TR BGCOLOR="white" CLASS="TableRowColor">
  148. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  149. <CODE>&nbsp;<A HREF="../../../../org/apache/ant/tasks/Task.html">Task</A></CODE></FONT></TD>
  150. <TD><CODE><B><A HREF="../../../../org/apache/ant/tasks/Task.html#getParent()">getParent</A></B>()</CODE>
  151. <BR>
  152. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns this Task's parent Task.</TD>
  153. </TR>
  154. <TR BGCOLOR="white" CLASS="TableRowColor">
  155. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  156. <CODE>&nbsp;<A HREF="../../../../org/apache/ant/tasks/Task.html">Task</A></CODE></FONT></TD>
  157. <TD><CODE><B><A HREF="../../../../org/apache/ant/tasks/Task.html#getRootTask()">getRootTask</A></B>()</CODE>
  158. <BR>
  159. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Proceed backwards through the nodes until we come across the first Task
  160. in the tree.</TD>
  161. </TR>
  162. <TR BGCOLOR="white" CLASS="TableRowColor">
  163. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  164. <CODE>&nbsp;<A HREF="../../../../org/apache/ant/tasks/Task.html">Task</A></CODE></FONT></TD>
  165. <TD><CODE><B><A HREF="../../../../org/apache/ant/tasks/Task.html#getTask(java.lang.String)">getTask</A></B>(java.lang.String&nbsp;taskPath)</CODE>
  166. <BR>
  167. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A mechanism for locating a task relative to the current task.</TD>
  168. </TR>
  169. <TR BGCOLOR="white" CLASS="TableRowColor">
  170. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  171. <CODE>&nbsp;java.lang.String</CODE></FONT></TD>
  172. <TD><CODE><B><A HREF="../../../../org/apache/ant/tasks/Task.html#getTaskName()">getTaskName</A></B>()</CODE>
  173. <BR>
  174. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Just a simple name used to identify a Task.</TD>
  175. </TR>
  176. <TR BGCOLOR="white" CLASS="TableRowColor">
  177. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  178. <CODE>&nbsp;void</CODE></FONT></TD>
  179. <TD><CODE><B><A HREF="../../../../org/apache/ant/tasks/Task.html#init(org.apache.ant.engine.TaskEngine)">init</A></B>(org.apache.ant.engine.TaskEngine&nbsp;engine)</CODE>
  180. <BR>
  181. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Called when the Task first gets "noticed" by the TaskEngine.</TD>
  182. </TR>
  183. <TR BGCOLOR="white" CLASS="TableRowColor">
  184. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  185. <CODE>&nbsp;boolean</CODE></FONT></TD>
  186. <TD><CODE><B><A HREF="../../../../org/apache/ant/tasks/Task.html#isPropertyContainer()">isPropertyContainer</A></B>()</CODE>
  187. <BR>
  188. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Determines whether a Task is suitable for holding property values.</TD>
  189. </TR>
  190. <TR BGCOLOR="white" CLASS="TableRowColor">
  191. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  192. <CODE>&nbsp;void</CODE></FONT></TD>
  193. <TD><CODE><B><A HREF="../../../../org/apache/ant/tasks/Task.html#setParent(org.apache.ant.tasks.Task)">setParent</A></B>(<A HREF="../../../../org/apache/ant/tasks/Task.html">Task</A>&nbsp;parent)</CODE>
  194. <BR>
  195. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the Task's parent.</TD>
  196. </TR>
  197. <TR BGCOLOR="white" CLASS="TableRowColor">
  198. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  199. <CODE>&nbsp;void</CODE></FONT></TD>
  200. <TD><CODE><B><A HREF="../../../../org/apache/ant/tasks/Task.html#validate()">validate</A></B>()</CODE>
  201. <BR>
  202. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Each Task should have the ability to validate its state.</TD>
  203. </TR>
  204. </TABLE>
  205. &nbsp;
  206. <P>
  207. <!-- ============ FIELD DETAIL =========== -->
  208. <A NAME="field_detail"><!-- --></A>
  209. <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
  210. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  211. <TD COLSPAN=1><FONT SIZE="+2">
  212. <B>Field Detail</B></FONT></TD>
  213. </TR>
  214. </TABLE>
  215. <A NAME="EXECUTION_MODE_IMPLICIT"><!-- --></A><H3>
  216. EXECUTION_MODE_IMPLICIT</H3>
  217. <PRE>
  218. public static final int <B>EXECUTION_MODE_IMPLICIT</B></PRE>
  219. <DL>
  220. </DL>
  221. <HR>
  222. <A NAME="EXECUTION_MODE_EXPLICIT"><!-- --></A><H3>
  223. EXECUTION_MODE_EXPLICIT</H3>
  224. <PRE>
  225. public static final int <B>EXECUTION_MODE_EXPLICIT</B></PRE>
  226. <DL>
  227. </DL>
  228. <HR>
  229. <A NAME="EXECUTION_MODE_PRIORITY"><!-- --></A><H3>
  230. EXECUTION_MODE_PRIORITY</H3>
  231. <PRE>
  232. public static final int <B>EXECUTION_MODE_PRIORITY</B></PRE>
  233. <DL>
  234. </DL>
  235. <HR>
  236. <A NAME="NAME_SEPARATOR"><!-- --></A><H3>
  237. NAME_SEPARATOR</H3>
  238. <PRE>
  239. public static final char <B>NAME_SEPARATOR</B></PRE>
  240. <DL>
  241. </DL>
  242. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  243. <!-- ============ METHOD DETAIL ========== -->
  244. <A NAME="method_detail"><!-- --></A>
  245. <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
  246. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  247. <TD COLSPAN=1><FONT SIZE="+2">
  248. <B>Method Detail</B></FONT></TD>
  249. </TR>
  250. </TABLE>
  251. <A NAME="execute(org.apache.ant.engine.TaskEngine)"><!-- --></A><H3>
  252. execute</H3>
  253. <PRE>
  254. public void <B>execute</B>(org.apache.ant.engine.TaskEngine&nbsp;engine)
  255. throws org.apache.ant.AntException</PRE>
  256. <DL>
  257. <DD>Causes the existing Task implementation to execute.</DL>
  258. <HR>
  259. <A NAME="init(org.apache.ant.engine.TaskEngine)"><!-- --></A><H3>
  260. init</H3>
  261. <PRE>
  262. public void <B>init</B>(org.apache.ant.engine.TaskEngine&nbsp;engine)
  263. throws org.apache.ant.AntException</PRE>
  264. <DL>
  265. <DD>Called when the Task first gets "noticed" by the TaskEngine.</DL>
  266. <HR>
  267. <A NAME="validate()"><!-- --></A><H3>
  268. validate</H3>
  269. <PRE>
  270. public void <B>validate</B>()
  271. throws org.apache.ant.AntException</PRE>
  272. <DL>
  273. <DD>Each Task should have the ability to validate its state. This would be
  274. invoked by the TaskEngine prior to commencing an execution cycle.</DL>
  275. <HR>
  276. <A NAME="getTaskName()"><!-- --></A><H3>
  277. getTaskName</H3>
  278. <PRE>
  279. public java.lang.String <B>getTaskName</B>()</PRE>
  280. <DL>
  281. <DD>Just a simple name used to identify a Task. This name is only sufficient
  282. for simple debugging and GUI output. It does not uniquely identify a
  283. Task.<DD><DL>
  284. <DT><B>See Also: </B><DD><A HREF="../../../../org/apache/ant/tasks/Task.html#getFullyQualifiedName()"><CODE>getFullyQualifiedName()</CODE></A></DL>
  285. </DD>
  286. </DL>
  287. <HR>
  288. <A NAME="getTask(java.lang.String)"><!-- --></A><H3>
  289. getTask</H3>
  290. <PRE>
  291. public <A HREF="../../../../org/apache/ant/tasks/Task.html">Task</A> <B>getTask</B>(java.lang.String&nbsp;taskPath)</PRE>
  292. <DL>
  293. <DD>A mechanism for locating a task relative to the current task. This
  294. navigation sceme will mimic a typical OS system. '..' will move back
  295. a level in the Task tree. If taskPath begins with '/' then the root node
  296. will be used as a starting point.
  297. <p></p>
  298. Returns null of no task is found at this location.</DL>
  299. <HR>
  300. <A NAME="getRootTask()"><!-- --></A><H3>
  301. getRootTask</H3>
  302. <PRE>
  303. public <A HREF="../../../../org/apache/ant/tasks/Task.html">Task</A> <B>getRootTask</B>()</PRE>
  304. <DL>
  305. <DD>Proceed backwards through the nodes until we come across the first Task
  306. in the tree. This is the root Task.</DL>
  307. <HR>
  308. <A NAME="getFullyQualifiedName()"><!-- --></A><H3>
  309. getFullyQualifiedName</H3>
  310. <PRE>
  311. public java.lang.String <B>getFullyQualifiedName</B>()</PRE>
  312. <DL>
  313. <DD>The "fully-qualified" name of a Task is the Task's name, prepended by its
  314. parent's name, prepended by its parent's name, etc. This method may be
  315. used by the Task's hashCode() method to calculate a hash that will
  316. uniquely identify a Task.</DL>
  317. <HR>
  318. <A NAME="getExecutionMode()"><!-- --></A><H3>
  319. getExecutionMode</H3>
  320. <PRE>
  321. public int <B>getExecutionMode</B>()</PRE>
  322. <DL>
  323. <DD>Determines whether this Task is executed whenever its parent is executed,
  324. or if its execution must be specifically requested.
  325. <p></p>
  326. <dl><dt>EXECUTION_MODE_EXPLICIT</dt>
  327. <dd>Requires interaction by the TaskEngine in order to execute.</dd>
  328. <dt>EXECUTION_MODE_IMPLICIT</dt>
  329. <dd>This Task is automatically executed when its parent is
  330. executed.</dd>
  331. <dt>EXECUTION_MODE_PRIORITY</dt>
  332. <dd>These Tasks are executed prior to its parent's execution</dd></dl>
  333. <p></p>
  334. The default mode should probably be EXECUTION_MODE_IMPLICIT. In the
  335. build domain of Ant, every Task below a Task will normally be executed.
  336. The major exception to this is the Target. When a Project Task is
  337. executed, all Target Tasks do <i>not</i> automatically fire, however all
  338. Property Tasks <i>do</i> execute.</DL>
  339. <HR>
  340. <A NAME="isPropertyContainer()"><!-- --></A><H3>
  341. isPropertyContainer</H3>
  342. <PRE>
  343. public boolean <B>isPropertyContainer</B>()</PRE>
  344. <DL>
  345. <DD>Determines whether a Task is suitable for holding property values.</DL>
  346. <HR>
  347. <A NAME="getAttributeValue(java.lang.String)"><!-- --></A><H3>
  348. getAttributeValue</H3>
  349. <PRE>
  350. public java.lang.String <B>getAttributeValue</B>(java.lang.String&nbsp;name)</PRE>
  351. <DL>
  352. <DD>Each Task will hold its attributes in some manner. This method will allow
  353. the Task implementation to return the value of its attribute.</DL>
  354. <HR>
  355. <A NAME="getParent()"><!-- --></A><H3>
  356. getParent</H3>
  357. <PRE>
  358. public <A HREF="../../../../org/apache/ant/tasks/Task.html">Task</A> <B>getParent</B>()</PRE>
  359. <DL>
  360. <DD>Returns this Task's parent Task. If this Task is the root Task, then this
  361. method will return null.</DL>
  362. <HR>
  363. <A NAME="setParent(org.apache.ant.tasks.Task)"><!-- --></A><H3>
  364. setParent</H3>
  365. <PRE>
  366. public void <B>setParent</B>(<A HREF="../../../../org/apache/ant/tasks/Task.html">Task</A>&nbsp;parent)</PRE>
  367. <DL>
  368. <DD>Sets the Task's parent.</DL>
  369. <HR>
  370. <A NAME="getChildren()"><!-- --></A><H3>
  371. getChildren</H3>
  372. <PRE>
  373. public <A HREF="../../../../org/apache/ant/tasks/Task.html">Task</A>[] <B>getChildren</B>()</PRE>
  374. <DL>
  375. <DD>Returns the an array of Task objects that are subordinate to this Task.</DL>
  376. <!-- ========= END OF CLASS DATA ========= -->
  377. <HR>
  378. <!-- ========== START OF NAVBAR ========== -->
  379. <A NAME="navbar_bottom"><!-- --></A>
  380. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
  381. <TR>
  382. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  383. <A NAME="navbar_bottom_firstrow"><!-- --></A>
  384. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
  385. <TR ALIGN="center" VALIGN="top">
  386. <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  387. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  388. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  389. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  390. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  391. </TR>
  392. </TABLE>
  393. </TD>
  394. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  395. </EM>
  396. </TD>
  397. </TR>
  398. <TR>
  399. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  400. &nbsp;PREV CLASS&nbsp;
  401. &nbsp;NEXT CLASS</FONT></TD>
  402. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  403. <A HREF="../../../../index.html" TARGET="_top"><B>FRAMES</B></A> &nbsp;
  404. &nbsp;<A HREF="Task.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
  405. </TR>
  406. <TR>
  407. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  408. SUMMARY: &nbsp;INNER&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  409. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  410. DETAIL: &nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  411. </TR>
  412. </TABLE>
  413. <!-- =========== END OF NAVBAR =========== -->
  414. <HR>
  415. </BODY>
  416. </HTML>