| 1 | <html lang="en-us">
|
|---|
| 2 |
|
|---|
| 3 | <head>
|
|---|
| 4 | <meta http-equiv="Content-Language" content="en-us">
|
|---|
| 5 | <title>Javac Task</title>
|
|---|
| 6 | <link rel="stylesheet" type="text/css" href="../stylesheets/antmanual.css">
|
|---|
| 7 | </head>
|
|---|
| 8 |
|
|---|
| 9 | <body>
|
|---|
| 10 |
|
|---|
| 11 | <h2><a name="javac">Javac</a></h2>
|
|---|
| 12 | <h3>Description</h3>
|
|---|
| 13 | <p>Compiles a Java source tree.</p>
|
|---|
| 14 | <p>The source and destination directory will be recursively scanned for Java
|
|---|
| 15 | source files to compile. Only Java files that have no corresponding
|
|---|
| 16 | <code>.class</code> file
|
|---|
| 17 | or where the class file is older than the
|
|---|
| 18 | <code>.java</code> file will be compiled.</p>
|
|---|
| 19 | <p>Note: Ant uses only the names of the source and class files to find
|
|---|
| 20 | the classes that need a rebuild. It will not scan the source and therefore
|
|---|
| 21 | will have no knowledge about nested classes, classes that are named different
|
|---|
| 22 | from the source file, and so on. See the
|
|---|
| 23 | <a href="../OptionalTasks/depend.html"><code><depend></code></a> task
|
|---|
| 24 | for dependency checking based on other than just
|
|---|
| 25 | existence/modification times.</p>
|
|---|
| 26 | <p>When the source files are part of a package, the directory structure of
|
|---|
| 27 | the source tree should follow the package
|
|---|
| 28 | hierarchy.</p>
|
|---|
| 29 | <p>It is possible to refine the set of files that are being compiled.
|
|---|
| 30 | This can be done with the <code>includes</code>, <code>includesfile</code>,
|
|---|
| 31 | <code>excludes</code>, and <code>excludesfile</code>
|
|---|
| 32 | attributes. With the <code>includes</code> or
|
|---|
| 33 | <code>includesfile</code> attribute, you specify the files you want to
|
|---|
| 34 | have included.
|
|---|
| 35 | The <code>exclude</code> or <code>excludesfile</code> attribute is used
|
|---|
| 36 | to specify
|
|---|
| 37 | the files you want to have excluded. In both cases, the list of files
|
|---|
| 38 | can be specified by either the filename, relative to the directory(s) specified
|
|---|
| 39 | in the <code>srcdir</code> attribute or nested <code><src></code>
|
|---|
| 40 | element(s), or by using wildcard patterns. See the section on
|
|---|
| 41 | <a href="../dirtasks.html#directorybasedtasks">directory-based tasks</a>,
|
|---|
| 42 | for information on how the
|
|---|
| 43 | inclusion/exclusion of files works, and how to write wildcard patterns.</p>
|
|---|
| 44 | <p>It is possible to use different compilers. This can be specified by
|
|---|
| 45 | either setting the global <code>build.compiler</code> property, which will
|
|---|
| 46 | affect all <code><javac></code> tasks throughout the build, or by
|
|---|
| 47 | setting the <code>compiler</code> attribute, specific to the current
|
|---|
| 48 | <code><javac></code> task.
|
|---|
| 49 | <a name="compilervalues">Valid values for either the
|
|---|
| 50 | <code>build.compiler</code> property or the <code>compiler</code>
|
|---|
| 51 | attribute are:</a></p>
|
|---|
| 52 | <ul>
|
|---|
| 53 | <li><code>classic</code> (the standard compiler of JDK 1.1/1.2) –
|
|---|
| 54 | <code>javac1.1</code> and
|
|---|
| 55 | <code>javac1.2</code> can be used as aliases.</li>
|
|---|
| 56 | <li><code>modern</code> (the standard compiler of JDK 1.3/1.4/1.5) –
|
|---|
| 57 | <code>javac1.3</code> and
|
|---|
| 58 | <code>javac1.4</code> and
|
|---|
| 59 | <code>javac1.5</code> can be used as aliases.</li>
|
|---|
| 60 | <li><code>jikes</code> (the <a
|
|---|
| 61 | href="http://jikes.sourceforge.net/" target="_top">Jikes</a>
|
|---|
| 62 | compiler).</li>
|
|---|
| 63 | <li><code>jvc</code> (the Command-Line Compiler from Microsoft's SDK
|
|---|
| 64 | for Java / Visual J++) – <code>microsoft</code> can be used
|
|---|
| 65 | as an alias.</li>
|
|---|
| 66 | <li><code>kjc</code> (the <a href="http://www.dms.at/kopi/" target="_top">kopi</a>
|
|---|
| 67 | compiler).</li>
|
|---|
| 68 | <li><code>gcj</code> (the gcj compiler from gcc).</li>
|
|---|
| 69 | <li><code>sj</code> (Symantec java compiler) –
|
|---|
| 70 | <code>symantec</code> can be used as an alias.</li>
|
|---|
| 71 | <li><code>extJavac</code> (run either modern or classic in a JVM of
|
|---|
| 72 | its own).</li>
|
|---|
| 73 | </ul>
|
|---|
| 74 | <p>The default is <code>javac1.x</code> with <code>x</code> depending
|
|---|
| 75 | on the JDK version you use while you are running Ant.
|
|---|
| 76 | If you wish to use a different compiler interface than those
|
|---|
| 77 | supplied, you can write a class that implements the CompilerAdapter interface
|
|---|
| 78 | (<code>package org.apache.tools.ant.taskdefs.compilers</code>). Supply the full
|
|---|
| 79 | classname in the <code>build.compiler</code> property or the
|
|---|
| 80 | <code>compiler</code> attribute.
|
|---|
| 81 | </p>
|
|---|
| 82 | <p>The fork attribute overrides the <code>build.compiler</code> property
|
|---|
| 83 | or <code>compiler</code> attribute setting and
|
|---|
| 84 | expects a JDK1.1 or higher to be set in <code>JAVA_HOME</code>.
|
|---|
| 85 | </p>
|
|---|
| 86 | <p>You can also use the <code>compiler</code> attribute to tell Ant
|
|---|
| 87 | which JDK version it shall assume when it puts together the command
|
|---|
| 88 | line switches - even if you set <code>fork="true"</code>.
|
|---|
| 89 | This is useful if you want to run the compiler of JDK 1.1 while you
|
|---|
| 90 | current JDK is 1.2+. If you use
|
|---|
| 91 | <code>compiler="javac1.1"</code> and (for example)
|
|---|
| 92 | <code>depend="true"</code> Ant will use the command line
|
|---|
| 93 | switch <code>-depend</code> instead of <code>-Xdepend</code>.</p>
|
|---|
| 94 | <p>This task will drop all entries that point to non-existent
|
|---|
| 95 | files/directories from the classpath it passes to the compiler.</p>
|
|---|
| 96 | <p><strong>Windows Note:</strong>When the modern compiler is used
|
|---|
| 97 | in unforked mode on Windows, it locks up the files present in the
|
|---|
| 98 | classpath of the <code><javac></code> task, and does not release them.
|
|---|
| 99 | The side effect of this is that you will not be able to delete or move
|
|---|
| 100 | those files later on in the build. The workaround is to fork when
|
|---|
| 101 | invoking the compiler.</p>
|
|---|
| 102 | <h3>Parameters</h3>
|
|---|
| 103 | <table border="1" cellpadding="2" cellspacing="0">
|
|---|
| 104 | <tr>
|
|---|
| 105 | <td valign="top"><b>Attribute</b></td>
|
|---|
| 106 | <td valign="top"><b>Description</b></td>
|
|---|
| 107 | <td align="center" valign="top"><b>Required</b></td>
|
|---|
| 108 | </tr>
|
|---|
| 109 | <tr>
|
|---|
| 110 | <td valign="top">srcdir</td>
|
|---|
| 111 | <td valign="top">Location of the java files. (See the
|
|---|
| 112 | <a href="#srcdirnote">note</a> below.)</td>
|
|---|
| 113 | <td align="center" valign="top">Yes, unless nested <code><src></code> elements are present.</td>
|
|---|
| 114 | </tr>
|
|---|
| 115 | <tr>
|
|---|
| 116 | <td valign="top">destdir</td>
|
|---|
| 117 | <td valign="top">Location to store the class files.</td>
|
|---|
| 118 | <td align="center" valign="top">No</td>
|
|---|
| 119 | </tr>
|
|---|
| 120 | <tr>
|
|---|
| 121 | <td valign="top">includes</td>
|
|---|
| 122 | <td valign="top">Comma- or space-separated list of files (may be specified using
|
|---|
| 123 | wildcard patterns) that must be
|
|---|
| 124 | included; all <code>.java</code> files are included when omitted.</td>
|
|---|
| 125 | <td valign="top" align="center">No</td>
|
|---|
| 126 | </tr>
|
|---|
| 127 | <tr>
|
|---|
| 128 | <td valign="top">includesfile</td>
|
|---|
| 129 | <td valign="top">The name of a file that contains a list of files to
|
|---|
| 130 | include (may be specified using wildcard patterns).</td>
|
|---|
| 131 | <td valign="top" align="center">No</td>
|
|---|
| 132 | </tr>
|
|---|
| 133 | <tr>
|
|---|
| 134 | <td valign="top">excludes</td>
|
|---|
| 135 | <td valign="top">Comma- or space-separated list of files (may be specified using
|
|---|
| 136 | wildcard patterns) that must be excluded; no files (except default
|
|---|
| 137 | excludes) are excluded when omitted.</td>
|
|---|
| 138 | <td valign="top" align="center">No</td>
|
|---|
| 139 | </tr>
|
|---|
| 140 | <tr>
|
|---|
| 141 | <td valign="top">excludesfile</td>
|
|---|
| 142 | <td valign="top">The name of a file that contains a list of files to
|
|---|
| 143 | exclude (may be specified using wildcard patterns).</td>
|
|---|
| 144 | <td valign="top" align="center">No</td>
|
|---|
| 145 | </tr>
|
|---|
| 146 | <tr>
|
|---|
| 147 | <td valign="top">classpath</td>
|
|---|
| 148 | <td valign="top">The classpath to use.</td>
|
|---|
| 149 | <td align="center" valign="top">No</td>
|
|---|
| 150 | </tr>
|
|---|
| 151 | <tr>
|
|---|
| 152 | <td valign="top">sourcepath</td>
|
|---|
| 153 | <td valign="top">The sourcepath to use; defaults to the value of the srcdir attribute (or nested <code><src></code> elements).
|
|---|
| 154 | To suppress the sourcepath switch, use <code>sourcepath=""</code>.</td>
|
|---|
| 155 | <td align="center" valign="top">No</td>
|
|---|
| 156 | </tr>
|
|---|
| 157 | <tr>
|
|---|
| 158 | <td valign="top">bootclasspath</td>
|
|---|
| 159 | <td valign="top">Location of bootstrap class files.</td>
|
|---|
| 160 | <td align="center" valign="top">No</td>
|
|---|
| 161 | </tr>
|
|---|
| 162 | <tr>
|
|---|
| 163 | <td valign="top">classpathref</td>
|
|---|
| 164 | <td valign="top">The classpath to use, given as a
|
|---|
| 165 | <a href="../using.html#references">reference</a> to a path defined elsewhere.</td>
|
|---|
| 166 | <td align="center" valign="top">No</td>
|
|---|
| 167 | </tr>
|
|---|
| 168 | <tr>
|
|---|
| 169 | <td valign="top">sourcepathref</td>
|
|---|
| 170 | <td valign="top">The sourcepath to use, given as a
|
|---|
| 171 | <a href="../using.html#references">reference</a> to a path defined elsewhere.</td>
|
|---|
| 172 | <td align="center" valign="top">No</td>
|
|---|
| 173 | </tr>
|
|---|
| 174 | <tr>
|
|---|
| 175 | <td valign="top">bootclasspathref</td>
|
|---|
| 176 | <td valign="top">Location of bootstrap class files, given as a
|
|---|
| 177 | <a href="../using.html#references">reference</a> to a path defined elsewhere.</td>
|
|---|
| 178 | <td align="center" valign="top">No</td>
|
|---|
| 179 | </tr>
|
|---|
| 180 | <tr>
|
|---|
| 181 | <td valign="top">extdirs</td>
|
|---|
| 182 | <td valign="top">Location of installed extensions.</td>
|
|---|
| 183 | <td align="center" valign="top">No</td>
|
|---|
| 184 | </tr>
|
|---|
| 185 | <tr>
|
|---|
| 186 | <td valign="top">encoding</td>
|
|---|
| 187 | <td valign="top">Encoding of source files. (Note: gcj doesn't support
|
|---|
| 188 | this option yet.)</td>
|
|---|
| 189 | <td align="center" valign="top">No</td>
|
|---|
| 190 | </tr>
|
|---|
| 191 | <tr>
|
|---|
| 192 | <td valign="top">nowarn</td>
|
|---|
| 193 | <td valign="top">Indicates whether the <code>-nowarn</code> switch
|
|---|
| 194 | should be passed to the compiler; defaults to <code>off</code>.</td>
|
|---|
| 195 | <td align="center" valign="top">No</td>
|
|---|
| 196 | </tr>
|
|---|
| 197 | <tr>
|
|---|
| 198 | <td valign="top">debug</td>
|
|---|
| 199 | <td valign="top">Indicates whether source should be compiled with
|
|---|
| 200 | debug information; defaults to <code>off</code>. If set to
|
|---|
| 201 | <code>off</code>, <code>-g:none</code> will be passed on the
|
|---|
| 202 | command line for compilers that support it (for other compilers, no
|
|---|
| 203 | command line argument will be used). If set to <code>true</code>,
|
|---|
| 204 | the value of the <code>debuglevel</code> attribute determines the
|
|---|
| 205 | command line argument.</td>
|
|---|
| 206 | <td align="center" valign="top">No</td>
|
|---|
| 207 | </tr>
|
|---|
| 208 | <tr>
|
|---|
| 209 | <td valign="top">debuglevel</td>
|
|---|
| 210 | <td valign="top">Keyword list to be appended to the <code>-g</code>
|
|---|
| 211 | command-line switch. This will be ignored by all implementations except
|
|---|
| 212 | <code>modern</code>, <code>classic(ver >= 1.2)</code> and <code>jikes</code>.
|
|---|
| 213 | Legal values are <code>none</code> or a comma-separated list of the
|
|---|
| 214 | following keywords:
|
|---|
| 215 | <code>lines</code>, <code>vars</code>, and <code>source</code>.
|
|---|
| 216 | If <code>debuglevel</code> is not specified, by default,
|
|---|
| 217 | nothing will be
|
|---|
| 218 | appended to <code>-g</code>. If <code>debug</code> is not turned on,
|
|---|
| 219 | this attribute will be ignored.
|
|---|
| 220 | </td>
|
|---|
| 221 | <td align="center" valign="top">No</td>
|
|---|
| 222 | </tr>
|
|---|
| 223 | <tr>
|
|---|
| 224 | <td valign="top">optimize</td>
|
|---|
| 225 | <td valign="top">Indicates whether source should be compiled with
|
|---|
| 226 | optimization; defaults to <code>off</code>.</td>
|
|---|
| 227 | <td align="center" valign="top">No</td>
|
|---|
| 228 | </tr>
|
|---|
| 229 | <tr>
|
|---|
| 230 | <td valign="top">deprecation</td>
|
|---|
| 231 | <td valign="top">Indicates whether source should be compiled with
|
|---|
| 232 | deprecation information; defaults to <code>off</code>.</td>
|
|---|
| 233 | <td align="center" valign="top">No</td>
|
|---|
| 234 | </tr>
|
|---|
| 235 | <tr>
|
|---|
| 236 | <td valign="top">target</td>
|
|---|
| 237 | <td valign="top">Generate class files for specific VM version
|
|---|
| 238 | (e.g., <code>1.1</code> or <code>1.2</code>). <b>Note that the
|
|---|
| 239 | default value depends on the JVM that is running Ant. In
|
|---|
| 240 | particular, if you use JDK 1.4+ the generated classes will not be
|
|---|
| 241 | usable for a 1.1 Java VM unless you explicitly set this attribute
|
|---|
| 242 | to the value 1.1 (which is the default value for JDK 1.1 to
|
|---|
| 243 | 1.3). We highly recommend to always specify this attribute.</b></td>
|
|---|
| 244 | <td align="center" valign="top">No</td>
|
|---|
| 245 | </tr>
|
|---|
| 246 | <tr>
|
|---|
| 247 | <td valign="top">verbose</td>
|
|---|
| 248 | <td valign="top">Asks the compiler for verbose output; defaults to
|
|---|
| 249 | <code>no</code>.</td>
|
|---|
| 250 | <td align="center" valign="top">No</td>
|
|---|
| 251 | </tr>
|
|---|
| 252 | <tr>
|
|---|
| 253 | <td valign="top">depend</td> <td valign="top">Enables dependency-tracking
|
|---|
| 254 | for compilers that support this (<code>jikes</code> and
|
|---|
| 255 | <code>classic</code>).</td>
|
|---|
| 256 | <td align="center" valign="top">No</td>
|
|---|
| 257 | </tr>
|
|---|
| 258 | <tr>
|
|---|
| 259 | <td valign="top">includeAntRuntime</td>
|
|---|
| 260 | <td valign="top">Whether to include the Ant run-time libraries in the
|
|---|
| 261 | classpath; defaults to <code>yes</code>.</td>
|
|---|
| 262 | <td align="center" valign="top">No</td>
|
|---|
| 263 | </tr>
|
|---|
| 264 | <tr>
|
|---|
| 265 | <td valign="top">includeJavaRuntime</td>
|
|---|
| 266 | <td valign="top">Whether to include the default run-time
|
|---|
| 267 | libraries from the executing VM in the classpath;
|
|---|
| 268 | defaults to <code>no</code>.</td>
|
|---|
| 269 | <td align="center" valign="top">No</td>
|
|---|
| 270 | </tr>
|
|---|
| 271 | <tr>
|
|---|
| 272 | <td valign="top">fork</td>
|
|---|
| 273 | <td valign="top">Whether to execute <code>javac</code> using the
|
|---|
| 274 | JDK compiler externally; defaults to <code>no</code>.</td>
|
|---|
| 275 | <td align="center" valign="top">No</td>
|
|---|
| 276 | </tr>
|
|---|
| 277 | <tr>
|
|---|
| 278 | <td valign="top">executable</td>
|
|---|
| 279 | <td valign="top">Complete path to the <code>javac</code>
|
|---|
| 280 | executable to use in case of <code>fork="yes"</code>.
|
|---|
| 281 | Defaults to the compiler of the Java version that is currently
|
|---|
| 282 | running Ant. Ignored if <code>fork="no"</code>.<br>
|
|---|
| 283 | Since Ant 1.6 this attribute can also be used to specify the
|
|---|
| 284 | path to the executable when using jikes, jvc, gcj or sj.</td>
|
|---|
| 285 | <td align="center" valign="top">No</td>
|
|---|
| 286 | </tr>
|
|---|
| 287 | <tr>
|
|---|
| 288 | <td valign="top">memoryInitialSize</td>
|
|---|
| 289 | <td valign="top">The initial size of the memory for the underlying VM,
|
|---|
| 290 | if <code>javac</code> is run externally; ignored otherwise. Defaults
|
|---|
| 291 | to the standard VM memory setting.
|
|---|
| 292 | (Examples: <code>83886080</code>, <code>81920k</code>, or
|
|---|
| 293 | <code>80m</code>)</td>
|
|---|
| 294 | <td align="center" valign="top">No</td>
|
|---|
| 295 | </tr>
|
|---|
| 296 | <tr>
|
|---|
| 297 | <td valign="top">memoryMaximumSize</td>
|
|---|
| 298 | <td valign="top">The maximum size of the memory for the underlying VM,
|
|---|
| 299 | if <code>javac</code> is run externally; ignored otherwise. Defaults
|
|---|
| 300 | to the standard VM memory setting.
|
|---|
| 301 | (Examples: <code>83886080</code>, <code>81920k</code>, or
|
|---|
| 302 | <code>80m</code>)</td>
|
|---|
| 303 | <td align="center" valign="top">No</td>
|
|---|
| 304 | </tr>
|
|---|
| 305 | <tr>
|
|---|
| 306 | <td valign="top">failonerror</td> <td valign="top">
|
|---|
| 307 | Indicates whether the build will continue even if there are compilation errors; defaults to <code>true</code>.
|
|---|
| 308 | </td>
|
|---|
| 309 | <td align="center" valign="top">No</td>
|
|---|
| 310 | </tr>
|
|---|
| 311 | <tr>
|
|---|
| 312 | <td valign="top">source</td>
|
|---|
| 313 |
|
|---|
| 314 | <td valign="top">Value of the <code>-source</code> command-line
|
|---|
| 315 | switch; will be ignored by all implementations prior to
|
|---|
| 316 | <code>javac1.4</code> (or <code>modern</code> when Ant is not
|
|---|
| 317 | running in a 1.3 VM) and <code>jikes</code>.<br> If you use this
|
|---|
| 318 | attribute together with <code>jikes</code>, you must make sure
|
|---|
| 319 | that your version of jikes supports the <code>-source</code>
|
|---|
| 320 | switch. By default, no <code>-source</code> argument will be used
|
|---|
| 321 | at all.<br>
|
|---|
| 322 | <b>Note that the default value depends on the JVM that is running
|
|---|
| 323 | Ant. We highly recommend to always specify this
|
|---|
| 324 | attribute.</b></td>
|
|---|
| 325 |
|
|---|
| 326 | <td align="center" valign="top">No</td>
|
|---|
| 327 | </tr>
|
|---|
| 328 | <tr>
|
|---|
| 329 | <td valign="top">compiler</td>
|
|---|
| 330 | <td valign="top">The compiler implementation to use.
|
|---|
| 331 | If this attribute is not set, the value of the
|
|---|
| 332 | <code>build.compiler</code> property, if set, will be used.
|
|---|
| 333 | Otherwise, the default compiler for the current VM will be used.
|
|---|
| 334 | (See the above <a href="#compilervalues">list</a> of valid
|
|---|
| 335 | compilers.)</td>
|
|---|
| 336 | <td align="center" valign="top">No</td>
|
|---|
| 337 | </tr>
|
|---|
| 338 | <tr>
|
|---|
| 339 | <td valign="top">listfiles</td>
|
|---|
| 340 | <td valign="top">Indicates whether the source files to be compiled will
|
|---|
| 341 | be listed; defaults to <code>no</code>.</td>
|
|---|
| 342 | <td align="center" valign="top">No</td>
|
|---|
| 343 | </tr>
|
|---|
| 344 | <tr>
|
|---|
| 345 | <td valign="top">tempdir</td>
|
|---|
| 346 | <td valign="top">Where Ant should place temporary files.
|
|---|
| 347 | This is only used if the task is forked and the
|
|---|
| 348 | command line args length exceeds 4k.
|
|---|
| 349 | <em>Since Ant 1.6</em>.</td>
|
|---|
| 350 | <td align="center" valign="top">
|
|---|
| 351 | No; default is <i>java.io.tmpdir</i>.
|
|---|
| 352 | </td>
|
|---|
| 353 | </tr>
|
|---|
| 354 | </table>
|
|---|
| 355 |
|
|---|
| 356 | <h3>Parameters specified as nested elements</h3>
|
|---|
| 357 | <p>This task forms an implicit <a href="../CoreTypes/fileset.html">FileSet</a> and
|
|---|
| 358 | supports all attributes of <code><fileset></code>
|
|---|
| 359 | (<code>dir</code> becomes <code>srcdir</code>) as well as the nested
|
|---|
| 360 | <code><include></code>, <code><exclude></code> and
|
|---|
| 361 | <code><patternset></code> elements.</p>
|
|---|
| 362 | <h4><code>src</code>, <code>classpath</code>, <code>sourcepath</code>,
|
|---|
| 363 | <code>bootclasspath</code> and <code>extdirs</code></h4>
|
|---|
| 364 | <p><code><javac></code>'s <code>srcdir</code>, <code>classpath</code>,
|
|---|
| 365 | <code>sourcepath</code>, <code>bootclasspath</code>, and
|
|---|
| 366 | <code>extdirs</code> attributes are
|
|---|
| 367 | <a href="../using.html#path">path-like structures</a>
|
|---|
| 368 | and can also be set via nested
|
|---|
| 369 | <code><src></code>,
|
|---|
| 370 | <code><classpath></code>,
|
|---|
| 371 | <code><sourcepath></code>,
|
|---|
| 372 | <code><bootclasspath></code> and
|
|---|
| 373 | <code><extdirs></code> elements, respectively.</p>
|
|---|
| 374 |
|
|---|
| 375 | <h4>compilerarg</h4>
|
|---|
| 376 |
|
|---|
| 377 | <p>You can specify additional command line arguments for the compiler
|
|---|
| 378 | with nested <code><compilerarg></code> elements. These elements
|
|---|
| 379 | are specified like <a href="../using.html#arg">Command-line
|
|---|
| 380 | Arguments</a> but have an additional attribute that can be used to
|
|---|
| 381 | enable arguments only if a given compiler implementation will be
|
|---|
| 382 | used.</p>
|
|---|
| 383 | <table border="1" cellpadding="2" cellspacing="0">
|
|---|
| 384 | <tr>
|
|---|
| 385 | <td width="12%" valign="top"><b>Attribute</b></td>
|
|---|
| 386 | <td width="78%" valign="top"><b>Description</b></td>
|
|---|
| 387 | <td width="10%" valign="top"><b>Required</b></td>
|
|---|
| 388 | </tr>
|
|---|
| 389 | <tr>
|
|---|
| 390 | <td valign="top">value</td>
|
|---|
| 391 | <td align="center" rowspan="4">See
|
|---|
| 392 | <a href="../using.html#arg">Command-line Arguments</a>.</td>
|
|---|
| 393 | <td align="center" rowspan="4">Exactly one of these.</td>
|
|---|
| 394 | </tr>
|
|---|
| 395 | <tr>
|
|---|
| 396 | <td valign="top">line</td>
|
|---|
| 397 | </tr>
|
|---|
| 398 | <tr>
|
|---|
| 399 | <td valign="top">file</td>
|
|---|
| 400 | </tr>
|
|---|
| 401 | <tr>
|
|---|
| 402 | <td valign="top">path</td>
|
|---|
| 403 | </tr>
|
|---|
| 404 | <tr>
|
|---|
| 405 | <td valign="top">compiler</td>
|
|---|
| 406 | <td>Only pass the specified argument if the chosen
|
|---|
| 407 | compiler implementation matches the value of this attribute.
|
|---|
| 408 | Legal values are the
|
|---|
| 409 | same as those in the above <a href="#compilervalues">list</a> of valid
|
|---|
| 410 | compilers.)</td>
|
|---|
| 411 | <td align="center">No</td>
|
|---|
| 412 | </tr>
|
|---|
| 413 | </table>
|
|---|
| 414 |
|
|---|
| 415 | <h3>Examples</h3>
|
|---|
| 416 | <pre> <javac srcdir="${src}"
|
|---|
| 417 | destdir="${build}"
|
|---|
| 418 | classpath="xyz.jar"
|
|---|
| 419 | debug="on"
|
|---|
| 420 | source="1.4"
|
|---|
| 421 | /></pre>
|
|---|
| 422 | <p>compiles all <code>.java</code> files under the <code>${src}</code>
|
|---|
| 423 | directory, and stores
|
|---|
| 424 | the <code>.class</code> files in the <code>${build}</code> directory.
|
|---|
| 425 | The classpath used includes <code>xyz.jar</code>, and compiling with
|
|---|
| 426 | debug information is on. The source level is 1.4,
|
|---|
| 427 | so you can use <code>assert</code> statements.</p>
|
|---|
| 428 |
|
|---|
| 429 | <pre> <javac srcdir="${src}"
|
|---|
| 430 | destdir="${build}"
|
|---|
| 431 | fork="true"
|
|---|
| 432 | source="1.2"
|
|---|
| 433 | target="1.2"
|
|---|
| 434 | /></pre>
|
|---|
| 435 | <p>compiles all <code>.java</code> files under the <code>${src}</code>
|
|---|
| 436 | directory, and stores the <code>.class</code> files in the
|
|---|
| 437 | <code>${build}</code> directory. This will fork off the javac
|
|---|
| 438 | compiler using the default <code>javac</code> executable.
|
|---|
| 439 | The source level is 1.2 (similar to 1.1 or 1.3) and
|
|---|
| 440 | the class files should be runnable under JDK 1.2+ as well.</p>
|
|---|
| 441 |
|
|---|
| 442 | <pre> <javac srcdir="${src}"
|
|---|
| 443 | destdir="${build}"
|
|---|
| 444 | fork="java$$javac.exe"
|
|---|
| 445 | source="1.5"
|
|---|
| 446 | /></pre>
|
|---|
| 447 | <p>compiles all <code>.java</code> files under the <code>${src}</code>
|
|---|
| 448 | directory, and stores the <code>.class</code> files in the
|
|---|
| 449 | <code>${build}</code> directory. This will fork off the javac
|
|---|
| 450 | compiler, using the executable named <code>java$javac.exe</code>. Note
|
|---|
| 451 | that the <code>$</code> sign needs to be escaped by a second one.
|
|---|
| 452 | The source level is 1.5, so you can use generics.</p>
|
|---|
| 453 |
|
|---|
| 454 | <pre> <javac srcdir="${src}"
|
|---|
| 455 | destdir="${build}"
|
|---|
| 456 | includes="mypackage/p1/**,mypackage/p2/**"
|
|---|
| 457 | excludes="mypackage/p1/testpackage/**"
|
|---|
| 458 | classpath="xyz.jar"
|
|---|
| 459 | debug="on"
|
|---|
| 460 | /></pre>
|
|---|
| 461 | <p>compiles <code>.java</code> files under the <code>${src}</code>
|
|---|
| 462 | directory, and stores the
|
|---|
| 463 | <code>.class</code> files in the <code>${build}</code> directory.
|
|---|
| 464 | The classpath used includes <code>xyz.jar</code>, and debug information is on.
|
|---|
| 465 | Only files under <code>mypackage/p1</code> and <code>mypackage/p2</code> are
|
|---|
| 466 | used. All files in and below the <code>mypackage/p1/testpackage</code>
|
|---|
| 467 | directory are excluded from compilation.
|
|---|
| 468 | You didn't specify a source or target level,
|
|---|
| 469 | so the actual values used will depend on which JDK you ran Ant with.</p>
|
|---|
| 470 |
|
|---|
| 471 | <pre> <javac srcdir="${src}:${src2}"
|
|---|
| 472 | destdir="${build}"
|
|---|
| 473 | includes="mypackage/p1/**,mypackage/p2/**"
|
|---|
| 474 | excludes="mypackage/p1/testpackage/**"
|
|---|
| 475 | classpath="xyz.jar"
|
|---|
| 476 | debug="on"
|
|---|
| 477 | /></pre>
|
|---|
| 478 |
|
|---|
| 479 | <p>is the same as the previous example, with the addition of a second
|
|---|
| 480 | source path, defined by
|
|---|
| 481 | the property <code>src2</code>. This can also be represented using nested
|
|---|
| 482 | <code><src></code> elements as follows:</p>
|
|---|
| 483 |
|
|---|
| 484 | <pre> <javac destdir="${build}"
|
|---|
| 485 | classpath="xyz.jar"
|
|---|
| 486 | debug="on">
|
|---|
| 487 | <src path="${src}"/>
|
|---|
| 488 | <src path="${src2}"/>
|
|---|
| 489 | <include name="mypackage/p1/**"/>
|
|---|
| 490 | <include name="mypackage/p2/**"/>
|
|---|
| 491 | <exclude name="mypackage/p1/testpackage/**"/>
|
|---|
| 492 | </javac></pre>
|
|---|
| 493 |
|
|---|
| 494 | <p>If you want to run the javac compiler of a different JDK, you
|
|---|
| 495 | should tell Ant, where to find the compiler and which version of JDK
|
|---|
| 496 | you will be using so it can choose the correct command line switches.
|
|---|
| 497 | The following example executes a JDK 1.1 javac in a new process and
|
|---|
| 498 | uses the correct command line switches even when Ant is running in a
|
|---|
| 499 | Java VM of a different version:</p>
|
|---|
| 500 |
|
|---|
| 501 | <pre> <javac srcdir="${src}"
|
|---|
| 502 | destdir="${build}"
|
|---|
| 503 | fork="yes"
|
|---|
| 504 | executable="/opt/java/jdk1.1/bin/javac"
|
|---|
| 505 | compiler="javac1.1"
|
|---|
| 506 | /></pre>
|
|---|
| 507 |
|
|---|
| 508 | <p><a name="srcdirnote"><b>Note:</b></a>
|
|---|
| 509 | If you wish to compile only source files located in certain packages below a
|
|---|
| 510 | common root, use the <code>include</code>/<code>exclude</code> attributes
|
|---|
| 511 | or <code><include></code>/<code><exclude></code> nested elements
|
|---|
| 512 | to filter for these packages. Do not include part of your package structure
|
|---|
| 513 | in the <code>srcdir</code> attribute
|
|---|
| 514 | (or nested <code><src></code> elements), or Ant will recompile your
|
|---|
| 515 | source files every time you run your compile target. See the
|
|---|
| 516 | <a href="http://ant.apache.org/faq.html#always-recompiles">Ant FAQ</a>
|
|---|
| 517 | for additional information.</p>
|
|---|
| 518 |
|
|---|
| 519 | <p>
|
|---|
| 520 | If you wish to compile only files explicitly specified and disable
|
|---|
| 521 | javac's default searching mechanism then you can unset the sourcepath
|
|---|
| 522 | attribute:
|
|---|
| 523 | <pre> <javac sourcepath="" srcdir="${src}"
|
|---|
| 524 | destdir="${build}" >
|
|---|
| 525 | <include name="**/*.java"/>
|
|---|
| 526 | <exclude name="**/Example.java"/>
|
|---|
| 527 | </javac></pre>
|
|---|
| 528 | That way the javac will compile all java source files under "${src}"
|
|---|
| 529 | directory but skip the examples. The compiler will even produce errors if some of
|
|---|
| 530 | the non-example files refers to them.
|
|---|
| 531 | </p>
|
|---|
| 532 |
|
|---|
| 533 | <p><b>Note:</b> If you are using Ant on Windows and a new DOS window pops up
|
|---|
| 534 | for every use of an external compiler, this may be a problem of the JDK you are
|
|---|
| 535 | using. This problem may occur with all JDKs < 1.2.</p>
|
|---|
| 536 |
|
|---|
| 537 | <h3>Jikes Notes</h3>
|
|---|
| 538 |
|
|---|
| 539 | <p>You need Jikes 1.15 or later.</p>
|
|---|
| 540 |
|
|---|
| 541 | <p>Jikes supports some extra options, which can be set be defining
|
|---|
| 542 | the properties shown below prior to invoking the task. The setting
|
|---|
| 543 | for each property will be in affect for all <code><javac></code>
|
|---|
| 544 | tasks throughout the build.
|
|---|
| 545 | The Ant developers are aware that
|
|---|
| 546 | this is ugly and inflexible – expect a better solution in the future.
|
|---|
| 547 | All the options are boolean, and must be set to <code>true</code> or
|
|---|
| 548 | <code>yes</code> to be
|
|---|
| 549 | interpreted as anything other than false. By default,
|
|---|
| 550 | <code>build.compiler.warnings</code> is <code>true</code>,
|
|---|
| 551 | while all others are <code>false</code>.</p>
|
|---|
| 552 |
|
|---|
| 553 | <table border="1" cellpadding="2" cellspacing="0">
|
|---|
| 554 | <tr>
|
|---|
| 555 | <td valign="top"><b>Property</b></td>
|
|---|
| 556 | <td valign="top"><b>Description</b></td>
|
|---|
| 557 | <td align="center" valign="top"><b>Default</b></td>
|
|---|
| 558 | </tr>
|
|---|
| 559 | <tr>
|
|---|
| 560 | <td valign="top">
|
|---|
| 561 | build.compiler.emacs
|
|---|
| 562 | </td>
|
|---|
| 563 | <td valign="top">
|
|---|
| 564 | Enable emacs-compatible error messages.
|
|---|
| 565 | </td>
|
|---|
| 566 | <td valign="top">
|
|---|
| 567 | <code>false</code>
|
|---|
| 568 | </td>
|
|---|
| 569 | </tr>
|
|---|
| 570 | <tr>
|
|---|
| 571 | <td valign="top">
|
|---|
| 572 | build.compiler.fulldepend
|
|---|
| 573 | </td>
|
|---|
| 574 | <td valign="top">
|
|---|
| 575 | Enable full dependency checking; see<br>
|
|---|
| 576 | the <code>+F</code> switch in the Jikes manual.
|
|---|
| 577 | </td>
|
|---|
| 578 | <td valign="top">
|
|---|
| 579 | <code>false</code>
|
|---|
| 580 | </td>
|
|---|
| 581 | </tr>
|
|---|
| 582 | <tr>
|
|---|
| 583 | <td valign="top">
|
|---|
| 584 | build.compiler.pedantic
|
|---|
| 585 | </td>
|
|---|
| 586 | <td valign="top">
|
|---|
| 587 | Enable pedantic warnings.
|
|---|
| 588 | </td>
|
|---|
| 589 | <td valign="top">
|
|---|
| 590 | <code>false</code>
|
|---|
| 591 | </td>
|
|---|
| 592 | </tr>
|
|---|
| 593 | <tr>
|
|---|
| 594 | <td valign="top">
|
|---|
| 595 | build.compiler.warnings<br>
|
|---|
| 596 | <strong>Deprecated</strong>. Use
|
|---|
| 597 | <code><javac></code>'s <code>nowarn</code>
|
|---|
| 598 | attribute instead.
|
|---|
| 599 | </td>
|
|---|
| 600 | <td valign="top">
|
|---|
| 601 | Don't disable warning messages.
|
|---|
| 602 | </td>
|
|---|
| 603 | <td valign="top">
|
|---|
| 604 | <code>true</code>
|
|---|
| 605 | </td>
|
|---|
| 606 | </tr>
|
|---|
| 607 | </table>
|
|---|
| 608 |
|
|---|
| 609 | <h3>Jvc Notes</h3>
|
|---|
| 610 |
|
|---|
| 611 | <p>Jvc will enable Microsoft extensions unless you set the property
|
|---|
| 612 | <code>build.compiler.jvc.extensions</code> to false before invoking
|
|---|
| 613 | <code><javac></code>.</p>
|
|---|
| 614 |
|
|---|
| 615 | <hr>
|
|---|
| 616 | <p align="center">Copyright © 2000-2005 The Apache Software Foundation.
|
|---|
| 617 | All rights Reserved.</p>
|
|---|
| 618 |
|
|---|
| 619 | </body>
|
|---|
| 620 | </html>
|
|---|
| 621 |
|
|---|
