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.

faq.html 98 kB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <!--
  3. Licensed to the Apache Software Foundation (ASF) under one or more
  4. contributor license agreements. See the NOTICE file distributed with
  5. this work for additional information regarding copyright ownership.
  6. The ASF licenses this file to You under the Apache License, Version 2.0
  7. (the "License"); you may not use this file except in compliance with
  8. the License. You may obtain a copy of the License at
  9. http://www.apache.org/licenses/LICENSE-2.0
  10. Unless required by applicable law or agreed to in writing, software
  11. distributed under the License is distributed on an "AS IS" BASIS,
  12. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13. See the License for the specific language governing permissions and
  14. limitations under the License.
  15. -->
  16. <html lang="en">
  17. <!-- GENERATED FILE, DO NOT EDIT, EDIT THE XML FILE IN xdocs INSTEAD! -->
  18. <head>
  19. <META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
  20. <title>Apache Ant - Frequently Asked Questions</title>
  21. <link type="text/css" href="./page.css" rel="stylesheet">
  22. <meta name="author" content="Stefan Bodewig">
  23. <meta name="email" content="bodewig@apache.org">
  24. </head>
  25. <body>
  26. <p class="navpath">
  27. <script src="./breadcrumbs.js" language="JavaScript" type="text/javascript"></script>
  28. </p>
  29. <div class="logobar">
  30. <table width="100%" border="0" cellspacing="0" cellpadding="0">
  31. <tr>
  32. <td align="left"><img border="0" alt="Apache Ant site" src="./images/group-logo.gif"></td>
  33. <td align="center" width="100%"><img alt="Apache Ant logo" border="0" src="./images/project-logo.gif"></td>
  34. <td align="right">
  35. <form target="_blank" onsubmit="q.value = query.value + ' site:ant.apache.org'" action="http://www.google.com/search" method="get">
  36. <table summary="search" border="0" cellspacing="0" cellpadding="0" bgcolor="#4C6C8F">
  37. <tr>
  38. <td colspan="3"><img height="10" width="1" alt="" src="./images/spacer.gif"></td>
  39. </tr>
  40. <tr>
  41. <td><img height="1" width="1" alt="" src="./images/spacer.gif"></td>
  42. <td nowrap="nowrap" class="searchcaption">
  43. <input name="q" type="hidden">
  44. <input size="15" id="query" type="text">
  45. <img height="1" width="5" alt="" src="./images/spacer.gif">
  46. <input name="Search" value="Search" type="submit">
  47. <br>
  48. the Apache Ant site
  49. </td>
  50. <td><img height="1" width="1" alt="" src="./images/spacer.gif"></td>
  51. </tr>
  52. <tr>
  53. <td><img alt="" border="0" height="10" width="9" src="./images/search-left.gif"></td>
  54. <td><img height="1" width="1" alt="" src="./images/spacer.gif"></td>
  55. <td><img alt="" border="0" height="10" width="9" src="./images/search-right.gif"></td>
  56. </tr>
  57. </table>
  58. </form>
  59. </td>
  60. </tr>
  61. </table>
  62. </div>
  63. <div class="tab">
  64. <table summary="tab bar" border="0" cellpadding="0" cellspacing="0">
  65. <tr>
  66. <td width="8"><img alt="" height="5" width="8" src="./images/spacer.gif"></td><td valign="bottom">
  67. <table summary="selected tab" style="height: 1.5em" border="0" cellpadding="0" cellspacing="0">
  68. <tr>
  69. <td valign="top" width="5" bgcolor="#4C6C8F"><img height="5" width="5" alt="" src="./images/tabSel-left.gif"></td><td valign="middle" bgcolor="#4C6C8F"><font color="#ffffff" size="2" face="Arial, Helvetica, Sans-serif"><b>Home</b></font></td><td valign="top" width="5" bgcolor="#4C6C8F"><img height="5" width="5" alt="" src="./images/tabSel-right.gif"></td>
  70. </tr>
  71. </table>
  72. </td>
  73. <td width="5"><img alt="" height="8" width="8" src="./images/spacer.gif"></td><td valign="bottom">
  74. <table summary="non selected tab" style="height: 1.4em" border="0" cellpadding="0" cellspacing="0">
  75. <tr>
  76. <td valign="top" width="5" bgcolor="#B2C4E0"><img height="5" width="5" alt="" src="./images/tab-left.gif"></td><td valign="middle" bgcolor="#B2C4E0"><a href="./projects/index.html"><font size="2" face="Arial, Helvetica, Sans-serif">Projects</font></a></td><td valign="top" width="5" bgcolor="#B2C4E0"><img height="5" width="5" alt="" src="./images/tab-right.gif"></td>
  77. </tr>
  78. </table>
  79. </td>
  80. </tr>
  81. </table>
  82. </div>
  83. <div class="bluebar"></div>
  84. <div class="menucontainer">
  85. <div class="menu">
  86. <ul>
  87. <li class="menuheader">Apache Ant
  88. <ul>
  89. <li>
  90. <a href="./index.html">Welcome</a>
  91. </li>
  92. <li>
  93. <a href="./license.html">License</a>
  94. </li>
  95. <li>
  96. <a href="./antnews.html">News</a>
  97. </li>
  98. </ul>
  99. </li>
  100. <li class="menuheader">Documentation
  101. <ul>
  102. <li>
  103. <a href="./manual/index.html">Manual</a>
  104. </li>
  105. <li>
  106. <a href="./projects.html">Related Projects</a>
  107. </li>
  108. <li>
  109. <a href="./external.html">External Tools and Tasks</a>
  110. </li>
  111. <li>
  112. <a href="./resources.html">Resources</a>
  113. </li>
  114. <li>
  115. <span class="sel">Frequently Asked Questions</span>
  116. </li>
  117. <li>
  118. <a href="http://wiki.apache.org/ant/FrontPage">Wiki</a>
  119. </li>
  120. <li>
  121. <a href="./problems.html">Having Problems?</a>
  122. </li>
  123. </ul>
  124. </li>
  125. <li class="menuheader">Download
  126. <ul>
  127. <li>
  128. <a href="http://ant.apache.org/bindownload.cgi">Binary Distributions</a>
  129. </li>
  130. <li>
  131. <a href="http://ant.apache.org/srcdownload.cgi">Source Distributions</a>
  132. </li>
  133. </ul>
  134. </li>
  135. <li class="menuheader">Contributing
  136. <ul>
  137. <li>
  138. <a href="./mail.html">Mailing Lists</a>
  139. </li>
  140. <li>
  141. <a href="./svn.html">Subversion Repositories</a>
  142. </li>
  143. <li>
  144. <a href="./nightlies.html">Nightly+Continuous Builds</a>
  145. </li>
  146. <li>
  147. <a href="./bugs.html">Bug Database</a>
  148. </li>
  149. </ul>
  150. </li>
  151. <li class="menuheader">Sponsorship
  152. <ul>
  153. <li>
  154. <a href="http://www.apache.org/foundation/thanks.html">Thanks</a>
  155. </li>
  156. <li>
  157. <a href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a>
  158. </li>
  159. <li>
  160. <a href="http://www.apache.org/foundation/contributing.html">Donations</a>
  161. </li>
  162. </ul>
  163. </li>
  164. <li class="menuheader">Project Management
  165. <ul>
  166. <li>
  167. <a href="./contributors.html">Contributors</a>
  168. </li>
  169. <li>
  170. <a href="./mission.html">Apache Ant Mission</a>
  171. </li>
  172. <li>
  173. <a href="./bylaws.html">Project Bylaws</a>
  174. </li>
  175. <li>
  176. <a href="./legal.html">Legal</a>
  177. </li>
  178. </ul>
  179. </li>
  180. </ul>
  181. </div>
  182. <center>
  183. <a href="http://www.apache.org/events/current-event.html"><img border="0" title="ApacheCon" alt="ApacheCon - logo" src="http://www.apache.org/events/current-event-125x125.png" style="width: 125px;height: 125px;"></a>
  184. </center>
  185. <img style="float: left" height="10" width="10" border="0" alt="" src="./images/menu-left.gif">
  186. <img style="float: right" height="10" width="10" border="0" alt="" src="./images/menu-right.gif">
  187. </div>
  188. <div class="lightbluebar">&nbsp;</div>
  189. <div class="main">
  190. <div class="content">
  191. <h1 class="title">Frequently Asked Questions</h1>
  192. <h3 class="section">Questions</h3>
  193. <h4 class="toc">About this FAQ</h4>
  194. <ul>
  195. <li><a href="#latest-version">
  196. Where do I find the latest version of this
  197. document?
  198. </a></li>
  199. <li><a href="#adding-faqs">
  200. How can I contribute to this FAQ?
  201. </a></li>
  202. <li><a href="#creating-faq">
  203. How do you create the HTML version of this
  204. FAQ?
  205. </a></li>
  206. </ul>
  207. <h4 class="toc">General</h4>
  208. <ul>
  209. <li><a href="#what-is-ant">
  210. What is Apache Ant?
  211. </a></li>
  212. <li><a href="#ant-name">
  213. Why do you call it Ant?
  214. </a></li>
  215. <li><a href="#history">
  216. Tell us a little bit about Ant's history.
  217. </a></li>
  218. </ul>
  219. <h4 class="toc">Installation</h4>
  220. <ul>
  221. <li><a href="#java-version">
  222. Which version of Java is required to run
  223. Ant?
  224. </a></li>
  225. <li><a href="#no-gnu-tar">
  226. I get checksum errors when I try to extract the
  227. <code>tar.gz</code> distribution file. Why?
  228. </a></li>
  229. <li><a href="#RedHat_ES_3">
  230. How do you get ant-1.6.x (or any version later than
  231. 1.5.2) to work on on RedHat ES 3?
  232. </a></li>
  233. </ul>
  234. <h4 class="toc">How do I ...</h4>
  235. <ul>
  236. <li><a href="#precompile-jsps">
  237. How to I precompile Java Server Pages (JSPs)?
  238. </a></li>
  239. <li><a href="#implement-os-specific-configuration">
  240. How do I realize os--specific configurations?
  241. </a></li>
  242. <li><a href="#adding-external-tasks">
  243. How do I add an external task that I've written to the
  244. page "External Tools and Tasks"?
  245. </a></li>
  246. <li><a href="#create-extensions">
  247. How do I create new tasks?
  248. </a></li>
  249. <li><a href="#passing-cli-args">
  250. How do I pass parameters from the command line to my
  251. build file?
  252. </a></li>
  253. <li><a href="#jikes-switches">
  254. How can I use Jikes-specific command-line
  255. switches?
  256. </a></li>
  257. <li><a href="#shell-redirect-1">
  258. How do I include a &lt; character in my command-line arguments?
  259. </a></li>
  260. <li><a href="#shell-redirect-2">
  261. How do I redirect standard input or standard output
  262. in the <code>&lt;exec&gt;</code> task?
  263. </a></li>
  264. <li><a href="#batch-shell-execute">
  265. How do I execute a batch file or shell script from Ant?
  266. </a></li>
  267. <li><a href="#multi-conditions">
  268. I want to execute a particular target only if
  269. multiple conditions are true.
  270. </a></li>
  271. <li><a href="#encoding">
  272. How can I include national characters like German
  273. umlauts in my build file?
  274. </a></li>
  275. <li><a href="#use-zip-instead-of-jar">
  276. How do I use <code>jar</code>'s <code>M</code> switch?
  277. I don't want a MANIFEST.
  278. </a></li>
  279. <li><a href="#propertyvalue-as-name-for-property">
  280. How can I do something like <code>&lt;property name="prop"
  281. value="${${anotherprop}}"/&gt;</code> (double expanding the property)?
  282. </a></li>
  283. <li><a href="#delete-directory-children-only">
  284. How can I delete everything beneath a particular directory,
  285. preserving the directory itself?
  286. </a></li>
  287. <li><a href="#delete-directory-only-if-empty">
  288. How can I delete a particular directory,
  289. if and only if it is empty?
  290. </a></li>
  291. </ul>
  292. <h4 class="toc">It doesn't work (as expected)</h4>
  293. <ul>
  294. <li><a href="#general-advice">
  295. General Advice
  296. </a></li>
  297. <li><a href="#always-recompiles">
  298. Why does Ant always recompile all my Java files?
  299. </a></li>
  300. <li><a href="#defaultexcludes">
  301. I've used a <code>&lt;delete&gt;</code> task to
  302. delete unwanted SourceSafe control files (CVS files, editor
  303. backup files, etc.), but it doesn't seem to work; the files
  304. never get deleted. What's wrong?
  305. </a></li>
  306. <li><a href="#stop-dependency">
  307. I have a target I want to skip if a property is set,
  308. so I have <code>unless="property"</code> as an attribute
  309. of the target, but all the targets this target
  310. depends on are still executed. Why?
  311. </a></li>
  312. <li><a href="#include-order">
  313. In my <code>&lt;fileset&gt;</code>, I've put in an
  314. <code>&lt;exclude&gt;</code> of all files followed by an
  315. <code>&lt;include&gt;</code> of just the files I want, but it
  316. isn't giving me any files at all. What's wrong?
  317. </a></li>
  318. <li><a href="#properties-not-trimmed">
  319. <code>ant</code> failed to build my program via javac
  320. even when I put the needed jars in an external
  321. <code>build.properties</code> file and reference them by
  322. <code>pathelement</code> or <code>classpath refid</code>.
  323. </a></li>
  324. <li><a href="#winzip-lies">
  325. Ant creates WAR files with a lower-case
  326. <code>web-inf</code> or JAR files with a lower-case
  327. <code>meta-inf</code> directory.
  328. </a></li>
  329. <li><a href="#NoClassDefFoundError">
  330. I installed Ant 1.6.x and now get
  331. <code>Exception in thread "main" java.lang.NoClassDefFoundError:
  332. </code>
  333. </a></li>
  334. <li><a href="#InstantiationException">
  335. I installed Ant 1.6.x and now get
  336. <code>java.lang.InstantiationException: org.apache.tools.ant.Main</code>
  337. </a></li>
  338. <li><a href="#mangled-manifest">
  339. Whenever I use the Ant jar or manifest related tasks, long lines in
  340. my manifest are wrapped at 70 characters and the resulting jar does
  341. not work in my application server. Why does Ant do this?
  342. </a></li>
  343. <li><a href="#CreateProcess_error_2">
  344. <code>&lt;exec&gt;</code> fails with <code>"Cannot run
  345. program "...":CreateProcess error=2"</code> on
  346. Windows.
  347. </a></li>
  348. </ul>
  349. <h4 class="toc">Ant and IDEs/Editors</h4>
  350. <ul>
  351. <li><a href="#integration">
  352. Is Ant supported by my IDE/Editor?
  353. </a></li>
  354. <li><a href="#emacs-mode">
  355. Why doesn't (X)Emacs/vi/MacOS X's project builder
  356. correctly parse the error messages generated by Ant?
  357. </a></li>
  358. </ul>
  359. <h4 class="toc">Advanced Issues</h4>
  360. <ul>
  361. <li><a href="#dtd">
  362. Is there a DTD that I can use to validate my build
  363. files?
  364. </a></li>
  365. <li><a href="#xml-entity-include">
  366. How do I include an XML snippet in my build file?
  367. </a></li>
  368. <li><a href="#mail-logger">
  369. How do I send an email with the result of my build
  370. process?
  371. </a></li>
  372. <li><a href="#listener-properties">
  373. How do I get at the properties that Ant was running
  374. with from inside BuildListener?
  375. </a></li>
  376. </ul>
  377. <h4 class="toc">Known Problems</h4>
  378. <ul>
  379. <li><a href="#input-makes-exec-hang">
  380. <code>&lt;exec&gt;</code> causes other tasks to hang
  381. or leads to strange behaviour of <code>&lt;input&gt;</code>
  382. tasks.
  383. </a></li>
  384. <li><a href="#javac-stackoverflow">
  385. <code>&lt;javac&gt;</code> causes a
  386. StackOverflowError
  387. </a></li>
  388. <li><a href="#170-requires-junit">
  389. Ant 1.7.0 doesn't build from sources without
  390. JUnit
  391. </a></li>
  392. <li><a href="#remove-cr">
  393. &lt;chmod&gt; or &lt;exec&gt; doesn't work in Ant
  394. 1.3 on Unix
  395. </a></li>
  396. <li><a href="#delegating-classloader">
  397. &lt;style&gt; or &lt;junit&gt; ignores my
  398. &lt;classpath&gt;
  399. </a></li>
  400. <li><a href="#delegating-classloader-1.5">
  401. &lt;style&gt; or &lt;junit&gt; ignores my
  402. &lt;classpath&gt; - Ant 1.5.x version
  403. </a></li>
  404. <li><a href="#delegating-classloader-1.6">
  405. &lt;style&gt; or &lt;junit&gt; ignores my
  406. &lt;classpath&gt; - Ant 1.6.x version
  407. </a></li>
  408. <li><a href="#unknownelement.taskcontainer">
  409. Why do my custom task containers see Unknown Elements in Ant 1.6
  410. - they worked in Ant 1.5?
  411. </a></li>
  412. <li><a href="#oom-on-mac">
  413. Ant runs into an infinite loop/throws an OutOfMemoryError
  414. when I compile my project under Mac OS X.
  415. </a></li>
  416. <li><a href="#extension-point-and-import">
  417. <code>extension-point</code> doesn't work
  418. with <code>import</code> like the documentation
  419. states.
  420. </a></li>
  421. </ul>
  422. <h3 class="section">Answers</h3>
  423. <p class="faq">
  424. <a name="latest-version"></a>
  425. Where do I find the latest version of this
  426. document?
  427. </p>
  428. <p>The latest version can always be found at Ant's homepage
  429. <a href="http://ant.apache.org/faq.html">http://ant.apache.org/faq.html</a>.</p>
  430. <p class="faq">
  431. <a name="adding-faqs"></a>
  432. How can I contribute to this FAQ?
  433. </p>
  434. <p>The page you are looking it is generated from
  435. <a href="http://svn.apache.org/repos/asf/ant/core/trunk/xdocs/faq.xml">this</a>
  436. document. If you want to add a new question, please submit
  437. a patch against this document to one of Ant's mailing lists;
  438. hopefully, the structure is self-explanatory.</p>
  439. <p>If you don't know how to create a patch, see the patches
  440. section of <a href="http://jakarta.apache.org/site/source.html">this
  441. page</a>.</p>
  442. <p class="faq">
  443. <a name="creating-faq"></a>
  444. How do you create the HTML version of this
  445. FAQ?
  446. </p>
  447. <p>We use
  448. <a href="http://jakarta.apache.org/velocity/anakia.html">Anakia</a>
  449. to render the HTML version from the original XML file.</p>
  450. <p>The Velocity stylesheets used to process the XML files can
  451. be found in the <code>xdocs/stylesheets</code> subdirectory of
  452. Ant's SVN repository - the build file
  453. <code>docs.xml</code> at the top level of the ant SVN
  454. module (trunk) is used to drive Anakia.</p>
  455. <p>To transform the xml into html, one needs velocity 1.4.
  456. The command to run is :</p>
  457. <p>
  458. <code>ant -Dvelocity.dir=[installation path of velocity] -f docs.xml</code>
  459. </p>
  460. <p class="faq">
  461. <a name="what-is-ant"></a>
  462. What is Apache Ant?
  463. </p>
  464. <p> Ant is a Java-based build tool. In theory, it is kind of
  465. like Make, without Make's wrinkles and with the full
  466. portability of pure Java code.</p>
  467. <p class="faq">
  468. <a name="ant-name"></a>
  469. Why do you call it Ant?
  470. </p>
  471. <p>According to Ant's original author, James Duncan
  472. Davidson, the name is an acronym for "Another Neat
  473. Tool".</p>
  474. <p>Later explanations go along the lines of "ants
  475. do an extremely good job at building things", or
  476. "ants are very small and can carry a weight dozens of times
  477. their own" - describing what Ant is intended to
  478. be.</p>
  479. <p class="faq">
  480. <a name="history"></a>
  481. Tell us a little bit about Ant's history.
  482. </p>
  483. <p>Initially, Ant was part of the Tomcat code base, when it was
  484. donated to the Apache Software Foundation. It was
  485. created by James Duncan Davidson, who is also the original
  486. author of Tomcat. Ant was there to build Tomcat, nothing
  487. else.</p>
  488. <p>Soon thereafter, several open source Java projects realized
  489. that Ant could solve the problems they had with Makefiles.
  490. Starting with the projects hosted at Jakarta and the old Java
  491. Apache project, Ant spread like a virus and is now the build
  492. tool of choice for a lot of projects.</p>
  493. <p>In January 2000, Ant was moved to a separate CVS module and
  494. was promoted to a project of its own, independent of
  495. Tomcat, and became Apache Ant.</p>
  496. <p>The first version of Ant that was exposed to a larger audience
  497. was the one that shipped with Tomcat's 3.1 release on 19 April
  498. 2000. This version has later been referred to as Ant
  499. 0.3.1.</p>
  500. <p>The first official release of Ant as a stand-alone product was
  501. Ant 1.1, released on 19 July 2000. The complete release
  502. history:</p>
  503. <table class="ForrestTable" cellspacing="1" cellpadding="4">
  504. <tr>
  505. <th colspan="1" rowspan="1"
  506. valign="top" align="left">
  507. Ant Version
  508. </th>
  509. <th colspan="1" rowspan="1"
  510. valign="top" align="left">
  511. Release Date
  512. </th>
  513. </tr>
  514. <tr>
  515. <td colspan="1" rowspan="1"
  516. valign="top" align="left">
  517. 1.1
  518. </td>
  519. <td colspan="1" rowspan="1"
  520. valign="top" align="left">
  521. 19 July 2000
  522. </td>
  523. </tr>
  524. <tr>
  525. <td colspan="1" rowspan="1"
  526. valign="top" align="left">
  527. 1.2
  528. </td>
  529. <td colspan="1" rowspan="1"
  530. valign="top" align="left">
  531. 24 October 2000
  532. </td>
  533. </tr>
  534. <tr>
  535. <td colspan="1" rowspan="1"
  536. valign="top" align="left">
  537. 1.3
  538. </td>
  539. <td colspan="1" rowspan="1"
  540. valign="top" align="left">
  541. 3 March 2001
  542. </td>
  543. </tr>
  544. <tr>
  545. <td colspan="1" rowspan="1"
  546. valign="top" align="left">
  547. 1.4
  548. </td>
  549. <td colspan="1" rowspan="1"
  550. valign="top" align="left">
  551. 3 September 2001
  552. </td>
  553. </tr>
  554. <tr>
  555. <td colspan="1" rowspan="1"
  556. valign="top" align="left">
  557. 1.4.1
  558. </td>
  559. <td colspan="1" rowspan="1"
  560. valign="top" align="left">
  561. 11 October 2001
  562. </td>
  563. </tr>
  564. <tr>
  565. <td colspan="1" rowspan="1"
  566. valign="top" align="left">
  567. 1.5
  568. </td>
  569. <td colspan="1" rowspan="1"
  570. valign="top" align="left">
  571. 10 July 2002
  572. </td>
  573. </tr>
  574. <tr>
  575. <td colspan="1" rowspan="1"
  576. valign="top" align="left">
  577. 1.5.1
  578. </td>
  579. <td colspan="1" rowspan="1"
  580. valign="top" align="left">
  581. 3 October 2002
  582. </td>
  583. </tr>
  584. <tr>
  585. <td colspan="1" rowspan="1"
  586. valign="top" align="left">
  587. 1.5.2
  588. </td>
  589. <td colspan="1" rowspan="1"
  590. valign="top" align="left">
  591. 3 March 2003
  592. </td>
  593. </tr>
  594. <tr>
  595. <td colspan="1" rowspan="1"
  596. valign="top" align="left">
  597. 1.5.3
  598. </td>
  599. <td colspan="1" rowspan="1"
  600. valign="top" align="left">
  601. 9 April 2003
  602. </td>
  603. </tr>
  604. <tr>
  605. <td colspan="1" rowspan="1"
  606. valign="top" align="left">
  607. 1.5.4
  608. </td>
  609. <td colspan="1" rowspan="1"
  610. valign="top" align="left">
  611. 12 August 2003
  612. </td>
  613. </tr>
  614. <tr>
  615. <td colspan="1" rowspan="1"
  616. valign="top" align="left">
  617. 1.6.0
  618. </td>
  619. <td colspan="1" rowspan="1"
  620. valign="top" align="left">
  621. 18 December 2003
  622. </td>
  623. </tr>
  624. <tr>
  625. <td colspan="1" rowspan="1"
  626. valign="top" align="left">
  627. 1.6.1
  628. </td>
  629. <td colspan="1" rowspan="1"
  630. valign="top" align="left">
  631. 12 February 2004
  632. </td>
  633. </tr>
  634. <tr>
  635. <td colspan="1" rowspan="1"
  636. valign="top" align="left">
  637. 1.6.2
  638. </td>
  639. <td colspan="1" rowspan="1"
  640. valign="top" align="left">
  641. 16 July 2004
  642. </td>
  643. </tr>
  644. <tr>
  645. <td colspan="1" rowspan="1"
  646. valign="top" align="left">
  647. 1.6.3
  648. </td>
  649. <td colspan="1" rowspan="1"
  650. valign="top" align="left">
  651. 28 April 2005
  652. </td>
  653. </tr>
  654. <tr>
  655. <td colspan="1" rowspan="1"
  656. valign="top" align="left">
  657. 1.6.4
  658. </td>
  659. <td colspan="1" rowspan="1"
  660. valign="top" align="left">
  661. 19 May 2005
  662. </td>
  663. </tr>
  664. <tr>
  665. <td colspan="1" rowspan="1"
  666. valign="top" align="left">
  667. 1.6.5
  668. </td>
  669. <td colspan="1" rowspan="1"
  670. valign="top" align="left">
  671. 2 June 2005
  672. </td>
  673. </tr>
  674. <tr>
  675. <td colspan="1" rowspan="1"
  676. valign="top" align="left">
  677. 1.7.0
  678. </td>
  679. <td colspan="1" rowspan="1"
  680. valign="top" align="left">
  681. 19 December 2006
  682. </td>
  683. </tr>
  684. <tr>
  685. <td colspan="1" rowspan="1"
  686. valign="top" align="left">
  687. 1.7.1
  688. </td>
  689. <td colspan="1" rowspan="1"
  690. valign="top" align="left">
  691. 27 June 2008
  692. </td>
  693. </tr>
  694. <tr>
  695. <td colspan="1" rowspan="1"
  696. valign="top" align="left">
  697. 1.8.0
  698. </td>
  699. <td colspan="1" rowspan="1"
  700. valign="top" align="left">
  701. 8 February 2010
  702. </td>
  703. </tr>
  704. </table>
  705. <p class="faq">
  706. <a name="java-version"></a>
  707. Which version of Java is required to run
  708. Ant?
  709. </p>
  710. <p>You will need Java installed on your system, version 1.4 or
  711. later required, 1.5 or later strongly recommended. The later
  712. the version of Java, the more Ant tasks you get.</p>
  713. <p>If only the JRE is present but not a full JDK then many
  714. tasks will not work.</p>
  715. <p>The following table lists the minimum Java versions
  716. required to compile and run Ant. Note that most committers
  717. work with more recent versions of the JDK and that Ant doesn't
  718. get tested much for older versions.</p>
  719. <table class="ForrestTable" cellspacing="1" cellpadding="4">
  720. <tr>
  721. <th colspan="1" rowspan="1"
  722. valign="top" align="left">
  723. Ant Version
  724. </th>
  725. <th colspan="1" rowspan="1"
  726. valign="top" align="left">
  727. Minimum Java Version
  728. </th>
  729. </tr>
  730. <tr>
  731. <td colspan="1" rowspan="1"
  732. valign="top" align="left">
  733. 1.1 up to 1.5.4
  734. </td>
  735. <td colspan="1" rowspan="1"
  736. valign="top" align="left">
  737. 1.1
  738. </td>
  739. </tr>
  740. <tr>
  741. <td colspan="1" rowspan="1"
  742. valign="top" align="left">
  743. 1.6.0 up to 1.6.5
  744. </td>
  745. <td colspan="1" rowspan="1"
  746. valign="top" align="left">
  747. 1.2
  748. </td>
  749. </tr>
  750. <tr>
  751. <td colspan="1" rowspan="1"
  752. valign="top" align="left">
  753. 1.7.0 up to 1.7.1
  754. </td>
  755. <td colspan="1" rowspan="1"
  756. valign="top" align="left">
  757. 1.3
  758. </td>
  759. </tr>
  760. <tr>
  761. <td colspan="1" rowspan="1"
  762. valign="top" align="left">
  763. 1.8.0 up to current svn trunk
  764. </td>
  765. <td colspan="1" rowspan="1"
  766. valign="top" align="left">
  767. 1.4
  768. </td>
  769. </tr>
  770. </table>
  771. <p class="faq">
  772. <a name="no-gnu-tar"></a>
  773. I get checksum errors when I try to extract the
  774. <code>tar.gz</code> distribution file. Why?
  775. </p>
  776. <p>Ant's distribution contains file names that are longer
  777. than 100 characters, which is not supported by the standard
  778. tar file format. Several different implementations of tar use
  779. different and incompatible ways to work around this
  780. restriction.</p>
  781. <p>Ant's &lt;tar&gt; task can create tar archives that use
  782. the GNU tar extension, and this has been used when putting
  783. together the distribution. If you are using a different
  784. version of tar (for example, the one shipping with Solaris),
  785. you cannot use it to extract the archive.</p>
  786. <p>The solution is to either install GNU tar, which can be
  787. found <a href="http://www.gnu.org/software/tar/tar.html">here</a>,
  788. or use the zip archive instead (you can extract it using
  789. <code>jar xf</code>).</p>
  790. <p class="faq">
  791. <a name="RedHat_ES_3"></a>
  792. How do you get ant-1.6.x (or any version later than
  793. 1.5.2) to work on on RedHat ES 3?
  794. </p>
  795. <p>Redhat ES 3.0 comes installed with ant 1.5.2. Even if you
  796. have your PATH and ANT_HOME variables set correctly to a later
  797. version of ant, you will always be forced to use the
  798. preinstalled version.</p>
  799. <p>To use a later version of ant on this OS you could do the
  800. following:</p>
  801. <pre class="code">
  802. $ ant -version
  803. Apache Ant version 1.5.2-23 compiled on November 12 2003
  804. $ su -
  805. # rpm -e ant ant-libs
  806. # exit
  807. $ hash -r
  808. $ ant -version
  809. Apache Ant version 1.6.2 compiled on July 16 2004
  810. </pre>
  811. <p class="faq">
  812. <a name="precompile-jsps"></a>
  813. How to I precompile Java Server Pages (JSPs)?
  814. </p>
  815. <p>Ant has a built in optional task <a href="/manual/OptionalTasks/jspc.html">&lt;jspc&gt;</a>
  816. which was intended for that. <b>But this task is deprecated.</b>
  817. Here the alternative suggested by the manual:</p>
  818. <p><i>Instead of relying on container specific JSP-compilers we suggest deploying
  819. the raw files (*.jsp) and use the container build-in functions: after deploying
  820. run a test suite (e.g. with
  821. <a href="http://jakarta.apache.org/cactus/">Cactus</a> or
  822. <a href="http://httpunit.sourceforge.net/">HttpUnit</a>) against the deployed web
  823. application. So you'll get then test result and the compiled JSPs.</i></p>
  824. <p class="faq">
  825. <a name="implement-os-specific-configuration"></a>
  826. How do I realize os--specific configurations?
  827. </p>
  828. <p>The core idea is using property files which name accords to the
  829. os-name. Then simply use the build-in property <tt>os.name</tt>.</p>
  830. <p>For better use you should also provide a file with default values.
  831. But be careful with the correct os-names. For test simply &lt;echo&gt;
  832. the ${os.name} on all machines and you can be sure to use the right
  833. file names.</p>
  834. <pre class="code">
  835. &lt;property file=&quot;${os.name}.properties&quot;/&gt;
  836. &lt;property file=&quot;default.properties&quot;/&gt;
  837. </pre>
  838. <p class="faq">
  839. <a name="adding-external-tasks"></a>
  840. How do I add an external task that I've written to the
  841. page "External Tools and Tasks"?
  842. </p>
  843. <p>Join and post a message to the dev or user mailing
  844. list (one list is enough), including the following
  845. information:</p>
  846. <ul>
  847. <li>the name of the task/tool</li>
  848. <li>a short description of the task/tool</li>
  849. <li>a Compatibility: entry stating with which version(s) of
  850. Ant the tool/task is compatible to</li>
  851. <li>a URL: entry linking to the main page of the tool/task</li>
  852. <li>a Contact: entry containing the email address or the URL
  853. of a webpage for the person or list to contact for issues
  854. related to the tool/task. <strong>Note that we'll add a
  855. link on the page, so any email address added there is not
  856. obfuscated and can (and probably will) be abused by robots
  857. harvesting websites for addresses to spam.</strong></li>
  858. <li>a License: entry containing the type of license for the
  859. tool/task</li>
  860. </ul>
  861. <p>The preferred format for this information is a patch to <a href="http://svn.apache.org/repos/asf/ant/core/trunk/xdocs/external.xml">this</a>
  862. document.</p>
  863. <p>If you have written something bigger than a 'simple plugin' to Ant it
  864. may be better to add the link to <a href="projects.html">projects.html</a>.
  865. The procedure to add it is the same. The file to patch is <a href="http://svn.apache.org/repos/asf/ant/core/trunk/xdocs/projects.xml">this</a>
  866. document. The syntax of that file is the same.</p>
  867. <p class="faq">
  868. <a name="create-extensions"></a>
  869. How do I create new tasks?
  870. </p>
  871. <p>Apart from a lot of information on using Ant, the
  872. <a href="manual/index.html">Manual</a> also contains information
  873. on how to extend Ant with new tasks. This information
  874. can be found under "Developing with Ant".</p>
  875. <p>Chances are that someone else already created the task you
  876. want to create, it may be wise to see
  877. <a href="external.html">External Tools and Tasks</a> and
  878. <a href="projects.html">Related Projects</a> first.</p>
  879. <p class="faq">
  880. <a name="passing-cli-args"></a>
  881. How do I pass parameters from the command line to my
  882. build file?
  883. </p>
  884. <p>Use properties. Using <code>ant
  885. -D<em>name</em>=<em>value</em></code> lets you define values for
  886. properties on the Ant command line. These properties can then be
  887. used within your build file as
  888. any normal property: <code>${<em>name</em>}</code> will put in
  889. <code><em>value</em></code>.</p>
  890. <p class="faq">
  891. <a name="jikes-switches"></a>
  892. How can I use Jikes-specific command-line
  893. switches?
  894. </p>
  895. <p>A couple of switches are supported via "magic"
  896. properties:</p>
  897. <table class="ForrestTable" cellspacing="1" cellpadding="4">
  898. <tr>
  899. <th colspan="1" rowspan="1"
  900. valign="top" align="left">
  901. switch
  902. </th>
  903. <th colspan="1" rowspan="1"
  904. valign="top" align="left">
  905. property
  906. </th>
  907. <th colspan="1" rowspan="1"
  908. valign="top" align="left">
  909. default
  910. </th>
  911. </tr>
  912. <tr>
  913. <td colspan="1" rowspan="1"
  914. valign="top" align="left">
  915. +E
  916. </td>
  917. <td colspan="1" rowspan="1"
  918. valign="top" align="left">
  919. build.compiler.emacs
  920. </td>
  921. <td colspan="1" rowspan="1"
  922. valign="top" align="left">
  923. false == not set
  924. </td>
  925. </tr>
  926. <tr>
  927. <td colspan="1" rowspan="1"
  928. valign="top" align="left">
  929. +P
  930. </td>
  931. <td colspan="1" rowspan="1"
  932. valign="top" align="left">
  933. build.compiler.pedantic
  934. </td>
  935. <td colspan="1" rowspan="1"
  936. valign="top" align="left">
  937. false == not set
  938. </td>
  939. </tr>
  940. <tr>
  941. <td colspan="1" rowspan="1"
  942. valign="top" align="left">
  943. +F
  944. </td>
  945. <td colspan="1" rowspan="1"
  946. valign="top" align="left">
  947. build.compiler.fulldepend
  948. </td>
  949. <td colspan="1" rowspan="1"
  950. valign="top" align="left">
  951. false == not set
  952. </td>
  953. </tr>
  954. <tr>
  955. <td colspan="1" rowspan="1"
  956. valign="top" align="left">
  957. <strong>(Only for Ant &lt; 1.4; replaced by the
  958. <code><strong>nowarn</strong></code>
  959. attribute of the <code><strong>&lt;javac&gt;</strong></code>
  960. task after that.)</strong><br />-nowarn
  961. </td>
  962. <td colspan="1" rowspan="1"
  963. valign="top" align="left">
  964. build.compiler.warnings
  965. </td>
  966. <td colspan="1" rowspan="1"
  967. valign="top" align="left">
  968. true == not set
  969. </td>
  970. </tr>
  971. </table>
  972. <p>With Ant &gt;= 1.5, you can also use nested
  973. <code>&lt;compilerarg&gt;</code> elements with the
  974. <code>&lt;javac&gt;</code> task.</p>
  975. <p class="faq">
  976. <a name="shell-redirect-1"></a>
  977. How do I include a &lt; character in my command-line arguments?
  978. </p>
  979. <p>The short answer is "Use: <code>&amp;lt;</code>".</p>
  980. <p>The long answer is that this probably won't do what you
  981. want anyway (see <a href="#shell-redirect-2">the next
  982. section</a>).</p>
  983. <p class="faq">
  984. <a name="shell-redirect-2"></a>
  985. How do I redirect standard input or standard output
  986. in the <code>&lt;exec&gt;</code> task?
  987. </p>
  988. <p>Say you want to redirect the standard output stream of the
  989. <code>m4</code> command to write to a file, something
  990. like:</p>
  991. <pre class="code">
  992. shell-prompt&gt; m4 foo.m4 &gt; foo
  993. </pre>
  994. <p>and try to translate it into</p>
  995. <pre class="code">
  996. &lt;exec executable=&quot;m4&quot;&gt;
  997. &lt;arg value=&quot;foo.m4&quot;/&gt;
  998. &lt;arg value=&quot;&amp;gt;&quot;/&gt;
  999. &lt;arg value=&quot;foo&quot;/&gt;
  1000. &lt;/exec&gt;
  1001. </pre>
  1002. <p>This will not do what you expect. The output redirection is
  1003. performed by your shell, not the command itself, so this
  1004. should read:</p>
  1005. <pre class="code">
  1006. &lt;exec executable=&quot;/bin/sh&quot;&gt;
  1007. &lt;arg value=&quot;-c&quot; /&gt;
  1008. &lt;arg value=&quot;m4 foo.m4 &amp;gt; foo&quot; /&gt;
  1009. &lt;/exec&gt;
  1010. </pre>
  1011. <p>Note that you must use the <code>value</code> attribute of
  1012. <code>&lt;arg&gt;</code> in the last element, in order to have
  1013. the command passed as a single, quoted argument. Alternatively,
  1014. you can use:</p>
  1015. <pre class="code">
  1016. &lt;exec executable=&quot;/bin/sh&quot;&gt;
  1017. &lt;arg line='-c &quot;m4 foo.m4 &amp;gt; foo&quot;'/&gt;
  1018. &lt;/exec&gt;
  1019. </pre>
  1020. <p>Note the double-quotes nested inside the single-quotes.</p>
  1021. <p class="faq">
  1022. <a name="batch-shell-execute"></a>
  1023. How do I execute a batch file or shell script from Ant?
  1024. </p>
  1025. <p>On native Unix systems, you should be able to run shell scripts
  1026. directly. On systems running a Unix-type shell (for example, Cygwin
  1027. on Windows) execute the (command) shell instead - <code>cmd</code>
  1028. for batch files, <code>sh</code> for shell scripts - then pass the
  1029. batch file or shell script (plus any arguments to the script)
  1030. as a single command, using the <code>/c</code> or
  1031. <code>-c</code> switch, respectively. See
  1032. <a href="#shell-redirect-2">the above section</a>
  1033. for example <code>&lt;exec&gt;</code> tasks
  1034. executing <code>sh</code>. For batch files, use something like:</p>
  1035. <pre class="code">
  1036. &lt;exec dir=&quot;.&quot; executable=&quot;cmd&quot; os=&quot;Windows NT&quot;&gt;
  1037. &lt;arg line=&quot;/c test.bat&quot;/&gt;
  1038. &lt;/exec&gt;
  1039. </pre>
  1040. <p class="faq">
  1041. <a name="multi-conditions"></a>
  1042. I want to execute a particular target only if
  1043. multiple conditions are true.
  1044. </p>
  1045. <p>There are actually several answers to this question.</p>
  1046. <p>If you have only one set and one unset property to test,
  1047. you can specify both an <code>if</code> and an <code>unless</code>
  1048. attribute for the target, and they will act as if they
  1049. are "anded" together.</p>
  1050. <p>If you are using a version of Ant 1.3 or earlier, the
  1051. way to work with all other cases is to chain targets together
  1052. to determine the specific state you want to test for.</p>
  1053. <p>To see how this works, assume you have three properties:
  1054. <code>prop1</code>, <code>prop2</code>, and <code>prop3</code>.
  1055. You want to test that <code>prop1</code> and <code>prop2</code>
  1056. are set, and that <code>prop3</code> is not. If the condition
  1057. holds true you want to echo "yes".</p>
  1058. <p>Here is the implementation in Ant 1.3 and earlier:</p>
  1059. <pre class="code">
  1060. &lt;target name=&quot;cond&quot; depends=&quot;cond-if&quot;/&gt;
  1061. &lt;target name=&quot;cond-if&quot; if=&quot;prop1&quot;&gt;
  1062. &lt;antcall target=&quot;cond-if-2&quot;/&gt;
  1063. &lt;/target&gt;
  1064. &lt;target name=&quot;cond-if-2&quot; if=&quot;prop2&quot;&gt;
  1065. &lt;antcall target=&quot;cond-if-3&quot;/&gt;
  1066. &lt;/target&gt;
  1067. &lt;target name=&quot;cond-if-3&quot; unless=&quot;prop3&quot;&gt;
  1068. &lt;echo message=&quot;yes&quot;/&gt;
  1069. &lt;/target&gt;
  1070. </pre>
  1071. <p>Note: <code>&lt;antcall&gt;</code> tasks do <em>not</em> pass
  1072. property changes back up to the environment they were called
  1073. from, so you wouldn't be able to, for example, set a
  1074. <code>result</code> property in the <code>cond-if-3</code> target,
  1075. then do
  1076. <code>&lt;echo message="result is ${result}"/&gt;</code>
  1077. in the <code>cond</code> target.</p>
  1078. <p>Starting with Ant 1.4, you can use the
  1079. <code>&lt;condition&gt;</code> task.</p>
  1080. <pre class="code">
  1081. &lt;target name=&quot;cond&quot; depends=&quot;cond-if,cond-else&quot;/&gt;
  1082. &lt;target name=&quot;check-cond&quot;&gt;
  1083. &lt;condition property=&quot;cond-is-true&quot;&gt;
  1084. &lt;and&gt;
  1085. &lt;not&gt;
  1086. &lt;equals arg1=&quot;${prop1}&quot; arg2=&quot;$${prop1}&quot; /&gt;
  1087. &lt;/not&gt;
  1088. &lt;not&gt;
  1089. &lt;equals arg1=&quot;${prop2}&quot; arg2=&quot;$${prop2}&quot; /&gt;
  1090. &lt;/not&gt;
  1091. &lt;equals arg1=&quot;${prop3}&quot; arg2=&quot;$${prop3}&quot; /&gt;
  1092. &lt;/and&gt;
  1093. &lt;/condition&gt;
  1094. &lt;/target&gt;
  1095. &lt;target name=&quot;cond-if&quot; depends=&quot;check-cond&quot; if=&quot;cond-is-true&quot;&gt;
  1096. &lt;echo message=&quot;yes&quot;/&gt;
  1097. &lt;/target&gt;
  1098. &lt;target name=&quot;cond-else&quot; depends=&quot;check-cond&quot; unless=&quot;cond-is-true&quot;&gt;
  1099. &lt;echo message=&quot;no&quot;/&gt;
  1100. &lt;/target&gt;
  1101. </pre>
  1102. <p>This version takes advantage of two things:</p>
  1103. <ul>
  1104. <li>If a property <code>a</code> has not been set,
  1105. <code>${a}</code> will evaluate to <code>${a}</code>.</li>
  1106. <li>To get a literal <code>$</code> in Ant, you have to
  1107. escape it with another <code>$</code> - this will also break
  1108. the special treatment of the <code>${</code> sequence.</li>
  1109. </ul>
  1110. <p>Because testing for a literal <code>${property}</code> string
  1111. isn't all that readable or easy to understand,
  1112. post-1.4.1 Ant introduces the <code>&lt;isset&gt;</code> element
  1113. to the <code>&lt;condition&gt;</code> task.</p>
  1114. <p>Here is the previous example done using
  1115. <code>&lt;isset&gt;</code>:</p>
  1116. <pre class="code">
  1117. &lt;target name=&quot;check-cond&quot;&gt;
  1118. &lt;condition property=&quot;cond-is-true&quot;&gt;
  1119. &lt;and&gt;
  1120. &lt;isset property=&quot;prop1&quot;/&gt;
  1121. &lt;isset property=&quot;prop2&quot;/&gt;
  1122. &lt;not&gt;
  1123. &lt;isset property=&quot;prop3&quot;/&gt;
  1124. &lt;/not&gt;
  1125. &lt;/and&gt;
  1126. &lt;/condition&gt;
  1127. &lt;/target&gt;
  1128. </pre>
  1129. <p>The last option is to use a scripting language to set the
  1130. properties. This can be particularly handy when you need much
  1131. finer control than the simple conditions shown here but, of
  1132. course, comes with the overhead of adding JAR files to support
  1133. the language, to say nothing of the added maintenance in requiring
  1134. two languages to implement a single system. See the
  1135. <a href="manual/OptionalTasks/script.html">
  1136. <code>&lt;script&gt;</code> task documentation</a> for more
  1137. details.</p>
  1138. <p class="faq">
  1139. <a name="encoding"></a>
  1140. How can I include national characters like German
  1141. umlauts in my build file?
  1142. </p>
  1143. <p>You need to tell the XML parser which character encoding
  1144. your build file uses, this is done inside the <a href="http://www.w3.org/TR/2000/REC-xml-20001006#sec-prolog-dtd">XML
  1145. declaration</a>.</p>
  1146. <p>By default the parser assumes you are using the UTF-8
  1147. encoding instead of your platform's default. For most Western
  1148. European countries you should set the encoding to
  1149. <code>ISO-8859-1</code>. To do so, make the very first line
  1150. of you build file read like</p>
  1151. <pre class="code">
  1152. &lt;?xml version=&quot;1.0&quot; encoding=&quot;ISO-8859-1&quot; ?&gt;
  1153. </pre>
  1154. <p class="faq">
  1155. <a name="use-zip-instead-of-jar"></a>
  1156. How do I use <code>jar</code>'s <code>M</code> switch?
  1157. I don't want a MANIFEST.
  1158. </p>
  1159. <p>A JAR archive is a ZIP file, so if you don't want a
  1160. MANIFEST you can simply use <code>&lt;zip&gt;</code>.</p>
  1161. <p>If your file names contain national characters you should
  1162. know that Sun's <code>jar</code> utility like Ant's
  1163. <code>&lt;jar&gt;</code> uses UTF-8 to encode their names while
  1164. <code>&lt;zip&gt;</code> uses your platforms default encoding.
  1165. Use the encoding attribute of <code>&lt;zip&gt;</code> if
  1166. necessary.</p>
  1167. <p class="faq">
  1168. <a name="propertyvalue-as-name-for-property"></a>
  1169. How can I do something like <code>&lt;property name="prop"
  1170. value="${${anotherprop}}"/&gt;</code> (double expanding the property)?
  1171. </p>
  1172. <p>Without any external help you can not.</p>
  1173. <p>With &lt;script/&gt;, which needs external libraries, you can do</p>
  1174. <pre class="code">
  1175. &lt;script language=&quot;javascript&quot;&gt;
  1176. propname = project.getProperty(&quot;anotherprop&quot;);
  1177. project.setNewProperty(&quot;prop&quot;, propname);
  1178. &lt;/script&gt;
  1179. </pre>
  1180. <p>With AntContrib (external task library) you can do <code>
  1181. &lt;propertycopy name="prop" from="${anotherprop}"/&gt;</code>.</p>
  1182. <p>With Ant 1.6 you can simulate the AntContribs &lt;propertycopy&gt;
  1183. and avoid the need of an external library:</p>
  1184. <pre class="code">
  1185. &lt;macrodef name=&quot;propertycopy&quot;&gt;
  1186. &lt;attribute name=&quot;name&quot;/&gt;
  1187. &lt;attribute name=&quot;from&quot;/&gt;
  1188. &lt;sequential&gt;
  1189. &lt;property name=&quot;@{name}&quot; value=&quot;${@{from}}&quot;/&gt;
  1190. &lt;/sequential&gt;
  1191. &lt;/macrodef&gt;
  1192. </pre>
  1193. <p>With the 'props' antlib (external, but also from Ant) you could
  1194. do the dereferencing with <code>${${anotherprop}</code> - not just
  1195. in the property task - instead everywhere in your buildfile (after
  1196. registering the required property helper).</p>
  1197. <pre class="code">
  1198. &lt;propertyhelper&gt;
  1199. &lt;props:nested /&gt;
  1200. &lt;/propertyhelper&gt;
  1201. &lt;property name=&quot;foo&quot; value=&quot;foo.value&quot; /&gt;
  1202. &lt;property name=&quot;var&quot; value=&quot;foo&quot; /&gt;
  1203. &lt;echo&gt; ${${var}} = foo.value &lt;/echo&gt;</pre>
  1204. <p class="faq">
  1205. <a name="delete-directory-children-only"></a>
  1206. How can I delete everything beneath a particular directory,
  1207. preserving the directory itself?
  1208. </p>
  1209. <p>Most users who go down this path have no problem figuring out that
  1210. <code>&lt;delete includeemptydirs="true" /&gt;</code> will help them. The
  1211. seemingly tricky part is preserving the base directory itself,
  1212. which Ant includes in the directory scan. Fortunately the answer is simple:
  1213. </p>
  1214. <pre class="code">
  1215. &lt;delete includeemptydirs=&quot;true&quot;&gt;
  1216. &lt;fileset dir=&quot;dirtokeep&quot; includes=&quot;**/*&quot; /&gt;
  1217. &lt;/delete&gt;
  1218. </pre>
  1219. <p class="faq">
  1220. <a name="delete-directory-only-if-empty"></a>
  1221. How can I delete a particular directory,
  1222. if and only if it is empty?
  1223. </p>
  1224. <p>Most users who go down this path have no problem figuring
  1225. out that
  1226. <code>&lt;delete includeemptydirs="true" /&gt;</code> will
  1227. help them. The seemingly tricky part is preserving the
  1228. non-empty directories, which Ant includes in the directory
  1229. scan. Fortunately the answer is simple:</p>
  1230. <pre class="code">
  1231. &lt;delete includeemptydirs=&quot;true&quot;&gt;
  1232. &lt;fileset dir=&quot;dirtokeepifnotempty&quot; excludes=&quot;**/*&quot; /&gt;
  1233. &lt;/delete&gt;
  1234. </pre>
  1235. <p class="faq">
  1236. <a name="general-advice"></a>
  1237. General Advice
  1238. </p>
  1239. <p>There are many reasons why Ant doesn't behave as
  1240. expected, not all of them are due to Ant bugs. See our <a href="problems.html">Having Problems?</a> page for hints that
  1241. may help pinning down the reasons for your problem.</p>
  1242. <p class="faq">
  1243. <a name="always-recompiles"></a>
  1244. Why does Ant always recompile all my Java files?
  1245. </p>
  1246. <p>In order to find out which files should be compiled, Ant
  1247. compares the timestamps of the source files to those of the
  1248. resulting <code>.class</code> files. Opening all source files
  1249. to find out which package they belong to would be very
  1250. inefficient. Instead, Ant expects you to place your
  1251. source files in a directory hierarchy that mirrors your
  1252. package hierarchy and to point Ant to the root of this
  1253. directory tree with the <code>srcdir</code> attribute.</p>
  1254. <p>Say you have <code>&lt;javac srcdir="src"
  1255. destdir="dest"/&gt;</code>. If Ant finds a file
  1256. <code>src/a/b/C.java</code>, it expects it to be in package
  1257. <code>a.b</code> so that the resulting <code>.class</code>
  1258. file is going to be <code>dest/a/b/C.class</code>.</p>
  1259. <p>If your source-tree directory structure does not match your
  1260. package structure, Ant's heuristic won't work, and
  1261. it will recompile classes that are up-to-date. Ant is not the
  1262. only tool that expects a source-tree layout like this.</p>
  1263. <p>If you have Java source files that aren't declared to
  1264. be part of any package, you can still use the <code>&lt;javac&gt;</code>
  1265. task to compile these files correctly - just set the
  1266. <code>srcdir</code> and <code>destdir</code> attributes to
  1267. the actual directory the source
  1268. files live in and the directory the class files should go into,
  1269. respectively.</p>
  1270. <p class="faq">
  1271. <a name="defaultexcludes"></a>
  1272. I've used a <code>&lt;delete&gt;</code> task to
  1273. delete unwanted SourceSafe control files (CVS files, editor
  1274. backup files, etc.), but it doesn't seem to work; the files
  1275. never get deleted. What's wrong?
  1276. </p>
  1277. <p>This is probably happening because, by default, Ant excludes
  1278. SourceSafe control files (<code>vssver.scc</code>) and certain other
  1279. files from FileSets.</p>
  1280. <p>Here's what you probably did:</p>
  1281. <pre class="code">
  1282. &lt;delete&gt;
  1283. &lt;fileset dir=&quot;${build.src}&quot; includes=&quot;**/vssver.scc&quot;/&gt;
  1284. &lt;/delete&gt;
  1285. </pre>
  1286. <p>You need to switch off the default exclusions,
  1287. and it will work:</p>
  1288. <pre class="code">
  1289. &lt;delete&gt;
  1290. &lt;fileset dir=&quot;${build.src}&quot; includes=&quot;**/vssver.scc&quot;
  1291. defaultexcludes=&quot;no&quot;/&gt;
  1292. &lt;/delete&gt;
  1293. </pre>
  1294. <p>For a complete listing of the patterns that are excluded
  1295. by default, see <a href="manual/dirtasks.html#defaultexcludes">the user
  1296. manual</a>.</p>
  1297. <p class="faq">
  1298. <a name="stop-dependency"></a>
  1299. I have a target I want to skip if a property is set,
  1300. so I have <code>unless="property"</code> as an attribute
  1301. of the target, but all the targets this target
  1302. depends on are still executed. Why?
  1303. </p>
  1304. <p>The list of dependencies is generated by Ant before any of the
  1305. targets are run. This allows dependent targets, such as an
  1306. <code>init</code> target, to set properties that can control the
  1307. execution of the targets higher in the dependency graph. This
  1308. is a good thing.</p>
  1309. <p>However, when your dependencies break down the
  1310. higher-level task
  1311. into several smaller steps, this behaviour becomes
  1312. counter-intuitive. There are a couple of solutions available:
  1313. </p>
  1314. <ol>
  1315. <li>Put the same condition on each of the dependent targets.</li>
  1316. <li>Execute the steps using <code>&lt;antcall&gt;</code>,
  1317. instead of specifying them inside the <code>depends</code>
  1318. attribute.</li>
  1319. </ol>
  1320. <p class="faq">
  1321. <a name="include-order"></a>
  1322. In my <code>&lt;fileset&gt;</code>, I've put in an
  1323. <code>&lt;exclude&gt;</code> of all files followed by an
  1324. <code>&lt;include&gt;</code> of just the files I want, but it
  1325. isn't giving me any files at all. What's wrong?
  1326. </p>
  1327. <p>The order of the <code>&lt;include&gt;</code> and
  1328. <code>&lt;exclude&gt;</code> tags within a <code>&lt;fileset&gt;</code>
  1329. is ignored when the FileSet is created. Instead, all of the
  1330. <code>&lt;include&gt;</code> elements are processed together,
  1331. followed by all of the <code>&lt;exclude&gt;</code>
  1332. elements. This means that the <code>&lt;exclude&gt;</code>
  1333. elements only apply to the file list produced by the
  1334. <code>&lt;include&gt;</code> elements.</p>
  1335. <p>To get the files you want, focus on just the
  1336. <code>&lt;include&gt;</code> patterns that would be necessary
  1337. to get them. If you find you need to trim the list that the
  1338. <code>&lt;include&gt;</code> elements produce, then use
  1339. <code>&lt;exclude&gt;</code> elements.</p>
  1340. <p class="faq">
  1341. <a name="properties-not-trimmed"></a>
  1342. <code>ant</code> failed to build my program via javac
  1343. even when I put the needed jars in an external
  1344. <code>build.properties</code> file and reference them by
  1345. <code>pathelement</code> or <code>classpath refid</code>.
  1346. </p>
  1347. <p>When <code>ant</code> loads properties from an external
  1348. file it doesn't touch the value of properties, trailing blanks
  1349. will not be trimmed for example.</p>
  1350. <p>If the value represents a file path, like a jar needed to
  1351. compile, the task which requires the value, javac for example
  1352. would fail to compile since it can't find the file due to
  1353. trailing spaces.</p>
  1354. <p class="faq">
  1355. <a name="winzip-lies"></a>
  1356. Ant creates WAR files with a lower-case
  1357. <code>web-inf</code> or JAR files with a lower-case
  1358. <code>meta-inf</code> directory.
  1359. </p>
  1360. <p>No it doesn't.</p>
  1361. <p>You may have seen these lower-case directory names in
  1362. WinZIP, but WinZIP is trying to be helpful (and fails). If
  1363. WinZIP encounters a filename that is all upper-case, it
  1364. assumes it has come from an old DOS box and changes the case to
  1365. all lower-case for you.</p>
  1366. <p>If you extract (or just check) the archive with jar, you
  1367. will see that the names have the correct case.</p>
  1368. <p>With WinZIP (version 8.1 at least), this can be corrected in the
  1369. configuration. In the Options/Configuration menu, in the View tab, General
  1370. section, check the "Allow all upper case files names" box. The META-INF and
  1371. WEB-INF will look correct.</p>
  1372. <p class="faq">
  1373. <a name="NoClassDefFoundError"></a>
  1374. I installed Ant 1.6.x and now get
  1375. <code>Exception in thread "main" java.lang.NoClassDefFoundError:
  1376. </code>
  1377. </p>
  1378. <p>
  1379. The cause of this is that there is an old version of ant somewhere in the
  1380. class path or configuration.
  1381. </p>
  1382. <p>
  1383. A version of this problem happens with jars that are in the classpath
  1384. that include an embedded copy of ant classes.
  1385. An example of this is some copies of weblogic.jar.
  1386. </p>
  1387. <p>
  1388. One can check if this is the case by doing (on unix/sh):
  1389. <code><pre>
  1390. unset CLASSPATH
  1391. ant -version
  1392. </pre>
  1393. </code>
  1394. </p>
  1395. <p class="faq">
  1396. <a name="InstantiationException"></a>
  1397. I installed Ant 1.6.x and now get
  1398. <code>java.lang.InstantiationException: org.apache.tools.ant.Main</code>
  1399. </p>
  1400. <p>
  1401. The cause of this is that there is an old version of ant somewhere in the
  1402. class path or configuration.
  1403. </p>
  1404. <p>
  1405. A version of this problem may be seen on some linux systems.
  1406. Some linux systems (Fedora Core 2 for example), comes with a version
  1407. of ant pre-installed. There is a configuration file called
  1408. <code>/etc/ant.conf</code> which if present, the ant shell
  1409. script will 'dot' include. On Fedora Core 2, the /etc/ant.conf
  1410. file resets the <code>ANT_HOME</code> environment variable to
  1411. <code>/usr/share/ant</code>. This causes the problem that
  1412. an old version of ant (1.5.x in this cause) will be used
  1413. with a new version of the ant script file.
  1414. </p>
  1415. <p>
  1416. One can check if this is the case by doing
  1417. <code>ant --noconfig -version</code>.
  1418. </p>
  1419. <p class="faq">
  1420. <a name="mangled-manifest"></a>
  1421. Whenever I use the Ant jar or manifest related tasks, long lines in
  1422. my manifest are wrapped at 70 characters and the resulting jar does
  1423. not work in my application server. Why does Ant do this?
  1424. </p>
  1425. <p>
  1426. Ant implements the Java
  1427. <a href="http://java.sun.com/j2se/1.4.2/docs/guide/jar/jar.html">Jar
  1428. file specification</a>. Please refer to the notes section where it
  1429. discusses the maximum allowable length of a line and the concept of
  1430. continuation characters.
  1431. </p>
  1432. <p>
  1433. If a jar file produced by Ant does not work in your appserver, and
  1434. that failure is due to the wrapped manifest, then you need
  1435. to consult your appserver provider, as it is a bug in their
  1436. appserver. Far more likely, however, is a problem in your
  1437. specification of your classpath. It is not Ant's wrapping of your
  1438. classpath that is the problem.
  1439. </p>
  1440. <p>
  1441. Do not raise a bug about this issue until you have checked to ensure
  1442. that the problem is not due to your classpath specification.
  1443. </p>
  1444. <p class="faq">
  1445. <a name="CreateProcess_error_2"></a>
  1446. <code>&lt;exec&gt;</code> fails with <code>"Cannot run
  1447. program "...":CreateProcess error=2"</code> on
  1448. Windows.
  1449. </p>
  1450. <p>A common problem is not having the executable on the
  1451. PATH. In case you get an error message <code>Cannot run
  1452. program "...":CreateProcess error=2. The system cannot find
  1453. the path specified.</code> have a look at your PATH
  1454. variable.</p>
  1455. <p>Just type the command directly on the command line and if
  1456. Windows finds it, Ant should do it too. (Otherwise ask on
  1457. the user mailinglist for help.) If Windows can not execute
  1458. the program add the directory of the programm to the PATH
  1459. (<code>set PATH=%PATH%;dirOfProgram</code>) or specify the
  1460. absolute path in the <code>executable</code> attribute in
  1461. your buildfile.</p>
  1462. <p class="faq">
  1463. <a name="integration"></a>
  1464. Is Ant supported by my IDE/Editor?
  1465. </p>
  1466. <p>See the <a href="external.html#IDE and Editor Integration">section
  1467. on IDE integration</a> on our External Tools and Tasks page.</p>
  1468. <p class="faq">
  1469. <a name="emacs-mode"></a>
  1470. Why doesn't (X)Emacs/vi/MacOS X's project builder
  1471. correctly parse the error messages generated by Ant?
  1472. </p>
  1473. <p>Ant adds a "banner" with the name of the current
  1474. task in front of all logging messages - and there are no built-in
  1475. regular expressions in your editor that would account for
  1476. this.</p>
  1477. <p>You can disable this banner by invoking Ant with the
  1478. <code>-emacs</code> switch. To make Ant autodetect
  1479. Emacs' compile mode, put this into your
  1480. <code>.antrc</code> (contributed by Ville Skytt).</p>
  1481. <pre class="code">
  1482. # Detect (X)Emacs compile mode
  1483. if [ &quot;$EMACS&quot; = &quot;t&quot; ] ; then
  1484. ANT_ARGS=&quot;$ANT_ARGS -emacs&quot;
  1485. ANT_OPTS=&quot;$ANT_OPTS -Dbuild.compiler.emacs=true&quot;
  1486. fi
  1487. </pre>
  1488. <p>Alternatively, you can add the following snippet to your
  1489. <code>.emacs</code> to make Emacs understand Ant's
  1490. output.</p>
  1491. <pre class="code">
  1492. (require 'compile)
  1493. (setq compilation-error-regexp-alist
  1494. (append (list
  1495. ;; works for jikes
  1496. '(&quot;^\\s-*\\[[^]]*\\]\\s-*\\(.+\\):\\([0-9]+\\):\\([0-9]+\\):[0-9]+:[0-9]+:&quot; 1 2 3)
  1497. ;; works for javac
  1498. '(&quot;^\\s-*\\[[^]]*\\]\\s-*\\(.+\\):\\([0-9]+\\):&quot; 1 2))
  1499. compilation-error-regexp-alist))
  1500. </pre>
  1501. <p>Yet another alternative that preserves most of Ant's
  1502. formatting is to pipe Ant's output through the following Perl
  1503. script by Dirk-Willem van Gulik:</p>
  1504. <pre class="code">
  1505. #!/usr/bin/perl
  1506. #
  1507. # May 2001 dirkx@apache.org - remove any
  1508. # [foo] lines from the output; keeping
  1509. # spacing more or less there.
  1510. #
  1511. $|=1;
  1512. while(&lt;STDIN&gt;) {
  1513. if (s/^(\s+)\[(\w+)\]//) {
  1514. if ($2 ne $last) {
  1515. print &quot;$1\[$2\]&quot;;
  1516. $s = ' ' x length($2);
  1517. } else {
  1518. print &quot;$1 $s &quot;;
  1519. };
  1520. $last = $2;
  1521. };
  1522. print;
  1523. };
  1524. </pre>
  1525. <p class="faq">
  1526. <a name="dtd"></a>
  1527. Is there a DTD that I can use to validate my build
  1528. files?
  1529. </p>
  1530. <p>An incomplete DTD can be created by the
  1531. <code>&lt;antstructure&gt;</code> task - but this one
  1532. has a few problems:</p>
  1533. <ul>
  1534. <li>It doesn't know about required attributes. Only
  1535. manual tweaking of this file can help here.</li>
  1536. <li>It is not complete - if you add new tasks via
  1537. <code>&lt;taskdef&gt;</code> it won't know about it. See
  1538. <a href="http://www.sdv.fr/pages/casa/html/ant-dtd.en.html">this
  1539. page</a> by Michel Casabianca for a solution to this
  1540. problem. Note that the DTD you can download at this page
  1541. is based on Ant 0.3.1.</li>
  1542. <li>It may even be an invalid DTD. As Ant allows tasks
  1543. writers to define arbitrary elements, name collisions will
  1544. happen quite frequently - if your version of Ant contains
  1545. the optional <code>&lt;test&gt;</code> and
  1546. <code>&lt;junit&gt;</code> tasks, there are two XML
  1547. elements named <code>test</code> (the task and the nested child
  1548. element of <code>&lt;junit&gt;</code>) with different attribute
  1549. lists. This problem cannot be solved; DTDs don't give a
  1550. syntax rich enough to support this.</li>
  1551. </ul>
  1552. <p class="faq">
  1553. <a name="xml-entity-include"></a>
  1554. How do I include an XML snippet in my build file?
  1555. </p>
  1556. <p>You can use XML's way of including external files and let
  1557. the parser do the job for Ant:</p>
  1558. <pre class="code">
  1559. &lt;?xml version=&quot;1.0&quot;?&gt;
  1560. &lt;!DOCTYPE project [
  1561. &lt;!ENTITY common SYSTEM &quot;common.xml&quot;&gt;
  1562. ]&gt;
  1563. &lt;project name=&quot;test&quot; default=&quot;test&quot; basedir=&quot;.&quot;&gt;
  1564. &lt;target name=&quot;setup&quot;&gt;
  1565. ...
  1566. &lt;/target&gt;
  1567. &amp;common;
  1568. ...
  1569. &lt;/project&gt;
  1570. </pre>
  1571. <p>will literally include the contents of <code>common.xml</code> where
  1572. you've placed the <code>&amp;common;</code> entity.</p>
  1573. <p>(The filename <code>common.xml</code> in this example is resolved
  1574. relative to the containing XML file by the XML parser. You may also use
  1575. an absolute <code>file:</code> protocol URI.)</p>
  1576. <p>In combination with a DTD, this would look like this:</p>
  1577. <pre class="code">
  1578. &lt;!DOCTYPE project PUBLIC &quot;-//ANT//DTD project//EN&quot; &quot;ant.dtd&quot; [
  1579. &lt;!ENTITY include SYSTEM &quot;header.xml&quot;&gt;
  1580. ]&gt;
  1581. </pre>
  1582. <p>Starting with Ant 1.6, there is a new
  1583. <code>&lt;import&gt;</code> task that can (also) be used to
  1584. include build file fragments. Unlike the snippets used with
  1585. entity includes, the referenced files have to be complete Ant
  1586. build files, though.</p>
  1587. <p>The example above would become:</p>
  1588. <pre class="code">
  1589. &lt;?xml version=&quot;1.0&quot;?&gt;
  1590. &lt;project name=&quot;test&quot; default=&quot;test&quot; basedir=&quot;.&quot;&gt;
  1591. &lt;target name=&quot;setup&quot;&gt;
  1592. ...
  1593. &lt;/target&gt;
  1594. &lt;import file=&quot;./common.xml&quot;/&gt;
  1595. ...
  1596. &lt;/project&gt;
  1597. </pre>
  1598. <p>Unlike entity includes, <code>&lt;import&gt;</code> will
  1599. let you use Ant properties in the file name.</p>
  1600. <p class="faq">
  1601. <a name="mail-logger"></a>
  1602. How do I send an email with the result of my build
  1603. process?
  1604. </p>
  1605. <p>If you are using a nightly build of Ant 1.5 after
  1606. 2001-12-14, you can use the built-in MailLogger:</p>
  1607. <pre class="code">
  1608. ant -logger org.apache.tools.ant.listener.MailLogger
  1609. </pre>
  1610. <p>See the <a href="http://svn.apache.org/repos/asf/ant/core/trunk/docs/manual/listeners.html">Listeners
  1611. &amp; Loggers</a> documentation for details on the properties
  1612. required.</p>
  1613. <p>For older versions of Ant, you can use a custom
  1614. BuildListener that sends out an email
  1615. in the buildFinished() method. Will Glozer
  1616. &lt;will.glozer@jda.com&gt; has written such a listener based
  1617. on <a href="http://java.sun.com/products/javamail/">JavaMail</a>.
  1618. The source is:</p>
  1619. <pre class="code">
  1620. import java.io.*;
  1621. import java.util.*;
  1622. import javax.mail.*;
  1623. import javax.mail.internet.*;
  1624. import org.apache.tools.ant.*;
  1625. /**
  1626. * A simple listener that waits for a build to finish and sends an email
  1627. * of the results. The settings are stored in &quot;monitor.properties&quot; and
  1628. * are fairly self explanatory.
  1629. *
  1630. * @author Will Glozer
  1631. * @version 1.05a 09/06/2000
  1632. */
  1633. public class BuildMonitor implements BuildListener {
  1634. protected Properties props;
  1635. /**
  1636. * Create a new BuildMonitor.
  1637. */
  1638. public BuildMonitor() throws Exception {
  1639. props = new Properties();
  1640. InputStream is = getClass().getResourceAsStream(&quot;monitor.properties&quot;);
  1641. props.load(is);
  1642. is.close();
  1643. }
  1644. public void buildStarted(BuildEvent e) {
  1645. }
  1646. /**
  1647. * Determine the status of the build and the actions to follow, now that
  1648. * the build has completed.
  1649. *
  1650. * @param e Event describing the build status.
  1651. */
  1652. public void buildFinished(BuildEvent e) {
  1653. Throwable th = e.getException();
  1654. String status = (th != null) ? &quot;failed&quot; : &quot;succeeded&quot;;
  1655. try {
  1656. String key = &quot;build.&quot; + status;
  1657. if (props.getProperty(key + &quot;.notify&quot;).equalsIgnoreCase(&quot;false&quot;)) {
  1658. return;
  1659. }
  1660. Session session = Session.getDefaultInstance(props, null);
  1661. MimeMessage message = new MimeMessage(session);
  1662. message.addRecipients(Message.RecipientType.TO, parseAddresses(
  1663. props.getProperty(key + &quot;.email.to&quot;)));
  1664. message.setSubject(props.getProperty(key + &quot;.email.subject&quot;));
  1665. BufferedReader br = new BufferedReader(new FileReader(
  1666. props.getProperty(&quot;build.log&quot;)));
  1667. StringWriter sw = new StringWriter();
  1668. String line = br.readLine();
  1669. while (line != null) {
  1670. sw.write(line);
  1671. sw.write(&quot;\n&quot;);
  1672. line = br.readLine();
  1673. }
  1674. br.close();
  1675. message.setText(sw.toString(), &quot;UTF-8&quot;);
  1676. sw.close();
  1677. Transport transport = session.getTransport();
  1678. transport.connect();
  1679. transport.send(message);
  1680. transport.close();
  1681. } catch (Exception ex) {
  1682. System.out.println(&quot;BuildMonitor failed to send email!&quot;);
  1683. ex.printStackTrace();
  1684. }
  1685. }
  1686. /**
  1687. * Parse a comma separated list of internet email addresses.
  1688. *
  1689. * @param s The list of addresses.
  1690. * @return Array of Addresses.
  1691. */
  1692. protected Address[] parseAddresses(String s) throws Exception {
  1693. StringTokenizer st = new StringTokenizer(s, &quot;,&quot;);
  1694. Address[] addrs = new Address[st.countTokens()];
  1695. for (int i = 0; i &lt; addrs.length; i++) {
  1696. addrs[i] = new InternetAddress(st.nextToken());
  1697. }
  1698. return addrs;
  1699. }
  1700. public void messageLogged(BuildEvent e) {
  1701. }
  1702. public void targetStarted(BuildEvent e) {
  1703. }
  1704. public void targetFinished(BuildEvent e) {
  1705. }
  1706. public void taskStarted(BuildEvent e) {
  1707. }
  1708. public void taskFinished(BuildEvent e) {
  1709. }
  1710. }
  1711. </pre>
  1712. <p>With a <code>monitor.properties</code> like this:</p>
  1713. <pre class="code">
  1714. # configuration for build monitor
  1715. mail.transport.protocol=smtp
  1716. mail.smtp.host=&lt;host&gt;
  1717. mail.from=Will Glozer &lt;will.glozer@jda.com&gt;
  1718. build.log=build.log
  1719. build.failed.notify=true
  1720. build.failed.email.to=will.glozer@jda.com
  1721. build.failed.email.subject=Nightly build failed!
  1722. build.succeeded.notify=true
  1723. build.succeeded.email.to=will.glozer@jda.com
  1724. build.succeeded.email.subject=Nightly build succeeded!
  1725. </pre>
  1726. <p><code>monitor.properties</code> should be placed right next
  1727. to your compiled <code>BuildMonitor.class</code>. To use it,
  1728. invoke Ant like:</p>
  1729. <pre class="code">
  1730. ant -listener BuildMonitor -logfile build.log
  1731. </pre>
  1732. <p>Make sure that <code>mail.jar</code> from JavaMail and
  1733. <code>activation.jar</code> from the
  1734. <a href="http://java.sun.com/products/javabeans/glasgow/jaf.html">Java
  1735. Beans Activation Framework</a> are in your <code>CLASSPATH</code>.</p>
  1736. <p class="faq">
  1737. <a name="listener-properties"></a>
  1738. How do I get at the properties that Ant was running
  1739. with from inside BuildListener?
  1740. </p>
  1741. <p>You can get at a hashtable with all the properties that Ant
  1742. has been using through the BuildEvent parameter. For
  1743. example:</p>
  1744. <pre class="code">
  1745. public void buildFinished(BuildEvent e) {
  1746. Hashtable table = e.getProject().getProperties();
  1747. String buildpath = (String)table.get(&quot;build.path&quot;);
  1748. ...
  1749. }
  1750. </pre>
  1751. <p>This is more accurate than just reading the same property
  1752. files that your project does, since it will give the correct
  1753. results for properties that were specified on the Ant command line.</p>
  1754. <p class="faq">
  1755. <a name="input-makes-exec-hang"></a>
  1756. <code>&lt;exec&gt;</code> causes other tasks to hang
  1757. or leads to strange behaviour of <code>&lt;input&gt;</code>
  1758. tasks.
  1759. </p>
  1760. <p>When Ant forks a new process for example by using the
  1761. <code>&lt;exec&gt;</code>, <code>&lt;apply&gt;</code>
  1762. or <code>&lt;java&gt;</code> tasks, it will also start a
  1763. new thread reading from standard input and sending
  1764. everything that it has read to that process.</p>
  1765. <p>Unfortunately Ant has no way to know whether the forked
  1766. process is ever going to read any input, so it will start such
  1767. a thread even if the process doesn't need one.</p>
  1768. <p>This behaviour leads to strange side effects like the Ant
  1769. process
  1770. being <a href="https://issues.apache.org/bugzilla/show_bug.cgi?id=34461">suspended
  1771. when a build forking new process is run as a background
  1772. process</a> on Unix-like systems or
  1773. <code>&lt;input&gt;</code>
  1774. tasks <a href="https://issues.apache.org/bugzilla/show_bug.cgi?id=41024">requiring
  1775. additional inputs</a> if they come after
  1776. an <code>&lt;exec&gt;</code> task.</p>
  1777. <p>Fortunately there is a workaround for this, always specify
  1778. <code>inputstring=""</code> for
  1779. any <code>&lt;exec&gt;</code> task (or one of its sibblings)
  1780. if you know the forked process doesn't consume any
  1781. input.</p>
  1782. <p class="faq">
  1783. <a name="javac-stackoverflow"></a>
  1784. <code>&lt;javac&gt;</code> causes a
  1785. StackOverflowError
  1786. </p>
  1787. <p>For some Java source files it is possible
  1788. that <a href="https://issues.apache.org/bugzilla/show_bug.cgi?id=45370">causes
  1789. a StackOverlowError</a> is thrown inside Sun's javac
  1790. compiler. As far as we can tell this is not triggered by a
  1791. bug in Ant.</p>
  1792. <p>It is possible to work around this problem by setting
  1793. <code>&lt;javac&gt;</code>'s fork attribute to true.</p>
  1794. <p class="faq">
  1795. <a name="170-requires-junit"></a>
  1796. Ant 1.7.0 doesn't build from sources without
  1797. JUnit
  1798. </p>
  1799. <p>When building Ant 1.7.0 from the source release without
  1800. junit.jar the build fails with the message "We cannot build
  1801. the test jar unless JUnit is present".</p>
  1802. <p>With Ant 1.7.0 we've started to add ant-testutil.jar as
  1803. part of the distribution and this causes a hard dependency on
  1804. JUnit - at least in version 1.7.0. Unfortunately the
  1805. installation docs don't say so.</p>
  1806. <p>There are two workarounds:</p>
  1807. <ol>
  1808. <li>Add junit.jar to your CLASSPATH when building Ant.</li>
  1809. <li>Change Ant's buildfile and remove test-jar from the
  1810. depends list of the dist-lite target.</li>
  1811. </ol>
  1812. <p class="faq">
  1813. <a name="remove-cr"></a>
  1814. &lt;chmod&gt; or &lt;exec&gt; doesn't work in Ant
  1815. 1.3 on Unix
  1816. </p>
  1817. <p>The <code>antRun</code> script in <code>ANT_HOME/bin</code>
  1818. has DOS instead of Unix line endings; you must remove the
  1819. carriage-return characters from this file. This can be done by
  1820. using Ant's <code>&lt;fixcrlf&gt;</code> task
  1821. or something like:</p>
  1822. <pre class="code">
  1823. tr -d '\r' &lt; $ANT_HOME/bin/antRun &gt; /tmp/foo
  1824. mv /tmp/foo $ANT_HOME/bin/antRun
  1825. </pre>
  1826. <p class="faq">
  1827. <a name="delegating-classloader"></a>
  1828. &lt;style&gt; or &lt;junit&gt; ignores my
  1829. &lt;classpath&gt;
  1830. </p>
  1831. <p>Starting with Ant 1.7.0, &lt;junit&gt; will honor your
  1832. nested &lt;classpath&gt;.</p>
  1833. <p>These tasks don't ignore your classpath setting, you
  1834. are facing a common problem with delegating classloaders.</p>
  1835. <p>This question collects a common type of problem: A task
  1836. needs an external library and it has a nested classpath
  1837. element so that you can point it to this external library, but
  1838. that doesn't work unless you put the external library
  1839. into the <code>CLASSPATH</code> or place it in
  1840. <code>ANT_HOME/lib</code>.</p>
  1841. <p>Some background is necessary before we can discuss
  1842. solutions for <a href="#delegating-classloader-1.5">Ant
  1843. 1.5.x</a> and <a href="#delegating-classloader-1.6">Ant
  1844. 1.6.x</a>.</p>
  1845. <p>When you specify a nested <code>&lt;classpath&gt;</code> in
  1846. Ant, Ant creates a new class loader that uses the path you
  1847. have specified. It then tries to load additional classes from
  1848. this classloader.</p>
  1849. <p>In most cases - for example using &lt;style&gt; or
  1850. &lt;junit&gt; - Ant doesn't load the external library
  1851. directly, it is the loaded class that does so.</p>
  1852. <p>In the case of <code>&lt;junit&gt;</code> it is the task
  1853. implementation itself and in the case of
  1854. <code>&lt;style&gt;</code> it is the implementation of the
  1855. <code>org.apache.tools.ant.taskdefs.XSLTLiaison</code>
  1856. class.</p>
  1857. <p><em>As of Ant 1.7</em> <code>&lt;junit&gt;</code> no longer
  1858. requires you to have <code>junit.jar</code> in Ant's startup
  1859. classpath even if <code>ant-junit.jar</code> is present there.</p>
  1860. <p>Ant's class loader implementation uses Java's
  1861. delegation model, see <a href="http://java.sun.com/products/jdk/1.2/docs/api/java/lang/ClassLoader.html">http://java.sun.com/products/jdk/1.2/docs/api/java/lang/ClassLoader.html</a>
  1862. the paragraph</p>
  1863. <blockquote>The <code>ClassLoader</code> class uses a
  1864. delegation model to search for classes and resources. Each
  1865. instance of <code>ClassLoader</code> has an associated parent
  1866. class loader. When called upon to find a class or resource, a
  1867. <code>ClassLoader</code> instance will delegate the search for
  1868. the class or resource to its parent class loader before
  1869. attempting to find the class or resource itself. The virtual
  1870. machine's built-in class loader, called the bootstrap
  1871. class loader, does not itself have a parent but may serve as
  1872. the parent of a <code>ClassLoader</code>
  1873. instance.</blockquote>
  1874. <p>The possible solutions depend on the version of Ant you
  1875. use, see the next sections.</p>
  1876. <p class="faq">
  1877. <a name="delegating-classloader-1.5"></a>
  1878. &lt;style&gt; or &lt;junit&gt; ignores my
  1879. &lt;classpath&gt; - Ant 1.5.x version
  1880. </p>
  1881. <p>Please read <a href="#delegating-classloader">the previous
  1882. entry</a> before you go ahead.</p>
  1883. <p>First of all let's state that Ant's wrapper script
  1884. (<code>ant</code> or <code>ant.bat</code>) adds all
  1885. <code>.jar</code> files from <code>ANT_HOME/lib</code> to
  1886. <code>CLASSPATH</code>, therefore "in
  1887. <code>CLASSPATH</code>" shall mean "either in your
  1888. <code>CLASSPATH</code> environment variable or
  1889. <code>ANT_HOME/lib</code>" for the rest of this
  1890. answer.</p>
  1891. <p>The root of the problem is that the class that needs the
  1892. external library is on the <code>CLASSPATH</code>.</p>
  1893. <p>Let's see what happens when you load the &lt;junit&gt;
  1894. task. Ant's class loader will consult the
  1895. bootstrap class loader first, which tries to load classes from
  1896. <code>CLASSPATH</code>. The bootstrap class loader
  1897. doesn't know anything about Ant's class loader or
  1898. even the path you have specified.</p>
  1899. <p>If the bootstrap class loader can load the class Ant has
  1900. asked it to load (which it can if <code>optional.jar</code> is
  1901. part of <code>CLASSPATH</code>), this class will try to load
  1902. the external library from <code>CLASSPATH</code> as well - it
  1903. doesn't know anything else - and will not find it unless
  1904. the library is in <code>CLASSPATH</code> as well.</p>
  1905. <p>To solve this, you have two major options:</p>
  1906. <ol>
  1907. <li>put all external libraries you need in
  1908. <code>CLASSPATH</code> as well this is not what you want,
  1909. otherwise you wouldn't have found this FAQ entry.</li>
  1910. <li>remove the class that loads the external library from
  1911. the <code>CLASSPATH</code>.</li>
  1912. </ol>
  1913. <p>The easiest way to do this is to remove
  1914. <code>optional.jar</code> from <code>ANT_HOME/lib</code>. If
  1915. you do so, you will have to <code>&lt;taskdef&gt;</code> all
  1916. optional tasks and use nested <code>&lt;classpath&gt;</code>
  1917. elements in the <code>&lt;taskdef&gt;</code> tasks that point
  1918. to the new location of <code>optional.jar</code>. Also,
  1919. don't forget to add the new location of
  1920. <code>optional.jar</code> to the
  1921. <code>&lt;classpath&gt;</code> of your
  1922. <code>&lt;style&gt;</code> or <code>&lt;junit&gt;</code>
  1923. task.</p>
  1924. <p>If you want to avoid to <code>&lt;taskdef&gt;</code> all
  1925. optional tasks you need, the only other option is to remove
  1926. the classes that should not be loaded via the bootstrap class
  1927. loader from <code>optional.jar</code> and put them into a
  1928. separate archive. Add this separate archive to the
  1929. <code>&lt;classpath&gt;</code> of your
  1930. <code>&lt;style&gt;</code> or <code>&lt;junit&gt;</code> task
  1931. - and make sure the separate archive is not in
  1932. <code>CLASSPATH</code>.</p>
  1933. <p>In the case of <code>&lt;junit&gt;</code> you'd have
  1934. to remove all classes that are in the
  1935. <code>org/apache/tools/ant/taskdefs/optional/junit</code>
  1936. directory, in the <code>&lt;style&gt;</code> case it is one of
  1937. the <code>*Liaison</code> classes in
  1938. <code>org/apache/tools/ant/taskdefs/optional</code>.</p>
  1939. <p>If you use the option to break up <code>optional.jar</code>
  1940. for <code>&lt;junit&gt;</code> or remove
  1941. <code>ant-junit.jar</code>, you still have to use a
  1942. <code>&lt;taskdef&gt;</code> with a nested
  1943. <code>&lt;classpath&gt;</code> to define the junit task.</p>
  1944. <p class="faq">
  1945. <a name="delegating-classloader-1.6"></a>
  1946. &lt;style&gt; or &lt;junit&gt; ignores my
  1947. &lt;classpath&gt; - Ant 1.6.x version
  1948. </p>
  1949. <p>Please read <a href="#delegating-classloader">the general
  1950. entry</a> before you go ahead.</p>
  1951. <p>The wrapper script of Ant 1.6.x no longer adds the contents
  1952. of <code>ANT_HOME/lib</code> to <code>CLASSPATH</code>,
  1953. instead Ant will create a classloader on top of the bootstrap
  1954. classloader - let's call it the coreloader for the rest of
  1955. this answer - which holds the contents of
  1956. <code>ANT_HOME/lib</code>. Ant's core and its tasks will be
  1957. loaded through this classloader and not the bootstrap
  1958. classloader.</p>
  1959. <p>This causes some small but notable differences between Ant
  1960. 1.5.x and 1.6.x. Most importantly, a third-party task that is
  1961. part of <code>CLASSPATH</code> will no longer work in Ant
  1962. 1.6.x since the task now can't find Ant's classes. In a sense
  1963. this is the same problem this entry is about, only
  1964. <code>ant.jar</code> has become the external library in
  1965. question now.</p>
  1966. <p>This coreloader also holds the contents of
  1967. <code>~/.ant/lib</code> and any file or directory that has
  1968. been specified using Ant's <code>-lib</code> command line
  1969. argument.</p>
  1970. <p>Let's see what happens when you load the &lt;junit&gt;
  1971. task. Ant's class loader will consult the bootstrap
  1972. class loader first, which tries to load classes from
  1973. <code>CLASSPATH</code>. The bootstrap class loader
  1974. doesn't know anything about Ant's class loader or
  1975. even the path you have specified. If it fails to find the
  1976. class using the bootstrap classloader it will try the
  1977. coreloader next. Again, the coreloader doesn't know anything
  1978. about your path.</p>
  1979. <p>If the coreloader can load the class Ant has asked it to
  1980. load (which it can if <code>ant-junit.jar</code> is in
  1981. <code>ANT_HOME/lib</code>), this class will try to load the
  1982. external library from coreloader as well - it doesn't
  1983. know anything else - and will not find it unless the library
  1984. is in <code>CLASSPATH</code> or the coreloader as well.</p>
  1985. <p>To solve this, you have the following major options:</p>
  1986. <ol>
  1987. <li>put all external libraries you need in
  1988. <code>CLASSPATH</code> as well this is not what you want,
  1989. otherwise you wouldn't have found this FAQ entry.</li>
  1990. <li>put all external libraries you need in
  1991. <code>ANT_HOME/lib</code> or <code>.ant/lib</code>. This
  1992. probably still isn't what you want, but you might reconsider
  1993. the <code>.ant/lib</code> option.</li>
  1994. <li>Always start Ant with the <code>-lib</code> command line
  1995. switch and point to your external libraries (or the
  1996. directories holding them).</li>
  1997. <li>remove the class that loads the external library from
  1998. the coreloader.</li>
  1999. </ol>
  2000. <p>In Ant 1.6 <code>optional.jar</code> has been split into
  2001. multiple jars, each one containing classes with the same
  2002. dependencies on external libraries. You can move the
  2003. "offending" jar out of <code>ANT_HOME/lib</code>. For the
  2004. <code>&lt;junit&gt;</code> task it would be
  2005. <code>ant-junit.jar</code>.</p>
  2006. <p>If you do so, you will have to <code>&lt;taskdef&gt;</code>
  2007. all optional tasks that need the external library and use
  2008. nested <code>&lt;classpath&gt;</code> elements in the
  2009. <code>&lt;taskdef&gt;</code> tasks that point to the new
  2010. location of <code>ant-*.jar</code>. Also, don't forget
  2011. to add the new location of <code>ant-*.jar</code> to the
  2012. <code>&lt;classpath&gt;</code> of your
  2013. <code>&lt;style&gt;</code> or <code>&lt;junit&gt;</code>
  2014. task.</p>
  2015. <p>For example</p>
  2016. <pre class="code">
  2017. &lt;taskdef name=&quot;junit&quot;
  2018. class=&quot;org.apache.tools.ant.taskdefs.optional.junit.JUnitTask&quot;&gt;
  2019. &lt;classpath&gt;
  2020. &lt;pathelement location=&quot;HOME-OF/junit.jar&quot;/&gt;
  2021. &lt;pathelement location=&quot;NEW-HOME-OF/ant-junit.jar&quot;/&gt;
  2022. &lt;/classpath&gt;
  2023. &lt;/taskdef&gt;
  2024. </pre>
  2025. <p class="faq">
  2026. <a name="unknownelement.taskcontainer"></a>
  2027. Why do my custom task containers see Unknown Elements in Ant 1.6
  2028. - they worked in Ant 1.5?
  2029. </p>
  2030. <p>
  2031. The objects added in TaskContainer.addTask(Task task)
  2032. have changed from Tasks to UnknownElements.
  2033. </p>
  2034. <p>
  2035. There was a number of valid reasons for this change. But the backward
  2036. compatibility problems were not noticed until after Ant 1.6.0 was
  2037. released.
  2038. </p>
  2039. <p>
  2040. Your container class will need to be modified to check if the Task
  2041. is an UnknownElement and call perform on it to
  2042. convert it to a Task and to execute it.
  2043. (see apache.tools.ant.taskdefs.Sequential)
  2044. </p>
  2045. <p>
  2046. If you want to do more processing on the task,
  2047. you need to use the techniques in apache.tools.ant.taskdefs.Antlib#execute()
  2048. This does make use of one 1.6 method call (UE#getRealObject()),
  2049. you need to use UE#getTask() instead - this will
  2050. return null for non tasks (types like fileset id=x).
  2051. </p>
  2052. <p>
  2053. So.. iterate over the tasks, if they are UEs, convert them to
  2054. tasks, using UE#maybeConfigure and UE#getTask()
  2055. </p>
  2056. <pre class="code">
  2057. for (Iterator i = tasks.iterator(); i.hasNext();) {
  2058. Task t = (Task) i.next();
  2059. if (t instanceof UnknownElement) {
  2060. ((UnknownElement) t).maybeConfigure();
  2061. t = ((UnknownElement) t).getTask();
  2062. if (t == null) {
  2063. continue;
  2064. }
  2065. }
  2066. // .... original Custom code
  2067. }
  2068. </pre>
  2069. <p>
  2070. This approach should work for ant1.5 and ant1.6.
  2071. </p>
  2072. <p class="faq">
  2073. <a name="oom-on-mac"></a>
  2074. Ant runs into an infinite loop/throws an OutOfMemoryError
  2075. when I compile my project under Mac OS X.
  2076. </p>
  2077. <p>Apple's Java VMs reside
  2078. in <code>/System/Library/Frameworks/JavaVM.framework/Versions/X.Y.Z</code>
  2079. and <code>JAVA_HOME</code> will usually be something
  2080. like <code>/System/Library/Frameworks/JavaVM.framework/Versions/X.Y.Z/Home</code>.</p>
  2081. <p>Inside this home directory there is a symbolic link
  2082. named <code>shared_bundle</code> that links three levels up,
  2083. i.e. to <code>/System/Library/Frameworks/JavaVM.framework</code>.</p>
  2084. <p>If your build file contains a <code>fileset</code> like</p>
  2085. <pre class="code">
  2086. &lt;fileset dir=&quot;${java.home}&quot; includes=&quot;**/*.jar&quot;/&gt;
  2087. </pre>
  2088. <p>Ant is going to follow the <code>shared_bundle</code>
  2089. symlink and ends up recursing into all your installed VMs.
  2090. Even worse, it will
  2091. enter <code>/System/Library/Frameworks/JavaVM.framework/Versions/X.Y.Z/Home</code>
  2092. and will once again follow the same symlink.</p>
  2093. <p>Ant versions after Ant 1.7.1 will detect the infinite loop
  2094. they are in, but the resulting fileset may still be too big to
  2095. deal with, in particular if you have many different VM
  2096. versions installed. The problem is amplified by the fact that
  2097. each installed version has a <code>shared_bundle</code>
  2098. symlink in it.</p>
  2099. <p>One solution is to not allow the fileset to follow symbolic
  2100. links at all, like in</p>
  2101. <pre class="code">
  2102. &lt;fileset dir=&quot;${java.home}&quot; includes=&quot;**/*.jar&quot; followsymlinks=&quot;false&quot;/&gt;
  2103. </pre>
  2104. <p>another one excludes the <code>shared_bundle</code>
  2105. directories:</p>
  2106. <pre class="code">
  2107. &lt;fileset dir=&quot;${java.home}&quot; includes=&quot;**/*.jar&quot; excludes=&quot;**/shared_bundle/**&quot;/&gt;
  2108. </pre>
  2109. <p>For Ant 1.7.1 and earlier
  2110. excluding <code>shared_bundle</code> may not be enough since
  2111. there is another symlink <code>bundle</code> that points to
  2112. the <code>Home</code> directory and will cause infite
  2113. recursions as well.</p>
  2114. <p class="faq">
  2115. <a name="extension-point-and-import"></a>
  2116. <code>extension-point</code> doesn't work
  2117. with <code>import</code> like the documentation
  2118. states.
  2119. </p>
  2120. <p>Yes, there is
  2121. a <a href="https://issues.apache.org/bugzilla/show_bug.cgi?id=48804">bug
  2122. in Ant 1.8.0</a>.</p>
  2123. <p>When using two build files like</p>
  2124. <pre class="code">
  2125. importing.xml:
  2126. &lt;project&gt;
  2127. ...
  2128. &lt;import file=&quot;imported.xml&quot;/&gt;
  2129. &lt;target name=&quot;bar&quot; extensionOf=&quot;foo&quot;/&gt;
  2130. &lt;/project&gt;
  2131. imported.xml:
  2132. &lt;project&gt;
  2133. &lt;extension-point name=&quot;foo&quot;/&gt;
  2134. &lt;/project&gt;
  2135. </pre>
  2136. <p>Ant 1.8.0 will fail, claiming there was no extension point
  2137. named "foo".</p>
  2138. <p>This bug has been fixed for Ant 1.8.1. For Ant 1.8.0 there
  2139. is
  2140. a <a href="https://issues.apache.org/bugzilla/show_bug.cgi?id=48804#c9">work-around</a>:
  2141. add an additional layer of importing like in</p>
  2142. <pre class="code">
  2143. importing.xml:
  2144. &lt;project&gt;
  2145. &lt;target name=&quot;bar&quot; extensionOf=&quot;foo&quot;/&gt;
  2146. &lt;/project&gt;
  2147. imported.xml:
  2148. &lt;project&gt;
  2149. &lt;extension-point name=&quot;foo&quot;/&gt;
  2150. &lt;/project&gt;
  2151. build.xml:
  2152. &lt;project&gt;
  2153. &lt;import file=&quot;imported.xml&quot;/&gt;
  2154. &lt;import file=&quot;importing.xml&quot;/&gt;
  2155. &lt;/project&gt;
  2156. </pre>
  2157. </div>
  2158. </div>
  2159. <p class="copyright">
  2160. <script type="text/javascript" language="JavaScript"><!--
  2161. document.write(" - "+"Last Published: " + document.lastModified);
  2162. // -->
  2163. </script>
  2164. </p>
  2165. </body>
  2166. </html>