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.

javac.html 33 KiB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842
  1. <!--
  2. Licensed to the Apache Software Foundation (ASF) under one or more
  3. contributor license agreements. See the NOTICE file distributed with
  4. this work for additional information regarding copyright ownership.
  5. The ASF licenses this file to You under the Apache License, Version 2.0
  6. (the "License"); you may not use this file except in compliance with
  7. the License. You may obtain a copy of the License at
  8. http://www.apache.org/licenses/LICENSE-2.0
  9. Unless required by applicable law or agreed to in writing, software
  10. distributed under the License is distributed on an "AS IS" BASIS,
  11. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12. See the License for the specific language governing permissions and
  13. limitations under the License.
  14. -->
  15. <html lang="en-us">
  16. <head>
  17. <meta http-equiv="Content-Language" content="en-us">
  18. <link rel="stylesheet" type="text/css" href="../stylesheets/style.css">
  19. <title>Javac Task</title>
  20. </head>
  21. <body>
  22. <h2><a name="javac">Javac</a></h2>
  23. <h3>Description</h3>
  24. <p>Compiles a Java source tree.</p>
  25. <p>The source and destination directory will be recursively scanned for Java
  26. source files to compile. Only Java files that have no corresponding
  27. <code>.class</code> file
  28. or where the class file is older than the
  29. <code>.java</code> file will be compiled.</p>
  30. <p>Note: Apache Ant uses only the names of the source and class files to find
  31. the classes that need a rebuild. It will not scan the source and therefore
  32. will have no knowledge about nested classes, classes that are named different
  33. from the source file, and so on. See the
  34. <a href="../Tasks/depend.html"><code>&lt;depend&gt;</code></a> task
  35. for dependency checking based on other than just
  36. existence/modification times.</p>
  37. <p>When the source files are part of a package, the directory structure of
  38. the source tree should follow the package
  39. hierarchy.</p>
  40. <p>It is possible to refine the set of files that are being compiled.
  41. This can be done with the <code>includes</code>, <code>includesfile</code>,
  42. <code>excludes</code>, and <code>excludesfile</code>
  43. attributes. With the <code>includes</code> or
  44. <code>includesfile</code> attribute, you specify the files you want to
  45. have included.
  46. The <code>exclude</code> or <code>excludesfile</code> attribute is used
  47. to specify
  48. the files you want to have excluded. In both cases, the list of files
  49. can be specified by either the filename, relative to the directory(s) specified
  50. in the <code>srcdir</code> attribute or nested <code>&lt;src&gt;</code>
  51. element(s), or by using wildcard patterns. See the section on
  52. <a href="../dirtasks.html#directorybasedtasks">directory-based tasks</a>,
  53. for information on how the
  54. inclusion/exclusion of files works, and how to write wildcard patterns.</p>
  55. <p>It is possible to use different compilers. This can be specified by
  56. either setting the global <code>build.compiler</code> property, which will
  57. affect all <code>&lt;javac&gt;</code> tasks throughout the build, by
  58. setting the <code>compiler</code> attribute, specific to the current
  59. <code>&lt;javac&gt;</code> task or by using a nested element of any
  60. <a href="typedef.html">typedef</a>fed or
  61. <a href="componentdef.html">componentdef</a>fed type that implements
  62. <code>org.apache.tools.ant.taskdefs.compilers.CompilerAdapter</code>.
  63. <a name="compilervalues">Valid values for either the
  64. <code>build.compiler</code> property or the <code>compiler</code>
  65. attribute are:</a></p>
  66. <ul>
  67. <li><code>classic</code> (the standard compiler of JDK 1.1/1.2) &ndash;
  68. <code>javac1.1</code> and
  69. <code>javac1.2</code> can be used as aliases.</li>
  70. <li><code>modern</code> (the standard compiler of JDK 1.3/1.4/1.5/1.6/1.7) &ndash;
  71. <code>javac1.3</code> and
  72. <code>javac1.4</code> and
  73. <code>javac1.5</code> and
  74. <code>javac1.6</code> and
  75. <code>javac1.7</code> (<em>since Ant 1.8.2</em>) can be used as aliases.</li>
  76. <li><code>jikes</code> (the <a
  77. href="http://jikes.sourceforge.net/" target="_top">Jikes</a>
  78. compiler).</li>
  79. <li><code>jvc</code> (the Command-Line Compiler from Microsoft's SDK
  80. for Java / Visual J++) &ndash; <code>microsoft</code> can be used
  81. as an alias.</li>
  82. <li><code>kjc</code> (the <a href="http://www.dms.at/kopi/" target="_top">kopi</a>
  83. compiler).</li>
  84. <li><code>gcj</code> (the gcj compiler from gcc).</li>
  85. <li><code>sj</code> (Symantec java compiler) &ndash;
  86. <code>symantec</code> can be used as an alias.</li>
  87. <li><code>extJavac</code> (run either modern or classic in a JVM of
  88. its own).</li>
  89. </ul>
  90. <p>The default is <code>javac1.x</code> with <code>x</code> depending
  91. on the JDK version you use while you are running Ant.
  92. If you wish to use a different compiler interface than those
  93. supplied, you can write a class that implements the CompilerAdapter interface
  94. (<code>package org.apache.tools.ant.taskdefs.compilers</code>). Supply the full
  95. classname in the <code>build.compiler</code> property or the
  96. <code>compiler</code> attribute.
  97. </p>
  98. <p>The fork attribute overrides the <code>build.compiler</code> property
  99. or <code>compiler</code> attribute setting and
  100. expects a JDK1.1 or higher to be set in <code>JAVA_HOME</code>.
  101. </p>
  102. <p>You can also use the <code>compiler</code> attribute to tell Ant
  103. which JDK version it shall assume when it puts together the command
  104. line switches - even if you set <code>fork=&quot;true&quot;</code>.
  105. This is useful if you want to run the compiler of JDK 1.1 while you
  106. current JDK is 1.2+. If you use
  107. <code>compiler=&quot;javac1.1&quot;</code> and (for example)
  108. <code>depend=&quot;true&quot;</code> Ant will use the command line
  109. switch <code>-depend</code> instead of <code>-Xdepend</code>.</p>
  110. <p>This task will drop all entries that point to non-existent
  111. files/directories from the classpath it passes to the compiler.</p>
  112. <p>The working directory for a forked executable (if any) is the
  113. project's base directory.</p>
  114. <p><strong>Windows Note:</strong>When the modern compiler is used
  115. in unforked mode on Windows, it locks up the files present in the
  116. classpath of the <code>&lt;javac&gt;</code> task, and does not release them.
  117. The side effect of this is that you will not be able to delete or move
  118. those files later on in the build. The workaround is to fork when
  119. invoking the compiler.</p>
  120. <h3>Parameters</h3>
  121. <table border="1" cellpadding="2" cellspacing="0">
  122. <tr>
  123. <td valign="top"><b>Attribute</b></td>
  124. <td valign="top"><b>Description</b></td>
  125. <td align="center" valign="top"><b>Required</b></td>
  126. </tr>
  127. <tr>
  128. <td valign="top">srcdir</td>
  129. <td valign="top">Location of the java files. (See the
  130. <a href="#srcdirnote">note</a> below.)</td>
  131. <td align="center" valign="top">Yes, unless nested <code>&lt;src&gt;</code> elements are present.</td>
  132. </tr>
  133. <tr>
  134. <td valign="top">destdir</td>
  135. <td valign="top">Location to store the class files.</td>
  136. <td align="center" valign="top">No</td>
  137. </tr>
  138. <tr>
  139. <td valign="top">includes</td>
  140. <td valign="top">Comma- or space-separated list of files (may be specified using
  141. wildcard patterns) that must be
  142. included; all <code>.java</code> files are included when omitted.</td>
  143. <td valign="top" align="center">No</td>
  144. </tr>
  145. <tr>
  146. <td valign="top">includesfile</td>
  147. <td valign="top">The name of a file that contains a list of files to
  148. include (may be specified using wildcard patterns).</td>
  149. <td valign="top" align="center">No</td>
  150. </tr>
  151. <tr>
  152. <td valign="top">excludes</td>
  153. <td valign="top">Comma- or space-separated list of files (may be specified using
  154. wildcard patterns) that must be excluded; no files (except default
  155. excludes) are excluded when omitted.</td>
  156. <td valign="top" align="center">No</td>
  157. </tr>
  158. <tr>
  159. <td valign="top">excludesfile</td>
  160. <td valign="top">The name of a file that contains a list of files to
  161. exclude (may be specified using wildcard patterns).</td>
  162. <td valign="top" align="center">No</td>
  163. </tr>
  164. <tr>
  165. <td valign="top">classpath</td>
  166. <td valign="top">The classpath to use.</td>
  167. <td align="center" valign="top">No</td>
  168. </tr>
  169. <tr>
  170. <td valign="top">sourcepath</td>
  171. <td valign="top">The sourcepath to use; defaults to the value of the srcdir attribute (or nested <code>&lt;src&gt;</code> elements).
  172. To suppress the sourcepath switch, use <code>sourcepath=&quot;&quot;</code>.</td>
  173. <td align="center" valign="top">No</td>
  174. </tr>
  175. <tr>
  176. <td valign="top">bootclasspath</td>
  177. <td valign="top">
  178. Location of bootstrap class files. (See <a href="#bootstrap">below</a>
  179. for using the -X and -J-X parameters for specifing
  180. the bootstrap classpath).
  181. </td>
  182. <td align="center" valign="top">No</td>
  183. </tr>
  184. <tr>
  185. <td valign="top">classpathref</td>
  186. <td valign="top">The classpath to use, given as a
  187. <a href="../using.html#references">reference</a> to a path defined elsewhere.</td>
  188. <td align="center" valign="top">No</td>
  189. </tr>
  190. <tr>
  191. <td valign="top">sourcepathref</td>
  192. <td valign="top">The sourcepath to use, given as a
  193. <a href="../using.html#references">reference</a> to a path defined elsewhere.</td>
  194. <td align="center" valign="top">No</td>
  195. </tr>
  196. <tr>
  197. <td valign="top">bootclasspathref</td>
  198. <td valign="top">Location of bootstrap class files, given as a
  199. <a href="../using.html#references">reference</a> to a path defined elsewhere.</td>
  200. <td align="center" valign="top">No</td>
  201. </tr>
  202. <tr>
  203. <td valign="top">extdirs</td>
  204. <td valign="top">Location of installed extensions.</td>
  205. <td align="center" valign="top">No</td>
  206. </tr>
  207. <tr>
  208. <td valign="top">encoding</td>
  209. <td valign="top">Encoding of source files. (Note: gcj doesn't support
  210. this option yet.)</td>
  211. <td align="center" valign="top">No</td>
  212. </tr>
  213. <tr>
  214. <td valign="top">nowarn</td>
  215. <td valign="top">Indicates whether the <code>-nowarn</code> switch
  216. should be passed to the compiler; defaults to <code>off</code>.</td>
  217. <td align="center" valign="top">No</td>
  218. </tr>
  219. <tr>
  220. <td valign="top">debug</td>
  221. <td valign="top">Indicates whether source should be compiled with
  222. debug information; defaults to <code>off</code>. If set to
  223. <code>off</code>, <code>-g:none</code> will be passed on the
  224. command line for compilers that support it (for other compilers, no
  225. command line argument will be used). If set to <code>true</code>,
  226. the value of the <code>debuglevel</code> attribute determines the
  227. command line argument.</td>
  228. <td align="center" valign="top">No</td>
  229. </tr>
  230. <tr>
  231. <td valign="top">debuglevel</td>
  232. <td valign="top">Keyword list to be appended to the <code>-g</code>
  233. command-line switch. This will be ignored by all implementations except
  234. <code>modern</code>, <code>classic(ver &gt;= 1.2)</code> and <code>jikes</code>.
  235. Legal values are <code>none</code> or a comma-separated list of the
  236. following keywords:
  237. <code>lines</code>, <code>vars</code>, and <code>source</code>.
  238. If <code>debuglevel</code> is not specified, by default,
  239. nothing will be
  240. appended to <code>-g</code>. If <code>debug</code> is not turned on,
  241. this attribute will be ignored.
  242. </td>
  243. <td align="center" valign="top">No</td>
  244. </tr>
  245. <tr>
  246. <td valign="top">optimize</td>
  247. <td valign="top">
  248. Indicates whether source should be compiled with
  249. optimization; defaults to <code>off</code>. <strong>Note</strong>
  250. that this flag is just ignored by Sun's <code>javac</code> starting
  251. with JDK 1.3 (since compile-time optimization is unnecessary).
  252. </td>
  253. <td align="center" valign="top">No</td>
  254. </tr>
  255. <tr>
  256. <td valign="top">deprecation</td>
  257. <td valign="top">Indicates whether source should be compiled with
  258. deprecation information; defaults to <code>off</code>.</td>
  259. <td align="center" valign="top">No</td>
  260. </tr>
  261. <tr>
  262. <td valign="top">target</td>
  263. <td valign="top">Generate class files for specific VM version
  264. (e.g., <code>1.1</code> or <code>1.2</code>). <b>Note that the
  265. default value depends on the JVM that is running Ant. In
  266. particular, if you use JDK 1.4+ the generated classes will not be
  267. usable for a 1.1 Java VM unless you explicitly set this attribute
  268. to the value 1.1 (which is the default value for JDK 1.1 to
  269. 1.3). We highly recommend to always specify this
  270. attribute.</b><br>
  271. A default value for this attribute can be provided using the magic
  272. <a
  273. href="../javacprops.html#target"><code>ant.build.javac.target</code></a>
  274. property.</td>
  275. <td align="center" valign="top">No</td>
  276. </tr>
  277. <tr>
  278. <td valign="top">verbose</td>
  279. <td valign="top">Asks the compiler for verbose output; defaults to
  280. <code>no</code>.</td>
  281. <td align="center" valign="top">No</td>
  282. </tr>
  283. <tr>
  284. <td valign="top">depend</td> <td valign="top">Enables dependency-tracking
  285. for compilers that support this (<code>jikes</code> and
  286. <code>classic</code>).</td>
  287. <td align="center" valign="top">No</td>
  288. </tr>
  289. <tr>
  290. <td valign="top">includeAntRuntime</td>
  291. <td valign="top">Whether to include the Ant run-time libraries in the
  292. classpath; defaults to <code>yes</code>, unless
  293. <a href="../sysclasspath.html"><code>build.sysclasspath</code></a> is set.
  294. <em>It is usually best to set this to false</em> so the script's behavior is not
  295. sensitive to the environment in which it is run.</td>
  296. <td align="center" valign="top">No</td>
  297. </tr>
  298. <tr>
  299. <td valign="top">includeJavaRuntime</td>
  300. <td valign="top">Whether to include the default run-time
  301. libraries from the executing VM in the classpath;
  302. defaults to <code>no</code>.<br/>
  303. <b>Note:</b> In some setups the run-time libraries may be part
  304. of the "Ant run-time libraries" so you may need to explicitly
  305. set includeAntRuntime to false to ensure that the Java
  306. run-time libraries are not included.</td>
  307. <td align="center" valign="top">No</td>
  308. </tr>
  309. <tr>
  310. <td valign="top">fork</td>
  311. <td valign="top">Whether to execute <code>javac</code> using the
  312. JDK compiler externally; defaults to <code>no</code>.</td>
  313. <td align="center" valign="top">No</td>
  314. </tr>
  315. <tr>
  316. <td valign="top">executable</td>
  317. <td valign="top">Complete path to the <code>javac</code>
  318. executable to use in case of <code>fork=&quot;yes&quot;</code>.
  319. Defaults to the compiler of the Java version that is currently
  320. running Ant. Ignored if <code>fork=&quot;no&quot;</code>.<br>
  321. Since Ant 1.6 this attribute can also be used to specify the
  322. path to the executable when using jikes, jvc, gcj or sj.</td>
  323. <td align="center" valign="top">No</td>
  324. </tr>
  325. <tr>
  326. <td valign="top">memoryInitialSize</td>
  327. <td valign="top">The initial size of the memory for the underlying VM,
  328. if <code>javac</code> is run externally; ignored otherwise. Defaults
  329. to the standard VM memory setting.
  330. (Examples: <code>83886080</code>, <code>81920k</code>, or
  331. <code>80m</code>)</td>
  332. <td align="center" valign="top">No</td>
  333. </tr>
  334. <tr>
  335. <td valign="top">memoryMaximumSize</td>
  336. <td valign="top">The maximum size of the memory for the underlying VM,
  337. if <code>javac</code> is run externally; ignored otherwise. Defaults
  338. to the standard VM memory setting.
  339. (Examples: <code>83886080</code>, <code>81920k</code>, or
  340. <code>80m</code>)</td>
  341. <td align="center" valign="top">No</td>
  342. </tr>
  343. <tr>
  344. <td valign="top">failonerror</td>
  345. <td valign="top">Indicates whether compilation errors
  346. will fail the build; defaults to <code>true</code>.</td>
  347. <td align="center" valign="top">No</td>
  348. </tr>
  349. <tr>
  350. <td valign="top">errorProperty</td>
  351. <td valign="top">
  352. The property to set (to the value "true") if compilation fails.
  353. <em>Since Ant 1.7.1</em>.
  354. </td>
  355. <td align="center" valign="top">No</td>
  356. </tr>
  357. <tr>
  358. <td valign="top">source</td>
  359. <td valign="top">Value of the <code>-source</code> command-line
  360. switch; will be ignored by all implementations prior to
  361. <code>javac1.4</code> (or <code>modern</code> when Ant is not
  362. running in a 1.3 VM), <code>gcj</code> and <code>jikes</code>.<br>
  363. If you use this attribute together with <code>gcj</code>
  364. or <code>jikes</code>, you must make sure that your version
  365. supports the <code>-source</code> (or <code>-fsource</code> for
  366. gcj)
  367. switch. By default, no <code>-source</code> argument will be used
  368. at all.<br>
  369. <b>Note that the default value depends on the JVM that is running
  370. Ant. We highly recommend to always specify this
  371. attribute.</b><br>
  372. A default value for this attribute can be provided using the magic
  373. <a
  374. href="../javacprops.html#source"><code>ant.build.javac.source</code></a>
  375. property.</td>
  376. <td align="center" valign="top">No</td>
  377. </tr>
  378. <tr>
  379. <td valign="top">compiler</td>
  380. <td valign="top">The compiler implementation to use.
  381. If this attribute is not set, the value of the
  382. <code>build.compiler</code> property, if set, will be used.
  383. Otherwise, the default compiler for the current VM will be used.
  384. (See the above <a href="#compilervalues">list</a> of valid
  385. compilers.)</td>
  386. <td align="center" valign="top">No</td>
  387. </tr>
  388. <tr>
  389. <td valign="top">listfiles</td>
  390. <td valign="top">Indicates whether the source files to be compiled will
  391. be listed; defaults to <code>no</code>.</td>
  392. <td align="center" valign="top">No</td>
  393. </tr>
  394. <tr>
  395. <td valign="top">tempdir</td>
  396. <td valign="top">Where Ant should place temporary files.
  397. This is only used if the task is forked and the
  398. command line args length exceeds 4k.
  399. <em>Since Ant 1.6</em>.</td>
  400. <td align="center" valign="top">
  401. No; default is <i>java.io.tmpdir</i>.
  402. </td>
  403. </tr>
  404. <tr>
  405. <td valign="top">updatedProperty</td>
  406. <td valign="top">
  407. The property to set (to the value "true")
  408. if compilation has taken place
  409. and has been successful.
  410. <em>Since Ant 1.7.1</em>.
  411. </td>
  412. <td align="center" valign="top">No</td>
  413. </tr>
  414. <tr>
  415. <td valign="top">includeDestClasses</td>
  416. <td valign="top">
  417. This attribute controls whether to include the
  418. destination classes directory in the classpath
  419. given to the compiler.
  420. The default value of this is "true" and this
  421. means that previously compiled classes are on
  422. the classpath for the compiler. This means that "greedy" compilers
  423. will not recompile dependant classes that are already compiled.
  424. In general this is a good thing as it stops the compiler
  425. for doing unnecessary work. However, for some edge cases,
  426. involving generics, the javac compiler
  427. needs to compile the dependant classes to get the generics
  428. information. One example is documented in the bug report:
  429. <a href="http://issues.apache.org/bugzilla/show_bug.cgi?id=40776">
  430. Bug 40776 - a problem compiling a Java 5 project with generics</a>.
  431. Setting the attribute to "false" will cause the compiler
  432. to recompile dependent classes.
  433. <em>Since Ant 1.7.1</em>.
  434. </td>
  435. <td align="center" valign="top">No - default is "true"</td>
  436. </tr>
  437. </table>
  438. <h3>Parameters specified as nested elements</h3>
  439. <p>This task forms an implicit <a href="../Types/fileset.html">FileSet</a> and
  440. supports most attributes of <code>&lt;fileset&gt;</code>
  441. (<code>dir</code> becomes <code>srcdir</code>) as well as the nested
  442. <code>&lt;include&gt;</code>, <code>&lt;exclude&gt;</code> and
  443. <code>&lt;patternset&gt;</code> elements.</p>
  444. <h4><code>srcdir</code>, <code>classpath</code>, <code>sourcepath</code>,
  445. <code>bootclasspath</code> and <code>extdirs</code></h4>
  446. <p><code>&lt;javac&gt;</code>'s <code>srcdir</code>, <code>classpath</code>,
  447. <code>sourcepath</code>, <code>bootclasspath</code>, and
  448. <code>extdirs</code> attributes are
  449. <a href="../using.html#path">path-like structures</a>
  450. and can also be set via nested
  451. <code>&lt;src&gt;</code> (note the different name!),
  452. <code>&lt;classpath&gt;</code>,
  453. <code>&lt;sourcepath&gt;</code>,
  454. <code>&lt;bootclasspath&gt;</code> and
  455. <code>&lt;extdirs&gt;</code> elements, respectively.</p>
  456. <h4>compilerarg</h4>
  457. <p>You can specify additional command line arguments for the compiler
  458. with nested <code>&lt;compilerarg&gt;</code> elements. These elements
  459. are specified like <a href="../using.html#arg">Command-line
  460. Arguments</a> but have an additional attribute that can be used to
  461. enable arguments only if a given compiler implementation will be
  462. used.</p>
  463. <table border="1" cellpadding="2" cellspacing="0">
  464. <tr>
  465. <td width="12%" valign="top"><b>Attribute</b></td>
  466. <td width="78%" valign="top"><b>Description</b></td>
  467. <td width="10%" valign="top"><b>Required</b></td>
  468. </tr>
  469. <tr>
  470. <td valign="top">value</td>
  471. <td align="center" rowspan="4">See
  472. <a href="../using.html#arg">Command-line Arguments</a>.</td>
  473. <td align="center" rowspan="4">Exactly one of these.</td>
  474. </tr>
  475. <tr>
  476. <td valign="top">line</td>
  477. </tr>
  478. <tr>
  479. <td valign="top">file</td>
  480. </tr>
  481. <tr>
  482. <td valign="top">path</td>
  483. </tr>
  484. <tr>
  485. <td valign="top">prefix</td>
  486. <td align="center" rowspan="2">See
  487. <a href="../using.html#arg">Command-line Arguments</a>.
  488. <em>Since Ant 1.8.</em></td>
  489. <td valign="top" align="center">No</td>
  490. </tr>
  491. <tr>
  492. <td valign="top">suffix</td>
  493. <td valign="top" align="center">No</td>
  494. </tr>
  495. <tr>
  496. <td valign="top">compiler</td>
  497. <td>Only pass the specified argument if the chosen
  498. compiler implementation matches the value of this attribute.
  499. Legal values are the
  500. same as those in the above <a href="#compilervalues">list</a> of valid
  501. compilers.)</td>
  502. <td align="center">No</td>
  503. </tr>
  504. </table>
  505. <h4>compilerclasspath <em>since Ant 1.8.0</em></h4>
  506. <p>A <a href="../using.html#path">PATH like structure</a> holding the
  507. classpath to use when loading the compiler implementation if a
  508. custom class has been specified. Doesn't have any effect when
  509. using one of the built-in compilers.</p>
  510. <h4>Any nested element of a type that implements CompilerAdapter
  511. <em>since Ant 1.8.0</em></h4>
  512. <p>If a defined type implements the <code>CompilerAdapter</code>
  513. interface a nested element of that type can be used as an
  514. alternative to the <code>compiler</code> attribute.</p>
  515. <h3>Examples</h3>
  516. <pre> &lt;javac srcdir=&quot;${src}&quot;
  517. destdir=&quot;${build}&quot;
  518. classpath=&quot;xyz.jar&quot;
  519. debug=&quot;on&quot;
  520. source=&quot;1.4&quot;
  521. /&gt;</pre>
  522. <p>compiles all <code>.java</code> files under the <code>${src}</code>
  523. directory, and stores
  524. the <code>.class</code> files in the <code>${build}</code> directory.
  525. The classpath used includes <code>xyz.jar</code>, and compiling with
  526. debug information is on. The source level is 1.4,
  527. so you can use <code>assert</code> statements.</p>
  528. <pre> &lt;javac srcdir=&quot;${src}&quot;
  529. destdir=&quot;${build}&quot;
  530. fork=&quot;true&quot;
  531. source=&quot;1.2&quot;
  532. target=&quot;1.2&quot;
  533. /&gt;</pre>
  534. <p>compiles all <code>.java</code> files under the <code>${src}</code>
  535. directory, and stores the <code>.class</code> files in the
  536. <code>${build}</code> directory. This will fork off the javac
  537. compiler using the default <code>javac</code> executable.
  538. The source level is 1.2 (similar to 1.1 or 1.3) and
  539. the class files should be runnable under JDK 1.2+ as well.</p>
  540. <pre> &lt;javac srcdir=&quot;${src}&quot;
  541. destdir=&quot;${build}&quot;
  542. fork=&quot;java$$javac.exe&quot;
  543. source=&quot;1.5&quot;
  544. /&gt;</pre>
  545. <p>compiles all <code>.java</code> files under the <code>${src}</code>
  546. directory, and stores the <code>.class</code> files in the
  547. <code>${build}</code> directory. This will fork off the javac
  548. compiler, using the executable named <code>java$javac.exe</code>. Note
  549. that the <code>$</code> sign needs to be escaped by a second one.
  550. The source level is 1.5, so you can use generics.</p>
  551. <pre> &lt;javac srcdir=&quot;${src}&quot;
  552. destdir=&quot;${build}&quot;
  553. includes=&quot;mypackage/p1/**,mypackage/p2/**&quot;
  554. excludes=&quot;mypackage/p1/testpackage/**&quot;
  555. classpath=&quot;xyz.jar&quot;
  556. debug=&quot;on&quot;
  557. /&gt;</pre>
  558. <p>compiles <code>.java</code> files under the <code>${src}</code>
  559. directory, and stores the
  560. <code>.class</code> files in the <code>${build}</code> directory.
  561. The classpath used includes <code>xyz.jar</code>, and debug information is on.
  562. Only files under <code>mypackage/p1</code> and <code>mypackage/p2</code> are
  563. used. All files in and below the <code>mypackage/p1/testpackage</code>
  564. directory are excluded from compilation.
  565. You didn't specify a source or target level,
  566. so the actual values used will depend on which JDK you ran Ant with.</p>
  567. <pre> &lt;javac srcdir=&quot;${src}:${src2}&quot;
  568. destdir=&quot;${build}&quot;
  569. includes=&quot;mypackage/p1/**,mypackage/p2/**&quot;
  570. excludes=&quot;mypackage/p1/testpackage/**&quot;
  571. classpath=&quot;xyz.jar&quot;
  572. debug=&quot;on&quot;
  573. /&gt;</pre>
  574. <p>is the same as the previous example, with the addition of a second
  575. source path, defined by
  576. the property <code>src2</code>. This can also be represented using nested
  577. <code>&lt;src&gt;</code> elements as follows:</p>
  578. <pre> &lt;javac destdir=&quot;${build}&quot;
  579. classpath=&quot;xyz.jar&quot;
  580. debug=&quot;on&quot;&gt;
  581. &lt;src path=&quot;${src}&quot;/&gt;
  582. &lt;src path=&quot;${src2}&quot;/&gt;
  583. &lt;include name=&quot;mypackage/p1/**&quot;/&gt;
  584. &lt;include name=&quot;mypackage/p2/**&quot;/&gt;
  585. &lt;exclude name=&quot;mypackage/p1/testpackage/**&quot;/&gt;
  586. &lt;/javac&gt;</pre>
  587. <p>If you want to run the javac compiler of a different JDK, you
  588. should tell Ant, where to find the compiler and which version of JDK
  589. you will be using so it can choose the correct command line switches.
  590. The following example executes a JDK 1.1 javac in a new process and
  591. uses the correct command line switches even when Ant is running in a
  592. Java VM of a different version:</p>
  593. <pre> &lt;javac srcdir=&quot;${src}&quot;
  594. destdir=&quot;${build}&quot;
  595. fork=&quot;yes&quot;
  596. executable=&quot;/opt/java/jdk1.1/bin/javac&quot;
  597. compiler=&quot;javac1.1&quot;
  598. /&gt;</pre>
  599. <p><a name="srcdirnote"><b>Note:</b></a>
  600. If you wish to compile only source files located in certain packages below a
  601. common root, use the <code>include</code>/<code>exclude</code> attributes
  602. or <code>&lt;include&gt;</code>/<code>&lt;exclude&gt;</code> nested elements
  603. to filter for these packages. Do not include part of your package structure
  604. in the <code>srcdir</code> attribute
  605. (or nested <code>&lt;src&gt;</code> elements), or Ant will recompile your
  606. source files every time you run your compile target. See the
  607. <a href="http://ant.apache.org/faq.html#always-recompiles">Ant FAQ</a>
  608. for additional information.</p>
  609. <p>
  610. If you wish to compile only files explicitly specified and disable
  611. javac's default searching mechanism then you can unset the sourcepath
  612. attribute:
  613. <pre> &lt;javac sourcepath=&quot;&quot; srcdir=&quot;${src}&quot;
  614. destdir=&quot;${build}&quot; &gt;
  615. &lt;include name="**/*.java"/&gt;
  616. &lt;exclude name="**/Example.java"/&gt;
  617. &lt;/javac&gt;</pre>
  618. That way the javac will compile all java source files under &quot;${src}&quot;
  619. directory but skip the examples. The compiler will even produce errors if some of
  620. the non-example files refers to them.
  621. </p>
  622. <p>
  623. If you wish to compile with a special JDK (another than the one Ant is currently using),
  624. set the <code>executable</code> and <code>fork</code> attribute. Using <code>taskname</code>
  625. could show in the log, that these settings are fix.
  626. <pre> &lt;javac srcdir=&quot;&quot;
  627. destdir=&quot;&quot;
  628. executable=&quot;path-to-java14-home/bin/javac&quot;
  629. fork=&quot;true&quot;
  630. taskname=&quot;javac1.4&quot; /&gt;</pre>
  631. </p>
  632. <p><b>Note:</b> If you are using Ant on Windows and a new DOS window pops up
  633. for every use of an external compiler, this may be a problem of the JDK you are
  634. using. This problem may occur with all JDKs &lt; 1.2.</p>
  635. <p>
  636. If you want to activate other compiler options like <i>lint</i> you could use
  637. the <tt>&lt;compilerarg&gt;</tt> element:
  638. <pre> &lt;javac srcdir="${src.dir}"
  639. destdir="${classes.dir}"
  640. classpathref="libraries"&gt;
  641. &lt;compilerarg value="-Xlint"/&gt;
  642. &lt;/javac&gt; </pre>
  643. </p>
  644. <p>If you want to use a custom
  645. CompilerAdapter <code>org.example.MyAdapter</code> you can either
  646. use the compiler attribute:</p>
  647. <pre>
  648. &lt;javac srcdir="${src.dir}"
  649. destdir="${classes.dir}"
  650. compiler="org.example.MyAdapter"/&gt;
  651. </pre>
  652. <p>or a define a type and nest this into the task like in:</p>
  653. <pre>
  654. &lt;componentdef classname="org.example.MyAdapter"
  655. name="myadapter"/&gt;
  656. &lt;javac srcdir="${src.dir}"
  657. destdir="${classes.dir}"&gt;
  658. &lt;myadapter/&gt;
  659. &lt;/javac&gt;
  660. </pre>
  661. <p>in which case your compiler adapter can support attributes and
  662. nested elements of its own.</p>
  663. <h3>Jikes Notes</h3>
  664. <p>You need Jikes 1.15 or later.</p>
  665. <p>Jikes supports some extra options, which can be set be defining
  666. the properties shown below prior to invoking the task. The setting
  667. for each property will be in affect for all <code>&lt;javac&gt;</code>
  668. tasks throughout the build.
  669. The Ant developers are aware that
  670. this is ugly and inflexible &ndash; expect a better solution in the future.
  671. All the options are boolean, and must be set to <code>true</code> or
  672. <code>yes</code> to be
  673. interpreted as anything other than false. By default,
  674. <code>build.compiler.warnings</code> is <code>true</code>,
  675. while all others are <code>false</code>.</p>
  676. <table border="1" cellpadding="2" cellspacing="0">
  677. <tr>
  678. <td valign="top"><b>Property</b></td>
  679. <td valign="top"><b>Description</b></td>
  680. <td align="center" valign="top"><b>Default</b></td>
  681. </tr>
  682. <tr>
  683. <td valign="top">
  684. build.compiler.emacs
  685. </td>
  686. <td valign="top">
  687. Enable emacs-compatible error messages.
  688. </td>
  689. <td valign="top">
  690. <code>false</code>
  691. </td>
  692. </tr>
  693. <tr>
  694. <td valign="top">
  695. build.compiler.fulldepend
  696. </td>
  697. <td valign="top">
  698. Enable full dependency checking; see<br>
  699. the <code>+F</code> switch in the Jikes manual.
  700. </td>
  701. <td valign="top">
  702. <code>false</code>
  703. </td>
  704. </tr>
  705. <tr>
  706. <td valign="top">
  707. build.compiler.pedantic
  708. </td>
  709. <td valign="top">
  710. Enable pedantic warnings.
  711. </td>
  712. <td valign="top">
  713. <code>false</code>
  714. </td>
  715. </tr>
  716. <tr>
  717. <td valign="top">
  718. build.compiler.warnings<br>
  719. <strong>Deprecated</strong>. Use
  720. <code>&lt;javac&gt;</code>'s <code>nowarn</code>
  721. attribute instead.
  722. </td>
  723. <td valign="top">
  724. Don't disable warning messages.
  725. </td>
  726. <td valign="top">
  727. <code>true</code>
  728. </td>
  729. </tr>
  730. </table>
  731. <h3>Jvc Notes</h3>
  732. <p>Jvc will enable Microsoft extensions unless you set the property
  733. <code>build.compiler.jvc.extensions</code> to false before invoking
  734. <code>&lt;javac&gt;</code>.</p>
  735. <h3><a name="bootstrap">Bootstrap Options</h3>
  736. <p>
  737. The Sun javac compiler has a <em>bootclasspath</em> command
  738. line option - this corresponds to the "bootclasspath" attribute/element
  739. of the &lt;javac&gt; task. The Sun compiler also allows more
  740. control over the boot classpath using the -X and -J-X attributes.
  741. One can set these by using the &lt;compilerarg&gt;. Since Ant 1.6.0,
  742. there is a shortcut to convert path references to strings that
  743. can by used in an OS independent fashion (see
  744. <a href="../using.html#pathshortcut">pathshortcut</a>). For example:
  745. </p>
  746. <pre>
  747. &lt;path id="lib.path.ref"&gt;
  748. &lt;fileset dir="lib" includes="*.jar"/&gt;
  749. &lt;/path&gt;
  750. &lt;javac srcdir="src" destdir="classes"&gt;
  751. &lt;compilerarg arg="-Xbootclasspath/p:${toString:lib.path.ref}"/&gt;
  752. &lt;/javac&gt;
  753. </pre>
  754. </p>
  755. <h3>OpenJDK Notes</h3>
  756. <p>
  757. The <a href="https://openjdk.dev.java.net/">openjdk</a>
  758. project has provided the javac
  759. <a href="https://openjdk.dev.java.net/compiler/">compiler</a>
  760. as an opensource project. The output of this project is a
  761. <code>javac.jar</code> which contains the javac compiler.
  762. This compiler may be used with the <code>&lt;javac&gt;</code> task with
  763. the use of a <code>-Xbootclasspath/p</code> java argument. The argument needs
  764. to be given to the runtime system of the javac executable, so it needs
  765. to be prepended with a "-J". For example:
  766. <blockquote><pre>
  767. &lt;property name="patched.javac.jar"
  768. location="${my.patched.compiler}/dist/lib/javac.jar"/&gt;
  769. &lt;presetdef name="patched.javac"&gt;
  770. &lt;javac fork="yes"&gt;
  771. &lt;compilerarg value="-J-Xbootclasspath/p:${patched.javac.jar}"/&gt;
  772. &lt;/javac&gt;
  773. &lt;/presetdef&gt;
  774. &lt;patched.javac srcdir="src/java" destdir="build/classes"
  775. debug="yes"/&gt;
  776. </pre></blockquote>
  777. <h3>Note on package-info.java</h3>
  778. <p>
  779. <code>package-info.java</code> files were introduced in Java5 to
  780. allow package level annotations. On compilation, if the java file
  781. does not contain runtime annotations, there will be no .class file
  782. for the java file. Up to <b>Ant 1.7.1</b>, when the &lt;javac&gt;
  783. task is run again, the
  784. task will try to compile the package-info java files again.
  785. </p>
  786. <p>With Ant 1.7.1 a different kind of logic was introduced that
  787. involved the timestamp of the directory that would normally
  788. contain the .class file. This logic turned out to lead to Ant not
  789. recompiling <code>package-info.java</code> in certain setup.</p>
  790. <p>Starting with Ant 1.8.0 Ant will create
  791. "empty" <code>package-info.class</code> files if it compiles
  792. a <code>package-info.java</code> and
  793. no <code>package-info.class</code> file has been created by the
  794. compiler itself.</p>
  795. </body>
  796. </html>