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 KiB

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