youys
/
ant
Not watched
1
0
Fork 1
Code
Releases 0 Wiki Activity
Issues 0 Pull Requests 0 Datasets Model Cloudbrain
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.
Tree: ec22350dec
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'ec22350dec'
${ noResults }
ant/docs/index.html

1556 lines
59 KiB
Raw Blame History 

  1. <html>

  2. 

  3. <head>

  4. <meta http-equiv="Content-Language" content="en-us">

  5. <meta name="GENERATOR" content="Microsoft FrontPage 4.0">

  6. <meta name="ProgId" content="FrontPage.Editor.Document">

  7. <title>Ant</title>

  8. </head>

  9. 

  10. <body>

  11. 

  12. <h1>Ant User Manual</h1>

  13. <p>by&nbsp;</p>

  14. <ul>

  15.   <li> Arnout J. Kuiper <a href="mailto:(ajkuiper@wxs.nl">(ajkuiper@wxs.nl</a>)</li>

  16.   <li>Stefano Mazzocchi <a href="mailto:(stefano@apache.org">(stefano@apache.org</a>)</li>

  17. </ul>

  18. <p>Version 1.0.2 - 2000/01/26</p>

  19. <hr>

  20. <h2>Table of Contents</h2>

  21. <ul>

  22.   <li><a href="#introduction">Introduction</a></li>

  23.   <li><a href="#getting">Getting Ant</a></li>

  24.   <li><a href="#buildingant">Building Ant</a></li>

  25.   <li><a href="#installing">Installing Ant</a></li>

  26.   <li><a href="#running">Running Ant</a></li>

  27.   <li><a href="#buildfile">Writing a simple buildfile</a>

  28.   <li><a href="#tasks">Built in Tasks</a>

  29.   <li><a href="#writingowntask">Writing your own task</a></li>

  30.   <li><a href="#license">License</a></li>

  31.   <li><a href="#feedback">Feedback</a></li>

  32. </ul>

  33. <hr>

  34. <h2><a name="introduction">Introduction</a></h2>

  35. <p>Ant is a Java based build tool. In theory it is kind of like make without

  36. makes wrinkles.</p>

  37. <h3>Why?</h3>

  38. <p>Why another build tool when there is already make, gnumake, nmake, jam, and

  39. others? Because all of those tools have limitations that its original author

  40. couldn't live with when developing software across multiple platforms. Make like

  41. tools are inherently shell based. They evaluate a set of dependencies and then

  42. execute commands not unlike what you would issue on a shell. This means that you

  43. can easily extend these tools by using or writing any program for the OS that

  44. you are working on. However, this also means that you limit yourself to the OS,

  45. or at least the OS type such as Unix, that you are working on.</p>

  46. <p>Makefiles are inherently evil as well. Anybody who has worked on them for any

  47. time has run into the dreaded tab problem. &quot;Is my command not executing

  48. because I have a space in front of my tab!!!&quot; said the original author of

  49. Ant way too many times. Tools like Jam took care of this to a great degree, but

  50. still use yet another format to use and remember.</p>

  51. <p>Ant is different. Instead a model where it is extended with shell based

  52. commands, it is extended using Java classes. Instead of writing shell commands,

  53. the configuration files are XML based calling out a target tree where various

  54. tasks get executed. Each task is run by an object which implements a particular

  55. Task interface.</p>

  56. <p>Granted, this removes some of the expressive power that is inherent by being

  57. able to construct a shell command such as `find . -name foo -exec rm {}` but it

  58. gives you the ability to be cross platform. To work anywhere and everywhere. And

  59. hey, if you really need to execute a shell command, Ant has an exec rule that

  60. allows different commands to be executed based on the OS that it is executing

  61. on.</p>

  62. <hr>

  63. <h2><a name="getting">Getting Ant</a></h2>

  64. <h3>Binary edition</h3>

  65. <p>The latest stable version of Ant can be downloaded from <a

  66. href="http://jakarta.apache.org/builds/tomcat/release/v3.0/ant.zip">http://jakarta.apache.org/builds/tomcat/release/v3.0/ant.zip</a>.

  67. If you like living on the edge, you can download the latest version from <a

  68. href="http://jakarta.apache.org/builds/tomcat/nightly/ant.zip">http://jakarta.apache.org/builds/tomcat/nightly/ant.zip</a>.</p>

  69. <h3>Source edition</h3>

  70. <p>If you prefer the source edition, you can download Ant from <a

  71. href="http://jakarta.apache.org/builds/tomcat/release/v3.0/src/jakarta-tools.src.zip">http://jakarta.apache.org/builds/tomcat/release/v3.0/src/jakarta-tools.src.zip</a>

  72. (latest stable) or from <a

  73. href="http://jakarta.apache.org/from-cvs/jakarta-tools/">http://jakarta.apache.org/from-cvs/jakarta-ant/</a>

  74. (current). See the section <a href="#buildingant">Building Ant</a> on how to

  75. build Ant from the source code.</p>

  76. <hr>

  77. <h2><a name="buildingant">Building Ant</a></h2>

  78. <p>Go to the directory <code>jakarta-ant</code>.</p>

  79. <p>Make sure the JDK is in you path.</p>

  80. <p>Run <code>bootstrap.bat</code> (Windows) or <code>bootstrap.sh</code> (UNIX)

  81. to build a bootstrap version of Ant.</p>

  82. <p>When finished, use</p>

  83. <blockquote>

  84. <p><code>build.bat -Ddist.dir=&lt;directory to install Ant&gt; dist</code></p>

  85. </blockquote>

  86. <p>for Windows, and</p>

  87. <blockquote>

  88. <p><code>build.sh -Ddist.dir=&lt;directory to install Ant&gt; dist</code></p>

  89. </blockquote>

  90. <p>for UNIX, to create a binary distribution of Ant. This distribution can be

  91. found in the directory you specified.</p>

  92. <hr>

  93. <h2><a name="installing">Installing Ant</a></h2>

  94. <p>The binary distribution of Ant consists of three directories: <code>bin</code>,

  95. <code>docs</code> and <code>lib</code>. Only the <code>bin</code> and <code>lib</code>

  96. directory are crucial for running Ant. To run Ant, the following must be done:</p>

  97. <ul>

  98.   <li>Add the <code>bin</code> directory to your path.</li>

  99.   <li>Set the ANT_HOME environment variable. This should be set to the directory

  100.     which contains the <code>bin</code> and <code>lib</code> directory.</li>

  101.   <li>Set the JAVA_HOME environment variable. This should be set to the

  102.     directory where the JDK is installed.</li>

  103. </ul>

  104. <h3>Windows</h3>

  105. <p>Assume Ant is installed in <code>c:\ant\</code>. The following sets up the

  106. environment:</p>

  107. <pre>set ANT_HOME=c:\ant

  108. set JAVA_HOME=c:\jdk1.2.2

  109. set PATH=%PATH%;%ANT_HOME%\bin</pre>

  110. <h3>Unix (bash)</h3>

  111. <p>Assume Ant is installed in <code>/usr/local/ant</code>. The following sets up

  112. the environment:</p>

  113. <pre>export ANT_HOME=/usr/local/ant

  114. export JAVA_HOME=/usr/local/jdk-1.2.2

  115. export PATH=${PATH}:${ANT_HOME}/bin</pre>

  116. <h3>Advanced</h3>

  117. <p>There are lots of variants that can be used to run Ant. What you need is at

  118. least the following:</p>

  119. <p>The classpath for Ant must contain <code>ant.jar</code> and <code>xml.jar</code>.</p>

  120. <p>When you need JDK functionality (like a <a href="#javac">javac</a> task, or a

  121. <a href="#rmic">rmic</a> task), then for JDK 1.1, the <code>classes.zip</code>

  122. file of the JDK must be added to the classpath; for JDK 1.2, <code>tools.jar</code>

  123. must be added.</p>

  124. <p>When you are executing platform specific applications (like the <a

  125. href="#exec">exec</a> task, or the <a href="#cvs">cvs</a> task), the property <code>ant.home</code>

  126. must be set to the directory containing a bin directory, which contains <code>antRun.bat</code>

  127. (Windows) or <code>antRun</code> (Unix).</p>

  128. <hr>

  129. <h2><a name="running">Running Ant</a></h2>

  130. <p>Running Ant is simple, when you installed it as described in the previous

  131. section. Just type <code>ant</code>.</p>

  132. <p>When nothing is specified, Ant looks for a <code>build.xml</code> file in the

  133. current directory. When found, it uses that file as a buildfile. To make Ant use

  134. another buildfile, use the commandline option <i>-buildfile &lt;file&gt;</i>,

  135. where <i>&lt;file&gt;</i> is the buildfile you want to use.</p>

  136. <p>You can also set properties which override properties specified in the

  137. buildfile. This can be done with the <i>-D&lt;property&gt;=&lt;value&gt;</i>

  138. option, where <i>&lt;property&gt;</i> is the name of the property and <i>&lt;value&gt;</i>

  139. the value.</p>

  140. <p>To more options are <i>-quiet</i> which instructs Ant to print less

  141. information on the console when running. The option <i>-verbose</i> on the other

  142. hand makes Ant print more information on the console.</p>

  143. <p>It is also possible to specify the target that should be executed. Default

  144. the target that is mentioned in the <i>default</i> attribute of the project is

  145. used. This can be overridden by adding the target name to the end of the

  146. commandline.</p>

  147. <p>Commandline option summary:</p>

  148. <pre>ant [options] [target]

  149. Options:

  150. -help                  print this message

  151. -quiet                 be extra quiet

  152. -verbose               be extra verbose

  153. -logfile &lt;file&gt;        use given file for log

  154. -buildfile &lt;file&gt;      use given buildfile

  155. -D&lt;property&gt;=&lt;value&gt;   use value for given property</pre>

  156. <h3>Examples</h3>

  157. <blockquote>

  158. <pre>ant</pre>

  159. </blockquote>

  160. <p>runs Ant using the <code>build.xml</code> file in the current directory, on

  161. the default target.</p>

  162. <blockquote>

  163. <pre>ant -buildfile test.xml</pre>

  164. </blockquote>

  165. <p>runs Ant using the <code>test.xml</code> file in the current directory, on

  166. the default target.</p>

  167. <blockquote>

  168. <pre>ant -buildfile test.xml dist</pre>

  169. </blockquote>

  170. <p>runs Ant using the <code>test.xml</code> file in the current directory, on a

  171. target called <code>dist</code>.</p>

  172. <blockquote>

  173. <pre>ant -buildfile test.xml -Dbuild=build/classes dist</pre>

  174. </blockquote>

  175. <p>runs Ant using the <code>test.xml</code> file in the current directory, on a

  176. target called <code>dist</code>. It also sets the <i>build</i> property to the

  177. value <i>build/classes</i>.</p>

  178. <h3>Running Ant by hand</h3>

  179. <p>When you have installed Ant in the do-it-yourself way, Ant can be started

  180. with:</p>

  181. <blockquote>

  182. <pre>set CLASSPATH=c:\ant\lib\ant.jar;c:\ant\lib\xml.jar;c:\jdk1.2.2\lib\tools.jar

  183. java -Dant.home=c:\ant org.apache.tools.ant.Main [options] [target]</pre>

  184. </blockquote>

  185. <p>These instructions actually do exactly the same as the <code>ant</code>

  186. command. The options and target are the same as when running Ant with the <code>ant</code>

  187. command.</p>

  188. <hr>

  189. <h2><a name="buildfile">Writing a simple buildfile</a></h2>

  190. <p>The buildfile is an written in XML. Each buildfile contains one project.</p>

  191. <h3>Projects</h3>

  192. <p>A project has three attributes:</p>

  193. <table border="1" cellpadding="2" cellspacing="0">

  194.   <tr>

  195.     <td valign="top"><b>Attribute</b></td>

  196.     <td valign="top"><b>Description</b></td>

  197.     <td align="center" valign="top"><b>Required</b></td>

  198.   </tr>

  199.   <tr>

  200.     <td valign="top">name</td>

  201.     <td valign="top">the name of the project.</td>

  202.     <td align="center" valign="top">Yes</td>

  203.   </tr>

  204.   <tr>

  205.     <td valign="top">default</td>

  206.     <td valign="top">the default target to use when no target is supplied.</td>

  207.     <td align="center" valign="top">Yes</td>

  208.   </tr>

  209.   <tr>

  210.     <td valign="top">basedir</td>

  211.     <td valign="top">the base directory from which all path calculations are

  212.       done. This attribute might be overridden by setting the &quot;basedir&quot;

  213.       property on forehand. When this is done, it might be ommitted in the

  214.       project tag.</td>

  215.     <td align="center" valign="top">Yes</td>

  216.   </tr>

  217. </table>

  218. <p>Each project defines one or more targets. A target is a set of tasks you want

  219. to be executed. When starting Ant, you can select which target you want to have

  220. executed. When no target is given, the project's default is used.</p>

  221. <h3>Targets</h3>

  222. <p>A target can depend on other targets. You might have a target for compiling,

  223. for instance, and a target for creating a distributable. You can only build a

  224. distributable when you have compiled first, so the distribute target depends on

  225. the compile target. Ant resolves all these dependencies.</p>

  226. <p>Ant tries to execute the targets in the <i>depends</i> attribute in the order

  227. they appear (from left to right). Keep in mind that it is possible that a target

  228. can get executed earlier when an earlier target depends on it:</p>

  229. <pre>&lt;target name=&quot;A&quot;/&gt;

  230. &lt;target name=&quot;B&quot; depends=&quot;A&quot;/&gt;

  231. &lt;target name=&quot;C&quot; depends=&quot;B&quot;/&gt;

  232. &lt;target name=&quot;D&quot; depends=&quot;C,B,A&quot;/&gt;</pre>

  233. <p>Suppose we want to execute target D. From its <i>depends</i> attribute, you

  234. might think that first target C, then B and then A is executed. Wrong! C depends

  235. on B, and B depends on A, so first A is executed, then B, then C, and finally D.</p>

  236. <p>In situations without such dependencies, you can rely on the order of the

  237. targets in the <i>depends</i> attributes.</p>

  238. <p>A target gets executed only once. Even when more targets depend on it (see

  239. the previous example).</p>

  240. <p>A target has the following attributes:</p>

  241. <table border="1" cellpadding="2" cellspacing="0">

  242.   <tr>

  243.     <td valign="top"><b>Attribute</b></td>

  244.     <td valign="top"><b>Description</b></td>

  245.     <td align="center" valign="top"><b>Required</b></td>

  246.   </tr>

  247.   <tr>

  248.     <td valign="top">name</td>

  249.     <td valign="top">the name of the project.</td>

  250.     <td align="center" valign="top">Yes</td>

  251.   </tr>

  252.   <tr>

  253.     <td valign="top">depends</td>

  254.     <td valign="top">a comma separated list of names of targets on which this

  255.       target depends.</td>

  256.     <td align="center" valign="top">No</td>

  257.   </tr>

  258. </table>

  259. <h3>Tasks</h3>

  260. <p>A task is a piece of code that can be executed.</p>

  261. <p>A task can have multiple attributes (or arguments if you prefer). The value

  262. of an attribute might contain references to a property. These references will be

  263. resolved before the task is executed.</p>

  264. <p>Tasks have a common structure:</p>

  265. <blockquote>

  266. <pre>&lt;name attribute1=&quot;value1&quot; attribute2=&quot;value2&quot; ... /&gt;</pre>

  267. </blockquote>

  268. <p>where name is the name of the task, attribute-x the attribute name, and

  269. value-x the value of this attribute.</p>

  270. <p>There is a set of <a href="#tasks">built in tasks</a>, but it is also very

  271. easy to <a href="#writingowntask">write your own</a>.</p>

  272. <h3>Properties</h3>

  273. <p>A project can have a set of properties. These might be set in the buildfile

  274. by the <a href="#property">property task</a>, or might be set outside Ant. A

  275. property has a name and a value. Properties might be used in in the value of

  276. task attributes. This is done by placing the property name between

  277. &quot;${&quot; and &quot;}&quot; in the attribute value.</p>

  278. <p>If there is a property called &quot;builddir&quot; with the value

  279. &quot;build&quot;, then this could be used in an attribute like this: &quot;${builddir}/classes&quot;.

  280. This is resolved as &quot;build/classes&quot;.</p>

  281. <h3>Examples</h3>

  282. <blockquote>

  283. <pre>&lt;project name=&quot;foo&quot; default=&quot;dist&quot; basedir=&quot;.&quot;&gt;

  284.   &lt;target name=&quot;init&quot;&gt;

  285.     &lt;tstamp/&gt;

  286.     &lt;property name=&quot;build&quot; value=&quot;build&quot; /&gt;

  287.     &lt;property name=&quot;dist&quot;  value=&quot;dist&quot; /&gt;

  288.   &lt;/target&gt;

  289. 

  290.   &lt;target name=&quot;prepare&quot; depends=&quot;init&quot;&gt;

  291.     &lt;mkdir dir=&quot;${build}&quot; /&gt;

  292.   &lt;/target&gt;

  293. 

  294.   &lt;target name=&quot;compile&quot; depends=&quot;prepare&quot;&gt;

  295.     &lt;javac srcdir=&quot;${src}&quot; destdir=&quot;${build}&quot; /&gt;

  296.   &lt;/target&gt;

  297. 

  298.   &lt;target name=&quot;dist&quot; depends=&quot;compile&quot;&gt;

  299.     &lt;mkdir dir=&quot;${dist}/lib&quot; /&gt;

  300.     &lt;jar jarfile=&quot;${dist}/lib/foo${DSTAMP}.jar&quot;

  301.      basedir=&quot;${build}&quot; items=&quot;com&quot;/&gt;

  302.   &lt;/target&gt;

  303. 

  304.   &lt;target name=&quot;clean&quot; depends=&quot;init&quot;&gt;

  305.     &lt;deltree dir=&quot;${build}&quot; /&gt;

  306.     &lt;deltree dir=&quot;${dist}&quot; /&gt;

  307.   &lt;/target&gt;

  308. &lt;/project&gt;

  309. </pre>

  310. </blockquote>

  311. <hr>

  312. <h2><a name="tasks">Built in tasks</a></h2>

  313. <ul>

  314.   <li><a href="#ant">Ant</a></li>

  315.   <li><a href="#chmod">Chmod</a></li>

  316.   <li><a href="#copydir">Copydir</a></li>

  317.   <li><a href="#copyfile">Copyfile</a></li>

  318.   <li><a href="#cvs">Cvs</a></li>

  319.   <li><a href="#delete">Delete</a></li>

  320.   <li><a href="#deltree">Deltree</a></li>

  321.   <li><a href="#echo">Echo</a></li>

  322.   <li><a href="#exec">Exec</a></li>

  323.   <li><a href="#expand">Expand</a></li>

  324.   <li><a href="#get">Get</a></li>

  325.   <li><a href="#gzip">GZip</a></li>

  326.   <li><a href="#jar">Jar</a></li>

  327.   <li><a href="#java">Java</a></li>

  328.   <li><a href="#javac">Javac</a></li>

  329.   <li><a href="#javadoc">Javadoc/Javadoc2</a></li>

  330.   <li><a href="#keysubst">KeySubst</a></li>

  331.   <li><a href="#mkdir">Mkdir</a></li>

  332.   <li><a href="#property">Property</a></li>

  333.   <li><a href="#replace">Replace</a></li>

  334.   <li><a href="#rmic">Rmic</a></li>

  335.   <li><a href="#taskdef">Taskdef</a></li>

  336.   <li><a href="#tstamp">Tstamp</a></li>

  337.   <li><a href="#zip">Zip</a></li>

  338. </ul>

  339. <hr>

  340. <h2><a name="ant">Ant</a></h2>

  341. <h3><b>Description:</b></h3>

  342. <p>Runs Ant on a supplied buildfile. This can be used to build subprojects.</p>

  343. <p>When the <i>antfile</i> attribute is omitted, the file &quot;build.xml&quot;

  344. in the supplied directory (<i>dir</i> attribute) is used.</p>

  345. <p>If no target attribute is supplied, the default target of the new project is

  346. used.</p>

  347. <p>The properties of the current project will be available in the new project.

  348. These properties will override the properties that are set in the new project.

  349. (See also the <a href="#property">properties task</a>).</p>

  350. <h3>Parameters:</h3>

  351. <table border="1" cellpadding="2" cellspacing="0">

  352.   <tr>

  353.     <td valign="top"><b>Attribute</b></td>

  354.     <td valign="top"><b>Description</b></td>

  355.     <td align="center" valign="top"><b>Required</b></td>

  356.   </tr>

  357.   <tr>

  358.     <td valign="top">antfile</td>

  359.     <td valign="top">the buildfile to use.</td>

  360.     <td valign="top" align="center">No</td>

  361.   </tr>

  362.   <tr>

  363.     <td valign="top">dir</td>

  364.     <td valign="top">the directory to use as a basedir for the new Ant project.</td>

  365.     <td valign="top" align="center">Yes</td>

  366.   </tr>

  367.   <tr>

  368.     <td valign="top">target</td>

  369.     <td valign="top">the target of the new Ant project that should be executed.</td>

  370.     <td valign="top" align="center">No</td>

  371.   </tr>

  372. </table>

  373. <h3>Examples</h3>

  374. <blockquote>

  375. <p><code>&lt;ant antfile=&quot;subproject/subbuild.xml&quot; dir=&quot;subproject&quot;

  376. target=&quot;compile&quot; /&gt;</code></p>

  377. <p><code>&lt;ant dir=&quot;subproject&quot; /&gt;</code></p>

  378. </blockquote>

  379. <hr>

  380. <h2><a name="chmod">Chmod</a></h2>

  381. <h3>Description</h3>

  382. <p>Changes the permissions of a file. Right now it has efect only under Unix.

  383. The permissions are also UNIX style, like the argument for the chmod command.</p>

  384. <h3>Parameters</h3>

  385. <table border="1" cellpadding="2" cellspacing="0">

  386.   <tr>

  387.     <td valign="top"><b>Attribute</b></td>

  388.     <td valign="top"><b>Description</b></td>

  389.     <td align="center" valign="top"><b>Required</b></td>

  390.   </tr>

  391.   <tr>

  392.     <td valign="top">src</td>

  393.     <td valign="top">the file of which the permissions must be changed.</td>

  394.     <td valign="top" align="center">Yes</td>

  395.   </tr>

  396.   <tr>

  397.     <td valign="top">perm</td>

  398.     <td valign="top">the new permissions.</td>

  399.     <td valign="top" align="center">Yes</td>

  400.   </tr>

  401. </table>

  402. <h3>Examples</h3>

  403. <blockquote>

  404. <p><code>&lt;chmod src=&quot;${dist}/start.sh&quot; perm=&quot;ugo+rx&quot;

  405. /&gt;</code></p>

  406. </blockquote>

  407. <p>makes the &quot;start.sh&quot; file readable and executable for anyone on a

  408. UNIX system.</p>

  409. <hr>

  410. <h2><a name="copydir">Copydir</a></h2>

  411. <h3>Description</h3>

  412. <p>Copies a directory tree from the source to the destination.</p>

  413. <p>It is possible to exclude a set of files from the files that are being

  414. copied. This can be done with the <i>ignore</i> attribute. This attribute

  415. contains the names of the files/directories that must be excluded from the copy.

  416. The names specified in the <i>ignore</i> attribute are just names, they do not

  417. contain any path information!</p>

  418. <h3>Parameters</h3>

  419. <table border="1" cellpadding="2" cellspacing="0">

  420.   <tr>

  421.     <td valign="top"><b>Attribute</b></td>

  422.     <td valign="top"><b>Description</b></td>

  423.     <td align="center" valign="top"><b>Required</b></td>

  424.   </tr>

  425.   <tr>

  426.     <td valign="top">src</td>

  427.     <td valign="top">the directory to copy.</td>

  428.     <td valign="top" align="center">Yes</td>

  429.   </tr>

  430.   <tr>

  431.     <td valign="top">dest</td>

  432.     <td valign="top">the directory to copy to.</td>

  433.     <td valign="top" align="center">Yes</td>

  434.   </tr>

  435.   <tr>

  436.     <td valign="top">ignore</td>

  437.     <td valign="top">comma separated list of filenames/directorynames to ignore.</td>

  438.     <td valign="top" align="center">No</td>

  439.   </tr>

  440. </table>

  441. <h3>Examples</h3>

  442. <blockquote>

  443. <p><code>&lt;copydir src=&quot;${src}/resources&quot; dest=&quot;${dist}&quot;

  444. /&gt;</code></p>

  445. </blockquote>

  446. <p>copies the directory <code>${src}/resources</code> to <code>${dist}</code>.</p>

  447. <blockquote>

  448. <p><code>&lt;copydir src=&quot;${src}/resources&quot; dest=&quot;${dist}&quot;

  449. ignore=&quot;old, Test.java&quot; /&gt;</code></p>

  450. </blockquote>

  451. <p>copies the directory <code>${src}/resources</code> to <code>${dist}</code>.

  452. All files/directories with the names <code>old</code> and <code>Test.java</code>

  453. are excluded from the copy. When <code>old</code> or <code>Test.java</code> is

  454. the name of a directory, then that whole directory is excluded from the copy.</p>

  455. <hr>

  456. <h2><a name="copyfile">Copyfile</a></h2>

  457. <h3>Description</h3>

  458. <p>Copies a file from the source to the destination. The file is only copied if

  459. the source file is newer than the destination file, or when the destination file

  460. does not exist.</p>

  461. <h3>Parameters</h3>

  462. <table border="1" cellpadding="2" cellspacing="0">

  463.   <tr>

  464.     <td valign="top"><b>Attribute</b></td>

  465.     <td valign="top"><b>Description</b></td>

  466.     <td align="center" valign="top"><b>Required</b></td>

  467.   </tr>

  468.   <tr>

  469.     <td valign="top">src</td>

  470.     <td valign="top">the filename of the file to copy.</td>

  471.     <td valign="top" align="center">Yes</td>

  472.   </tr>

  473.   <tr>

  474.     <td valign="top">dest</td>

  475.     <td valign="top">the filename of the file where to copy to.</td>

  476.     <td valign="top" align="center">Yes</td>

  477.   </tr>

  478. </table>

  479. <h3>Examples</h3>

  480. <blockquote>

  481. <p><code>&lt;copyfile src=&quot;test.java&quot; dest=&quot;subdir/test.java&quot;

  482. /&gt;</code></p>

  483. <p><code>&lt;copyfile src=&quot;${src}/index.html&quot; dest=&quot;${dist}/help/index.html&quot;

  484. /&gt;</code></p>

  485. </blockquote>

  486. <hr>

  487. <h2><a name="cvs">Cvs</a></h2>

  488. <h3>Description</h3>

  489. <p>Checks out a package/module from a <a href="http://www.cyclic.com/">CVS</a>

  490. repository.</p>

  491. <p>When doing automated builds, the <a href="#get">get task</a> should be

  492. preferred, because of speed.</p>

  493. <h3>Parameters</h3>

  494. <table border="1" cellpadding="2" cellspacing="0">

  495.   <tr>

  496.     <td valign="top"><b>Attribute</b></td>

  497.     <td valign="top"><b>Description</b></td>

  498.     <td align="center" valign="top"><b>Required</b></td>

  499.   </tr>

  500.   <tr>

  501.     <td valign="top">cvsRoot</td>

  502.     <td valign="top">the CVSROOT variable.</td>

  503.     <td align="center" valign="top">Yes</td>

  504.   </tr>

  505.   <tr>

  506.     <td valign="top">dest</td>

  507.     <td valign="top">the directory where the checked out files should be placed.</td>

  508.     <td align="center" valign="top">Yes</td>

  509.   </tr>

  510.   <tr>

  511.     <td valign="top">package</td>

  512.     <td valign="top">the package/module to check out.</td>

  513.     <td align="center" valign="top">Yes</td>

  514.   </tr>

  515.   <tr>

  516.     <td valign="top">tag</td>

  517.     <td valign="top">the tag of the package/module to check out.</td>

  518.     <td align="center" valign="top">No</td>

  519.   </tr>

  520. </table>

  521. <h3>Examples</h3>

  522. <blockquote>

  523. <p><code>&lt;cvs cvsRoot=&quot;:pserver:anoncvs@jakarta.apache.org:/home/cvspublic&quot;

  524. package=&quot;jakarta-tools&quot; dest=&quot;${ws.dir}&quot; /&gt;</code></p>

  525. </blockquote>

  526. <p>This checks out the package/module &quot;jakarta-tools&quot; from the CVS

  527. repository pointed to by the cvsRoot attribute, and stores the files in &quot;${ws.dir}&quot;.</p>

  528. <hr>

  529. <h2><a name="delete">Delete</a></h2>

  530. <h3>Description</h3>

  531. <p>Deletes a single file.</p>

  532. <h3>Parameters</h3>

  533. <table border="1" cellpadding="2" cellspacing="0">

  534.   <tr>

  535.     <td valign="top"><b>Attribute</b></td>

  536.     <td valign="top"><b>Description</b></td>

  537.     <td align="center" valign="top"><b>Required</b></td>

  538.   </tr>

  539.   <tr>

  540.     <td valign="top">file</td>

  541.     <td valign="top">the file to delete.</td>

  542.     <td valign="top" align="center">Yes</td>

  543.   </tr>

  544. </table>

  545. <h3>Examples</h3>

  546. <blockquote>

  547. <p><code>&lt;delete file=&quot;/lib/ant.jar&quot; /&gt;</code></p>

  548. <p><code>&lt;delete file=&quot;${ant}&quot; /&gt;</code></p>

  549. </blockquote>

  550. <hr>

  551. <h2><a name="deltree">Deltree</a></h2>

  552. <h3>Description</h3>

  553. <p>Deletes a directory with all its files and subdirectories.</p>

  554. <h3>Parameters</h3>

  555. <table border="1" cellpadding="2" cellspacing="0">

  556.   <tr>

  557.     <td valign="top"><b>Attribute</b></td>

  558.     <td valign="top"><b>Description</b></td>

  559.     <td align="center" valign="top"><b>Required</b></td>

  560.   </tr>

  561.   <tr>

  562.     <td valign="top">dir</td>

  563.     <td valign="top">the directory to delete.</td>

  564.     <td valign="top" align="center">Yes</td>

  565.   </tr>

  566. </table>

  567. <h3>Examples</h3>

  568. <blockquote>

  569. <p><code>&lt;deltree dir=&quot;dist&quot; /&gt;</code></p>

  570. <p><code>&lt;deltree dir=&quot;${dist}&quot; /&gt;</code></p>

  571. </blockquote>

  572. <hr>

  573. <h2><a name="echo">Echo</a></h2>

  574. <h3>Description</h3>

  575. <p>Echoes a message to System.out.</p>

  576. <h3>Parameters</h3>

  577. <table border="1" cellpadding="2" cellspacing="0">

  578.   <tr>

  579.     <td valign="top"><b>Attribute</b></td>

  580.     <td valign="top"><b>Description</b></td>

  581.     <td align="center" valign="top"><b>Required</b></td>

  582.   </tr>

  583.   <tr>

  584.     <td valign="top">message</td>

  585.     <td valign="top">the message to echo.</td>

  586.     <td valign="top" align="center">Yes</td>

  587.   </tr>

  588. </table>

  589. <h3>Examples</h3>

  590. <blockquote>

  591. <p><code>&lt;echo message=&quot;Hello world&quot; /&gt;</code></p>

  592. </blockquote>

  593. <hr>

  594. <h2><a name="exec">Exec</a></h2>

  595. <h3>Description</h3>

  596. <p>Executes a system command. When the <i>os</i> attribute is specified, then

  597. the command is only executed when Ant is run on one of the specified operating

  598. systems.</p>

  599. <h3>Parameters</h3>

  600. <table border="1" cellpadding="2" cellspacing="0">

  601.   <tr>

  602.     <td valign="top"><b>Attribute</b></td>

  603.     <td valign="top"><b>Description</b></td>

  604.     <td align="center" valign="top"><b>Required</b></td>

  605.   </tr>

  606.   <tr>

  607.     <td valign="top">command</td>

  608.     <td valign="top">the command to execute.</td>

  609.     <td align="center" valign="top">Yes</td>

  610.   </tr>

  611.   <tr>

  612.     <td valign="top">dir</td>

  613.     <td valign="top">the directory in which the command should be executed.</td>

  614.     <td align="center" valign="top">Yes</td>

  615.   </tr>

  616.   <tr>

  617.     <td valign="top">os</td>

  618.     <td valign="top">list of Operating Systems on which the command may be

  619.       executed.</td>

  620.     <td align="center" valign="top">No</td>

  621.   </tr>

  622.   <tr>

  623.     <td valign="top">output</td>

  624.     <td valign="top">the file to which the output of the command should be

  625.       redirected.</td>

  626.     <td align="center" valign="top">Yes</td>

  627.   </tr>

  628. </table>

  629. <h3>Examples</h3>

  630. <blockquote>

  631. <p><code>&lt;exec dir=&quot;${src}&quot; command=&quot;dir&quot; os=&quot;windows&quot;

  632. output=&quot;dir.txt&quot; /&gt;</code></p>

  633. </blockquote>

  634. <hr>

  635. <h2><a name="expand">Expand</a></h2>

  636. <h3>Description</h3>

  637. <p>Unzips a zipfile.</p>

  638. <h3>Parameters</h3>

  639. <table border="1" cellpadding="2" cellspacing="0">

  640.   <tr>

  641.     <td valign="top"><b>Attribute</b></td>

  642.     <td valign="top"><b>Description</b></td>

  643.     <td align="center" valign="top"><b>Required</b></td>

  644.   </tr>

  645.   <tr>

  646.     <td valign="top">src</td>

  647.     <td valign="top">zipfile to expand.</td>

  648.     <td align="center" valign="top">Yes</td>

  649.   </tr>

  650.   <tr>

  651.     <td valign="top">dest</td>

  652.     <td valign="top">directory where to store the expanded files.</td>

  653.     <td align="center" valign="top">Yes</td>

  654.   </tr>

  655. </table>

  656. <h3>Examples</h3>

  657. <blockquote>

  658. <p><code>&lt;expand src=&quot;${tomcat_src}/tools-src.zip&quot; dest=&quot;${tools.home}&quot;

  659. /&gt;</code></p>

  660. </blockquote>

  661. <hr>

  662. <h2><a name="get">Get</a></h2>

  663. <h3>Description</h3>

  664. <p>Gets a file from an URL. When the verbose option is &quot;on&quot;, this task

  665. displays a '.' for every 100 Kb retrieved.</p>

  666. <p>This task should be preferred above the <a href="#cvs">CVS task</a> when

  667. doing automated builds. CVS is significant slower than loading a compressed

  668. archive with http/ftp.</p>

  669. <h3>Parameters</h3>

  670. <table border="1" cellpadding="2" cellspacing="0">

  671.   <tr>

  672.     <td valign="top"><b>Attribute</b></td>

  673.     <td valign="top"><b>Description</b></td>

  674.     <td align="center" valign="top"><b>Required</b></td>

  675.   </tr>

  676.   <tr>

  677.     <td valign="top">src</td>

  678.     <td valign="top">the URL from which to retrieve a file.</td>

  679.     <td align="center" valign="top">Yes</td>

  680.   </tr>

  681.   <tr>

  682.     <td valign="top">dest</td>

  683.     <td valign="top">the file where to store the retrieved file.</td>

  684.     <td align="center" valign="top">Yes</td>

  685.   </tr>

  686.   <tr>

  687.     <td valign="top">verbose</td>

  688.     <td valign="top">show verbose information (&quot;on&quot;/&quot;off&quot;).</td>

  689.     <td align="center" valign="top">No</td>

  690.   </tr>

  691. </table>

  692. <h3>Examples</h3>

  693. <blockquote>

  694. <p><code>&lt;get src=&quot;http://jakarta.apache.org/&quot; dest=&quot;help/index.html&quot;

  695. /&gt;</code></p>

  696. </blockquote>

  697. <hr>

  698. <h2><a name="gzip">GZip</a></h2>

  699. <h3>Description</h3>

  700. <p>GZips a file.</p>

  701. <h3>Parameters</h3>

  702. <table border="1" cellpadding="2" cellspacing="0">

  703.   <tr>

  704.     <td valign="top"><b>Attribute</b></td>

  705.     <td valign="top"><b>Description</b></td>

  706.     <td align="center" valign="top"><b>Required</b></td>

  707.   </tr>

  708.   <tr>

  709.     <td valign="top">src</td>

  710.     <td valign="top">the file to gzip.</td>

  711.     <td align="center" valign="top">Yes</td>

  712.   </tr>

  713.   <tr>

  714.     <td valign="top">zipfile</td>

  715.     <td valign="top">the destination file.</td>

  716.     <td align="center" valign="top">Yes</td>

  717.   </tr>

  718. </table>

  719. <h3>Examples</h3>

  720. <blockquote>

  721. <p><code>&lt;gzip src=&quot;test.tar&quot; zipfile=&quot;test.tar.gz&quot; /&gt;</code></p>

  722. </blockquote>

  723. <hr>

  724. <h2><a name="jar">Jar</a></h2>

  725. <h3>Description</h3>

  726. <p>Jars a set of files.</p>

  727. <p>The <i>basedir</i> attribute is the reference directory from where to jar.</p>

  728. <p>When &quot;*&quot; is used for items, all files in the basedir, and its

  729. subdirectories, will be jarred. Otherwise all the files and directories

  730. mentioned in the items list will jarred. When a directory is specified, then all

  731. files within it are also jarred.</p>

  732. <p>With the <i>ignore</i> attribute, you can specify files or directories to

  733. ignore. These files will not be jarred. The items in the <i>ignore</i> attribute

  734. override the items in the <i>items</i> attribute. The names specified in the <i>ignore</i>

  735. attribute are just names, they do not contain any path information!</p>

  736. <h3>Parameters</h3>

  737. <table border="1" cellpadding="2" cellspacing="0">

  738.   <tr>

  739.     <td valign="top"><b>Attribute</b></td>

  740.     <td valign="top"><b>Description</b></td>

  741.     <td align="center" valign="top"><b>Required</b></td>

  742.   </tr>

  743.   <tr>

  744.     <td valign="top">jarfile</td>

  745.     <td valign="top">the jar-file to create.</td>

  746.     <td valign="top" align="center">Yes</td>

  747.   </tr>

  748.   <tr>

  749.     <td valign="top">basedir</td>

  750.     <td valign="top">the directory from which to jar the files.</td>

  751.     <td valign="top" align="center">Yes</td>

  752.   </tr>

  753.   <tr>

  754.     <td valign="top">items</td>

  755.     <td valign="top">a comma separated list of the files/directories to jar.</td>

  756.     <td valign="top" align="center">Yes</td>

  757.   </tr>

  758.   <tr>

  759.     <td valign="top">ignore</td>

  760.     <td valign="top">a comma separated list of the filenames/directorynames to

  761.       exclude from the jar.</td>

  762.     <td valign="top" align="center">No</td>

  763.   </tr>

  764.   <tr>

  765.     <td valign="top">manifest</td>

  766.     <td valign="top">the manifest file to use.</td>

  767.     <td valign="top" align="center">No</td>

  768.   </tr>

  769. </table>

  770. <h3>Examples</h3>

  771. <blockquote>

  772. <p><code>&lt;jar jarfile=&quot;${dist}/lib/app.jar&quot; basedir=&quot;${build}/classes&quot;

  773. items=&quot;*&quot; /&gt;</code></p>

  774. </blockquote>

  775. <p>jars all files in the <code>${build}/classes</code> directory in a file

  776. called <code>app.jar</code> in the <code>${dist}/lib</code> directory.</p>

  777. <blockquote>

  778. <p><code>&lt;jar jarfile=&quot;${dist}/lib/app.jar&quot; basedir=&quot;${build}/classes&quot;

  779. items=&quot;*&quot; ignore=&quot;Test.class&quot; /&gt;</code></p>

  780. </blockquote>

  781. <p>jars all files in the <code>${build}/classes</code> directory in a file

  782. called <code>app.jar</code> in the <code>${dist}/lib</code> directory.

  783. Files/directories with the name <code>Test.class</code> are excluded.</p>

  784. <hr>

  785. <h2><a name="java">Java</a></h2>

  786. <h3>Description</h3>

  787. <p>Executes a Java class within the running (Ant) VM or forks another VM if

  788. specified.</p>

  789. <p>Be careful that the executed class doesn't call System.exit(), because it

  790. will terminate the VM and thus Ant. In case this happens, it's highly suggested

  791. that you set the fork attribute so that System.exit() stops the other VM and not

  792. the one that is currently running Ant.</p>

  793. <h3>Parameters</h3>

  794. <table border="1" cellpadding="2" cellspacing="0">

  795.   <tr>

  796.     <td valign="top"><b>Attribute</b></td>

  797.     <td valign="top"><b>Description</b></td>

  798.     <td align="center" valign="top"><b>Required</b></td>

  799.   </tr>

  800.   <tr>

  801.     <td valign="top">class</td>

  802.     <td valign="top">the Java class to execute.</td>

  803.     <td align="center" valign="top">Yes</td>

  804.   </tr>

  805.   <tr>

  806.     <td valign="top">args</td>

  807.     <td valign="top">the arguments for the class that is executed.</td>

  808.     <td align="center" valign="top">No</td>

  809.   </tr>

  810.   <tr>

  811.     <td valign="top">fork</td>

  812.     <td valign="top">if enabled triggers the class execution in another VM

  813.       (disabled by default)</td>

  814.     <td align="center" valign="top">No</td>

  815.   </tr>

  816.   <tr>

  817.     <td valign="top">jvmargs</td>

  818.     <td valign="top">the arguments to pass to the forked VM (ignored if fork is

  819.       disabled)</td>

  820.     <td align="center" valign="top">No</td>

  821.   </tr>

  822. </table>

  823. <h3>Examples</h3>

  824. <blockquote>

  825. <p><code>&lt;java class=&quot;test.Main&quot; /&gt;</code></p>

  826. <p><code>&lt;java class=&quot;test.Main&quot; args=&quot;-h&quot; /&gt;</code></p>

  827. <p><code>&lt;java class=&quot;test.Main&quot; args=&quot;-h&quot;

  828. fork=&quot;yes&quot; jvmargs=&quot;-Xrunhprof:cpu=samples,file=log.txt,depth=3&quot;

  829. /&gt;</code></p>

  830. </blockquote>

  831. <hr>

  832. <h2><a name="javac">Javac</a></h2>

  833. <h3>Description</h3>

  834. <p>Compiles a source tree within the running (Ant) VM.</p>

  835. <p>The source and destination directory will be recursively scanned for Java

  836. source files to compile. Only Java files that have no corresponding class file

  837. or where the class file is older than the java file will be compiled.</p>

  838. <p>Files in the source tree, that are no java files, are copied to the

  839. destination directory, allowing support files to be located properly in the

  840. classpath.</p>

  841. <p>The directory structure of the source tree should follow the package

  842. hierarchy.</p>

  843. <p>It is possible to use different compilers. This can be selected with the

  844. &quot;build.compiler&quot; property. There are three choices:</p>

  845. <ul>

  846.   <li>classic (the standard compiler of JDK 1.1/1.2)</li>

  847.   <li>modern (the new compiler of JDK 1.3)</li>

  848.   <li>jikes (the <a

  849.     href="http://oss.software.ibm.com/developerworks/opensource/jikes/project">Jikes</a>

  850.     compiler)</li>

  851. </ul>

  852. <p>For JDK 1.1/1.2 is classic the default. For JDK 1.3 is modern the default.</p>

  853. <h3>Parameters</h3>

  854. <table border="1" cellpadding="2" cellspacing="0">

  855.   <tr>

  856.     <td valign="top"><b>Attribute</b></td>

  857.     <td valign="top"><b>Description</b></td>

  858.     <td align="center" valign="top"><b>Required</b></td>

  859.   </tr>

  860.   <tr>

  861.     <td valign="top">srcdir</td>

  862.     <td valign="top">location of the java files.</td>

  863.     <td align="center" valign="top">Yes</td>

  864.   </tr>

  865.   <tr>

  866.     <td valign="top">destdir</td>

  867.     <td valign="top">location where to store the class files.</td>

  868.     <td align="center" valign="top">Yes</td>

  869.   </tr>

  870.   <tr>

  871.     <td valign="top">classpath</td>

  872.     <td valign="top">the classpath to use.</td>

  873.     <td align="center" valign="top">No</td>

  874.   </tr>

  875.   <tr>

  876.     <td valign="top">bootclasspath</td>

  877.     <td valign="top">location of bootstrap class files.</td>

  878.     <td align="center" valign="top">No</td>

  879.   </tr>

  880.   <tr>

  881.     <td valign="top">extdirs</td>

  882.     <td valign="top">location of installed extensions.</td>

  883.     <td align="center" valign="top">No</td>

  884.   </tr>

  885.   <tr>

  886.     <td valign="top">debug</td>

  887.     <td valign="top">indicates whether there should be compiled with debug

  888.       information (&quot;on&quot;).</td>

  889.     <td align="center" valign="top">No</td>

  890.   </tr>

  891.   <tr>

  892.     <td valign="top">optimize</td>

  893.     <td valign="top">indicates whether there should be compiled with

  894.       optimization (&quot;on&quot;).</td>

  895.     <td align="center" valign="top">No</td>

  896.   </tr>

  897.   <tr>

  898.     <td valign="top">deprecation</td>

  899.     <td valign="top">indicates whether there should be compiled with deprecation

  900.       information (&quot;on&quot;).</td>

  901.     <td align="center" valign="top">No</td>

  902.   </tr>

  903. </table>

  904. <h3>Examples</h3>

  905. <blockquote>

  906. <p><code>&lt;javac srcdir=&quot;${src}&quot; destdir=&quot;${build}&quot; -classpath=&quot;xyz.jar&quot;

  907. -debug=&quot;on&quot; /&gt;</code></p>

  908. </blockquote>

  909. <hr>

  910. <h2><a name="javadoc">Javadoc/Javadoc2</a></h2>

  911. <h3>Description</h3>

  912. <p>Generates code documentation using the javadoc tool.</p>

  913. <p>The source directory will be recursively scanned for Java

  914. source files to but only those matching the inclusion rules will be passed to

  915. the javadoc tool. This allows wildcards to be used to choose between package

  916. names, reducing verbosity and management costs over time. This task, however,

  917. has no notion of &quot;changed&quot; files, unlike the <a href="#javac">javac</a>

  918. task, but it's not used so frequently.</p>

  919. <p>This task works seamlessly between different javadoc versions (1.1 and 1.2),

  920. with the obvious restriction that the 1.2 attributes will be ignored if run in a

  921. 1.1 VM.</p>

  922. <p>NOTE: since javadoc calls System.exit(), we cannot run javadoc inside the

  923. same VM without breaking functionality. For this reason, this task always forks

  924. the VM. But this is not a performance penalty since javadoc is normally a heavy

  925. application and must be called just once.</p>

  926. <p>DEPRECATION: the javadoc2 task simply points to the javadoc task and it's

  927. there for back compatibility reasons. Since this task will be removed in future

  928. versions, you are strongly encouraged to use <a href="#javadoc">javadoc</a>

  929. instead.</p>

  930. <h3>Parameters</h3>

  931. <table border="1" cellpadding="2" cellspacing="0">

  932.   <tr>

  933.     <td valign="top"><b>Attribute</b></td>

  934.     <td valign="top"><b>Description</b></td>

  935.     <td align="center" valign="top"><b>Availability</b></td>

  936.     <td align="center" valign="top"><b>Required</b></td>

  937.   </tr>

  938.   <tr>

  939.     <td valign="top">sourcepath</td>

  940.     <td valign="top">Specify where to find source files</td>

  941.     <td align="center" valign="top">all</td>

  942.     <td align="center" valign="top">yes</td>

  943.   </tr>

  944.   <tr>

  945.     <td valign="top">destdir</td>

  946.     <td valign="top">Destination directory for output files</td>

  947.     <td align="center" valign="top">all</td>

  948.     <td align="center" valign="top">yes</td>

  949.   </tr>

  950.   <tr>

  951.     <td valign="top">sourcefiles</td>

  952.     <td valign="top">Space separated list of source files</td>

  953.     <td align="center" valign="top">all</td>

  954.     <td align="center" valign="middle" rowspan="2">at least one of the two</td>

  955.   </tr>

  956.   <tr>

  957.     <td valign="top">packagenames</td>

  958.     <td valign="top">Space separated list of package files (with terminating

  959.       wildcard)</td>

  960.     <td align="center" valign="top">all</td>

  961.   </tr>

  962.   <tr>

  963.     <td valign="top">Classpath</td>

  964.     <td valign="top">Specify where to find user class files</td>

  965.     <td align="center" valign="top">all</td>

  966.     <td align="center" valign="top">no</td>

  967.   </tr>

  968.   <tr>

  969.     <td valign="top">Bootclasspath</td>

  970.     <td valign="top">Override location of class files loaded by the bootstrap class loader</td>

  971.     <td align="center" valign="top">1.2</td>

  972.     <td align="center" valign="top">no</td>

  973.   </tr>

  974.   <tr>

  975.     <td valign="top">Extdirs</td>

  976.     <td valign="top">Override location of installed extensions</td>

  977.     <td align="center" valign="top">1.2</td>

  978.     <td align="center" valign="top">no</td>

  979.   </tr>

  980.   <tr>

  981.     <td valign="top">Overview</td>

  982.     <td valign="top">Read overview documentation from HTML file</td>

  983.     <td align="center" valign="top">1.2</td>

  984.     <td align="center" valign="top">no</td>

  985.   </tr>

  986.   <tr>

  987.     <td valign="top">Public</td>

  988.     <td valign="top">Show only public classes and members</td>

  989.     <td align="center" valign="top">all</td>

  990.     <td align="center" valign="top">no</td>

  991.   </tr>

  992.   <tr>

  993.     <td valign="top">Protected</td>

  994.     <td valign="top">Show protected/public classes and members (default)</td>

  995.     <td align="center" valign="top">all</td>

  996.     <td align="center" valign="top">no</td>

  997.   </tr>

  998.   <tr>

  999.     <td valign="top">Package</td>

  1000.     <td valign="top">Show package/protected/public classes and members</td>

  1001.     <td align="center" valign="top">all</td>

  1002.     <td align="center" valign="top">no</td>

  1003.   </tr>

  1004.   <tr>

  1005.     <td valign="top">Private</td>

  1006.     <td valign="top">Show all classes and members</td>

  1007.     <td align="center" valign="top">all</td>

  1008.     <td align="center" valign="top">no</td>

  1009.   </tr>

  1010.   <tr>

  1011.     <td valign="top">Old</td>

  1012.     <td valign="top">Generate output using JDK 1.1 emulating doclet</td>

  1013.     <td align="center" valign="top">1.2</td>

  1014.     <td align="center" valign="top">no</td>

  1015.   </tr>

  1016.   <tr>

  1017.     <td valign="top">Verbose</td>

  1018.     <td valign="top">Output messages about what Javadoc is doing</td>

  1019.     <td align="center" valign="top">1.2</td>

  1020.     <td align="center" valign="top">no</td>

  1021.   </tr>

  1022.   <tr>

  1023.     <td valign="top">Locale</td>

  1024.     <td valign="top">Locale to be used, e.g. en_US or en_US_WIN</td>

  1025.     <td align="center" valign="top">1.2</td>

  1026.     <td align="center" valign="top">no</td>

  1027.   </tr>

  1028.   <tr>

  1029.     <td valign="top">Encoding</td>

  1030.     <td valign="top">Source file encoding name</td>

  1031.     <td align="center" valign="top">all</td>

  1032.     <td align="center" valign="top">no</td>

  1033.   </tr>

  1034.   <tr>

  1035.     <td valign="top">Version</td>

  1036.     <td valign="top">Include @version paragraphs</td>

  1037.     <td align="center" valign="top">all</td>

  1038.     <td align="center" valign="top">no</td>

  1039.   </tr>

  1040.   <tr>

  1041.     <td valign="top">Use</td>

  1042.     <td valign="top">Create class and package usage pages</td>

  1043.     <td align="center" valign="top">1.2</td>

  1044.     <td align="center" valign="top">no</td>

  1045.   </tr>

  1046.   <tr>

  1047.     <td valign="top">Author</td>

  1048.     <td valign="top">Include @author paragraphs</td>

  1049.     <td align="center" valign="top">all</td>

  1050.     <td align="center" valign="top">no</td>

  1051.   </tr>

  1052.   <tr>

  1053.     <td valign="top">Splitindex</td>

  1054.     <td valign="top"> Split index into one file per letter</td>

  1055.     <td align="center" valign="top">1.2</td>

  1056.     <td align="center" valign="top">no</td>

  1057.   </tr>

  1058.   <tr>

  1059.     <td valign="top">Windowtitle</td>

  1060.     <td valign="top">Browser window title for the documenation (text)</td>

  1061.     <td align="center" valign="top">1.2</td>

  1062.     <td align="center" valign="top">no</td>

  1063.   </tr>

  1064.   <tr>

  1065.     <td valign="top">Doctitle</td>

  1066.     <td valign="top">     Include title for the package index(first) page

  1067.       (html-code)</td>

  1068.     <td align="center" valign="top">1.2</td>

  1069.     <td align="center" valign="top">no</td>

  1070.   </tr>

  1071.   <tr>

  1072.     <td valign="top">Header</td>

  1073.     <td valign="top">       Include header text for each page (html-code)</td>

  1074.     <td align="center" valign="top">1.2</td>

  1075.     <td align="center" valign="top">no</td>

  1076.   </tr>

  1077.   <tr>

  1078.     <td valign="top">Footer</td>

  1079.     <td valign="top">       Include footer text for each page (html-code)</td>

  1080.     <td align="center" valign="top">1.2</td>

  1081.     <td align="center" valign="top">no</td>

  1082.   </tr>

  1083.   <tr>

  1084.     <td valign="top">bottom</td>

  1085.     <td valign="top">       Include bottom text for each page (html-code)</td>

  1086.     <td align="center" valign="top">1.2</td>

  1087.     <td align="center" valign="top">no</td>

  1088.   </tr>

  1089.   <tr>

  1090.     <td valign="top">link</td>

  1091.     <td valign="top">               Create links to javadoc output at the given

  1092.       URL</td>

  1093.     <td align="center" valign="top">1.2</td>

  1094.     <td align="center" valign="top">no</td>

  1095.   </tr>

  1096.   <tr>

  1097.     <td valign="top">linkoffline</td>

  1098.     <td valign="top"> Link to docs at &lt;url&gt; using package list at &lt;url2></td>

  1099.     <td align="center" valign="top">1.2</td>

  1100.     <td align="center" valign="top">no</td>

  1101.   </tr>

  1102.   <tr>

  1103.     <td valign="top">group</td>

  1104.     <td valign="top"> Group specified packages together in overview page</td>

  1105.     <td align="center" valign="top">1.2</td>

  1106.     <td align="center" valign="top">no</td>

  1107.   </tr>

  1108.   <tr>

  1109.     <td valign="top">nodeprecated</td>

  1110.     <td valign="top">             Do not include @deprecated information</td>

  1111.     <td align="center" valign="top">all</td>

  1112.     <td align="center" valign="top">no</td>

  1113.   </tr>

  1114.   <tr>

  1115.     <td valign="top">nodeprecatedlist</td>

  1116.     <td valign="top">         Do not generate deprecated list</td>

  1117.     <td align="center" valign="top">1.2</td>

  1118.     <td align="center" valign="top">no</td>

  1119.   </tr>

  1120.   <tr>

  1121.     <td valign="top">notree</td>

  1122.     <td valign="top">                   Do not generate class hierarchy</td>

  1123.     <td align="center" valign="top">all</td>

  1124.     <td align="center" valign="top">no</td>

  1125.   </tr>

  1126.   <tr>

  1127.     <td valign="top">noindex</td>

  1128.     <td valign="top">                  Do not generate index</td>

  1129.     <td align="center" valign="top">all</td>

  1130.     <td align="center" valign="top">no</td>

  1131.   </tr>

  1132.   <tr>

  1133.     <td valign="top">nohelp</td>

  1134.     <td valign="top">                   Do not generate help link</td>

  1135.     <td align="center" valign="top">1.2</td>

  1136.     <td align="center" valign="top">no</td>

  1137.   </tr>

  1138.   <tr>

  1139.     <td valign="top">nonavbar</td>

  1140.     <td valign="top">                 Do not generate navigation bar</td>

  1141.     <td align="center" valign="top">1.2</td>

  1142.     <td align="center" valign="top">no</td>

  1143.   </tr>

  1144.   <tr>

  1145.     <td valign="top">serialwarn</td>

  1146.     <td valign="top">               Generate warning about @serial tag</td>

  1147.     <td align="center" valign="top">1.2</td>

  1148.     <td align="center" valign="top">no</td>

  1149.   </tr>

  1150.   <tr>

  1151.     <td valign="top">helpfile</td>

  1152.     <td valign="top">Specifies the HTML help file to use</td>

  1153.     <td align="center" valign="top">1.2</td>

  1154.     <td align="center" valign="top">no</td>

  1155.   </tr>

  1156.   <tr>

  1157.     <td valign="top">stylesheetfile</td>

  1158.     <td valign="top">Specifies the CSS stylesheet to use</td>

  1159.     <td align="center" valign="top">1.2</td>

  1160.     <td align="center" valign="top">no</td>

  1161.   </tr>

  1162.   <tr>

  1163.     <td valign="top">charset</td>

  1164.     <td valign="top">        Charset for cross-platform viewing of generated documentation</td>

  1165.     <td align="center" valign="top">1.2</td>

  1166.     <td align="center" valign="top">no</td>

  1167.   </tr>

  1168.   <tr>

  1169.     <td valign="top">docencoding</td>

  1170.     <td valign="top">Output file encoding name</td>

  1171.     <td align="center" valign="top">1.1</td>

  1172.     <td align="center" valign="top">no</td>

  1173.   </tr>

  1174. </table>

  1175. <h3>Examples</h3>

  1176. <blockquote>

  1177. <pre>&lt;javadoc packagenames=&quot;com.dummy.test.*&quot; 

  1178.          sourcepath=&quot;src&quot; 

  1179.          destdir=&quot;docs/api&quot;

  1180.          author=&quot;true&quot;

  1181.          version=&quot;true&quot;

  1182.          use=&quot;true&quot;

  1183.          windowtitle=&quot;Test API&quot;

  1184.          doctitle=&quot;&lt;h1&gt;Test&lt;/h1&gt;&quot;

  1185.          bottom=&quot;&lt;i&gt;Copyright &amp;#169; 2000 Dummy Corp. All Rights Reserved.&lt;/i&gt;&quot;

  1186. /&gt;</pre>

  1187. </blockquote>

  1188. <hr>

  1189. <h2><a name="keysubst">KeySubst</a></h2>

  1190. <h3>Description</h3>

  1191. <p>Performs keyword substitution in the source file, and writes the result to

  1192. the destination file.</p>

  1193. <p>Keys in the source file are of the form ${keyname}. The <i>keys</i> attribute

  1194. contains key/value pairs. When a key is found in the <i>keys</i> attribute, then

  1195. &quot;${keyname}&quot; is replaced by the corresponding value.</p>

  1196. <p>The <i>keys</i> attribute is of the form

  1197. &quot;name1=value1*name2=value2*name3=value3&quot;. The '*' is called the

  1198. separator, which might we changed with the <i>sep</i> attribute.</p>

  1199. <p>Note: the source file and destination file may not be the same.</p>

  1200. <h3>Parameters</h3>

  1201. <table border="1" cellpadding="2" cellspacing="0">

  1202.   <tr>

  1203.     <td valign="top"><b>Attribute</b></td>

  1204.     <td valign="top"><b>Description</b></td>

  1205.     <td align="center" valign="top"><b>Required</b></td>

  1206.   </tr>

  1207.   <tr>

  1208.     <td valign="top">src</td>

  1209.     <td valign="top">the source file.</td>

  1210.     <td align="center" valign="top">Yes</td>

  1211.   </tr>

  1212.   <tr>

  1213.     <td valign="top">dest</td>

  1214.     <td valign="top">the destination file.</td>

  1215.     <td align="center" valign="top">Yes</td>

  1216.   </tr>

  1217.   <tr>

  1218.     <td valign="top">sep</td>

  1219.     <td valign="top">the separator for the name/value pairs.</td>

  1220.     <td align="center" valign="top">No</td>

  1221.   </tr>

  1222.   <tr>

  1223.     <td valign="top">keys</td>

  1224.     <td valign="top">name/value pairs for replacement.</td>

  1225.     <td align="center" valign="top">Yes</td>

  1226.   </tr>

  1227. </table>

  1228. <h3>Examples</h3>

  1229. <blockquote>

  1230. <p><code>&lt;keysubst src=&quot;abc.txt&quot; dest=&quot;def.txt&quot;

  1231. keys=&quot;VERSION=1.0.3*DATE=2000-01-10&quot; /&gt;</code></p>

  1232. </blockquote>

  1233. <hr>

  1234. <h2><a name="mkdir">Mkdir</a></h2>

  1235. <h3>Description</h3>

  1236. <p>Creates a directory. Also non-existent parent directories are created, when

  1237. necessary.</p>

  1238. <h3>Parameters</h3>

  1239. <table border="1" cellpadding="2" cellspacing="0">

  1240.   <tr>

  1241.     <td valign="top"><b>Attribute</b></td>

  1242.     <td valign="top"><b>Description</b></td>

  1243.     <td align="center" valign="top"><b>Required</b></td>

  1244.   </tr>

  1245.   <tr>

  1246.     <td valign="top">dir</td>

  1247.     <td valign="top">the directory to create.</td>

  1248.     <td align="center" valign="top">Yes</td>

  1249.   </tr>

  1250. </table>

  1251. <h3>Examples</h3>

  1252. <blockquote>

  1253. <p><code>&lt;mkdir dir=&quot;${dist}&quot; /&gt;</code></p>

  1254. <p><code>&lt;mkdir dir=&quot;${dist}/lib&quot; /&gt;</code></p>

  1255. </blockquote>

  1256. <hr>

  1257. <h2><a name="property">Property</a></h2>

  1258. <h3>Description</h3>

  1259. <p>Sets a property (by name and value), or set of properties (from file or

  1260. resource) in the project.</p>

  1261. <p>When a property was set by the user, or was a property in a parent project

  1262. (that started this project with the <a href="#ant">ant task</a>), then this

  1263. property cannot be set, and will be ignored. This means that properties set

  1264. outside the current project always override the properties of the current

  1265. project.</p>

  1266. <p>There are three ways to set properties:</p>

  1267. <ul>

  1268.   <li>By supplying both the <i>name</i> and <i>value</i> attribute.</li>

  1269.   <li>By setting the <i>file</i> attribute with the filename of the property

  1270.     file to load. This property file has the format as defined by the file used

  1271.     in the class java.util.Properties.</li>

  1272.   <li>By setting the <i>resource</i> attribute with the resource name of the

  1273.     property file to load. This property file has the format as defined by the

  1274.     file used in the class java.util.Properties.</li>

  1275. </ul>

  1276. <p>Although combinations of the three ways are possible, only one should be used

  1277. at a time. Problems might occur with the order in which properties are set, for

  1278. instance.</p>

  1279. <p>The value part of the properties being set, might contain references to other

  1280. properties. These references are resolved at the time these properties are set.

  1281. This also holds for properties loaded from a property file.</p>

  1282. <h3>Parameters</h3>

  1283. <table border="1" cellpadding="2" cellspacing="0">

  1284.   <tr>

  1285.     <td valign="top"><b>Attribute</b></td>

  1286.     <td valign="top"><b>Description</b></td>

  1287.     <td align="center" valign="top"><b>Required</b></td>

  1288.   </tr>

  1289.   <tr>

  1290.     <td valign="top">name</td>

  1291.     <td valign="top">the name of the property to set.</td>

  1292.     <td valign="top" align="center">No</td>

  1293.   </tr>

  1294.   <tr>

  1295.     <td valign="top">value</td>

  1296.     <td valign="top">the value of the property.</td>

  1297.     <td valign="top" align="center">No</td>

  1298.   </tr>

  1299.   <tr>

  1300.     <td valign="top">resource</td>

  1301.     <td valign="top">the resource name of the property file.</td>

  1302.     <td valign="top" align="center">No</td>

  1303.   </tr>

  1304.   <tr>

  1305.     <td valign="top">file</td>

  1306.     <td valign="top">the filename of the property file .</td>

  1307.     <td valign="top" align="center">No</td>

  1308.   </tr>

  1309. </table>

  1310. <h3>Examples</h3>

  1311. <blockquote>

  1312. <p><code>&lt;property name=&quot;foo.dist&quot; value=&quot;dist&quot;/&gt;</code></p>

  1313. <p><code>&lt;property file=&quot;foo.properties&quot; /&gt;</code></p>

  1314. <p><code>&lt;property resource=&quot;foo.properties&quot; /&gt;</code></p>

  1315. </blockquote>

  1316. <hr>

  1317. <h2><a name="replace">Replace</a></h2>

  1318. <h3>Description</h3>

  1319. <p>Replaces the occurrence of a given string with another string in a file. When

  1320. the <i>value</i> attribute is omitted, it defaults to &quot;&quot;.</p>

  1321. <h3>Parameters</h3>

  1322. <table border="1" cellpadding="2" cellspacing="0">

  1323.   <tr>

  1324.     <td valign="top"><b>Attribute</b></td>

  1325.     <td valign="top"><b>Description</b></td>

  1326.     <td align="center" valign="top"><b>Required</b></td>

  1327.   </tr>

  1328.   <tr>

  1329.     <td valign="top">file</td>

  1330.     <td valign="top">file for which the token should be replaced</td>

  1331.     <td valign="top" align="center">Yes</td>

  1332.   </tr>

  1333.   <tr>

  1334.     <td valign="top">token</td>

  1335.     <td valign="top">the token which must be replaced</td>

  1336.     <td valign="top" align="center">Yes</td>

  1337.   </tr>

  1338.   <tr>

  1339.     <td valign="top">value</td>

  1340.     <td valign="top">the new value for the token</td>

  1341.     <td valign="top" align="center">No</td>

  1342.   </tr>

  1343. </table>

  1344. <h3>Examples</h3>

  1345. <blockquote>

  1346. <p><code>&lt;replace file=&quot;${src}/index.html&quot; token=&quot;@@@&quot;

  1347. value=&quot;wombat&quot; /&gt;</code></p>

  1348. </blockquote>

  1349. <hr>

  1350. <h2><a name="rmic">Rmic</a></h2>

  1351. <h3>Description</h3>

  1352. <p>Runs the rmic compiler for a certain class.</p>

  1353. <h3>Parameters</h3>

  1354. <table border="1" cellpadding="2" cellspacing="0">

  1355.   <tr>

  1356.     <td valign="top"><b>Attribute</b></td>

  1357.     <td valign="top"><b>Description</b></td>

  1358.     <td align="center" valign="top"><b>Required</b></td>

  1359.   </tr>

  1360.   <tr>

  1361.     <td valign="top">base</td>

  1362.     <td valign="top">the location to store the compiled files.</td>

  1363.     <td valign="top" align="center">Yes</td>

  1364.   </tr>

  1365.   <tr>

  1366.     <td valign="top">class</td>

  1367.     <td valign="top">the class for which to run <code>rmic</code>.</td>

  1368.     <td valign="top" align="center">Yes</td>

  1369.   </tr>

  1370. </table>

  1371. <h3>Examples</h3>

  1372. <blockquote>

  1373. <p><code>&lt;rmic class=&quot;com.xyz.FooBar&quot;

  1374. base=&quot;${build}/classes&quot; /&gt;</code></p>

  1375. </blockquote>

  1376. <hr>

  1377. <h2><a name="taskdef">Taskdef</a></h2>

  1378. <h3>Description</h3>

  1379. <p>Adds a task definition to the current project, such that this new task can be

  1380. used in the current project. Two attributes are needed, the name that identifies

  1381. this task uniquely, and the full name of the class (including the packages) that

  1382. implements this task.</p>

  1383. <p>Taskdef should be used to add your own tasks to the system. See also &quot;<a

  1384. href="#writingowntask">Writing your own task</a>&quot;.</p>

  1385. <h3>Parameters</h3>

  1386. <table border="1" cellpadding="2" cellspacing="0">

  1387.   <tr>

  1388.     <td valign="top"><b>Attribute</b></td>

  1389.     <td valign="top"><b>Description</b></td>

  1390.     <td align="center" valign="top"><b>Required</b></td>

  1391.   </tr>

  1392.   <tr>

  1393.     <td valign="top">name</td>

  1394.     <td valign="top">the name of the task</td>

  1395.     <td valign="top" align="center">Yes</td>

  1396.   </tr>

  1397.   <tr>

  1398.     <td valign="top">class</td>

  1399.     <td valign="top">the full class name implementing the task</td>

  1400.     <td valign="top" align="center">Yes</td>

  1401.   </tr>

  1402. </table>

  1403. <h3>Examples</h3>

  1404. <blockquote>

  1405. <p><code>&lt;taskdef name=&quot;myjavadoc&quot; value=&quot;com.mydomain.JavadocTask&quot;

  1406. /&gt;</code></p>

  1407. </blockquote>

  1408. <hr>

  1409. <h2><a name="tstamp">Tstamp</a></h2>

  1410. <h3>Description</h3>

  1411. <p>Sets the DSTAMP, TSTAMP and TODAY properties in the current project. The DSTAMP is

  1412. in the &quot;yyyymmdd&quot; format, the TSTAMP is in the &quot;hhmm&quot; format

  1413. and TODAY is &quot;month day year&quot;.</p>

  1414. <p>These properties can be used in the buildfile, for instance, to create

  1415. timestamped filenames or used to replace placeholder tags inside documents to

  1416. indicate, for example, the release date. The best place for this task is in the <a

  1417. href="#inittarget">init target</a>.</p>

  1418. <h3>Parameters</h3>

  1419. <table border="1" cellpadding="2" cellspacing="0">

  1420.   <tr>

  1421.     <td valign="top"><b>Attribute</b></td>

  1422.     <td valign="top"><b>Description</b></td>

  1423.     <td align="center" valign="top"><b>Required</b></td>

  1424.   </tr>

  1425. </table>

  1426. <h3>Examples</h3>

  1427. <blockquote>

  1428. <p><code>&lt;tstamp/&gt;</code></p>

  1429. </blockquote>

  1430. <hr>

  1431. <h2><a name="zip">Zip</a></h2>

  1432. <h3>Description</h3>

  1433. <p>Creates a zipfile.</p>

  1434. <p>The <i>basedir</i> attribute is the reference directory from where to zip.</p>

  1435. <p>When &quot;*&quot; is used for items, all files in the basedir, and its

  1436. subdirectories, will be zipped. Otherwise all the files and directories

  1437. mentioned in the items list will zipped. When a directory is specified, then all

  1438. files within it are also zipped.</p>

  1439. <p>With the <i>ignore</i> attribute, you can specify names of files or

  1440. directories to ignore. These files will not be zipped. The items in the <i>ignore</i>

  1441. attribute override the items in the <i>items</i> attribute. The names specified

  1442. in the <i>ignore</i> attribute are just names, they do not contain any path

  1443. information!</p>

  1444. <h3>Parameters</h3>

  1445. <table border="1" cellpadding="2" cellspacing="0">

  1446.   <tr>

  1447.     <td valign="top"><b>Attribute</b></td>

  1448.     <td valign="top"><b>Description</b></td>

  1449.     <td valign="top" align="center"><b>Required</b></td>

  1450.   </tr>

  1451.   <tr>

  1452.     <td valign="top">zipfile</td>

  1453.     <td valign="top">the zip-file to create.</td>

  1454.     <td align="center" valign="top">Yes</td>

  1455.   </tr>

  1456.   <tr>

  1457.     <td valign="top">basedir</td>

  1458.     <td valign="top">the directory from which to zip the files.</td>

  1459.     <td align="center" valign="top">Yes</td>

  1460.   </tr>

  1461.   <tr>

  1462.     <td valign="top">items</td>

  1463.     <td valign="top">a comma separated list of the files/directories to zip.</td>

  1464.     <td align="center" valign="top">Yes</td>

  1465.   </tr>

  1466.   <tr>

  1467.     <td valign="top">ignore</td>

  1468.     <td valign="top">a comma separated list of the filenames/directorynames to

  1469.       exclude from the zip.</td>

  1470.     <td align="center" valign="top">No</td>

  1471.   </tr>

  1472. </table>

  1473. <h3>Examples</h3>

  1474. <blockquote>

  1475. <p><code>&lt;zip zipfile=&quot;${dist}/manual.zip&quot; basedir=&quot;htdocs/manual&quot;

  1476. items=&quot;*&quot; /&gt;</code></p>

  1477. </blockquote>

  1478. <p>zips all files in the <code>htdocs/manual</code> directory in a file called <code>manual.zip</code>

  1479. in the <code>${dist}</code> directory.</p>

  1480. <blockquote>

  1481. <p><code>&lt;zip zipfile=&quot;${dist}/manual.zip&quot; basedir=&quot;htdocs/manual&quot;

  1482. items=&quot;*&quot; ignore=&quot;mydocs, todo.html&quot;/&gt;</code></p>

  1483. </blockquote>

  1484. <p>zips all files in the <code>htdocs/manual</code> directory in a file called <code>manual.zip</code>

  1485. in the <code>${dist}</code> directory. Files/directories with the names <code>mydocs</code>

  1486. and <code>todo.html</code> are excluded.</p>

  1487. <hr>

  1488. <h2><a name="writingowntask">Writing your own task</a></h2>

  1489. <p>It is very easy to write your own task:</p>

  1490. <ol>

  1491.   <li>Create a Java class that extends <code>org.apache.tools.ant.Task</code>.</li>

  1492.   <li>For each attribute, write a setter method. The setter method must be a <code>public

  1493.     void</code> method that takes one <code>String</code> as an argument. The

  1494.     name of the method must begin with &quot;set&quot;, followed by the

  1495.     attribute name, with the first character in uppercase, and the rest in

  1496.     lowercase.</li>

  1497.   <li>Write a <code>public void execute</code> method, with no arguments, that

  1498.     throws a <code>BuildException</code>. This method implements the task

  1499.     itself.</li>

  1500. </ol>

  1501. <p>It is important to know that Ant first calls the setters for the attributes

  1502. it encounters for a specific task in the buildfile, before it executes is.</p>

  1503. <p>Let's write our own task, that prints a message on the System.out stream. The

  1504. task has one attribute called &quot;message&quot;.</p>

  1505. <blockquote>

  1506. <pre>public class MyVeryOwnTask extends Task {

  1507.   private String msg;

  1508. 

  1509.   // The method executing the task

  1510.   public void execute() throws BuildException {

  1511.     System.out.println(message);

  1512.   }

  1513. 

  1514.   // The setter for the &quot;message&quot; attribute

  1515.   public void setMessage(String msg) {

  1516.     this.msg = msg;

  1517.   }

  1518. }</pre>

  1519. </blockquote>

  1520. <p>It's really this simple;-)</p>

  1521. <p>Adding your task to the system is rather simple too:</p>

  1522. <ol>

  1523.   <li>Make sure the class that implements your task is in the classpath when

  1524.     starting Ant.</li>

  1525.   <li>In the <i>init</i> target, add a <i>taskdef</i> task. This actually adds

  1526.     your task to the system.</li>

  1527.   <li>Use your task in the rest of the buildfile.</li>

  1528. </ol>

  1529. <h3>Example</h3>

  1530. <blockquote>

  1531. <pre>&lt;project name=&quot;TaskTest&quot; default=&quot;test&quot; basedir=&quot;.&quot;&gt;

  1532.   &lt;target name=&quot;init&quot;&gt;

  1533.     &lt;taskdef name=&quot;mytask&quot; class=&quot;com.mydomain.MyVeryOwnTask&quot;/&gt;

  1534.   &lt;/target&gt;

  1535. 

  1536.   &lt;target name=&quot;test&quot;&gt;

  1537.     &lt;mytask myattr=&quot;wombat&quot; /&gt;

  1538.   &lt;/target&gt;

  1539. &lt;/project&gt;

  1540. </pre>

  1541. </blockquote>

  1542. <p>Another way to add a task (more permanently), is to add the task name and

  1543. implementing class name to the <code>default.properties</code> file in the <code>org.apache.tools.ant.taskdefs</code>

  1544. package. Then you can use it as if it were a built in task.</p>

  1545. <hr>

  1546. <h2><a name="feedback">Feedback</a></h2>

  1547. <p>To provide feedback on this software, please subscribe to the Ant Development

  1548. Mail List <a href="mailto:(ant-dev-subscribe@jakarta.apache.org">(ant-dev-subscribe@jakarta.apache.org</a>)</p>

  1549. <hr>

  1550. <p align="center">Copyright &copy; 2000 Apache Software Foundation. All

  1551. rights Reserved.</p>

  1552. 

  1553. </body>

  1554. 

  1555. </html>
Please read the following content carefully:

Dear OpenI User

Thank you for your continuous support to the Openl Qizhi Community AI Collaboration Platform. In order to protect your usage rights and ensure network security, we updated the Openl Qizhi Community AI Collaboration Platform Usage Agreement in January 2024. The updated agreement specifies that users are prohibited from using intranet penetration tools. After you click "Agree and continue", you can continue to use our services. Thank you for your cooperation and understanding.

For more agreement content, please refer to the《Openl Qizhi Community AI Collaboration Platform Usage Agreement》

Agree and continue
Disagree, exit