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 38 KiB

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