Google Git
Sign in
apache / ant / f47077377b50e0d5fc5e8f0c6b7ab5df9880a560 / . / docs / manual / CoreTasks / javac.html
blob: 7eaa23417823612d723a507d676477d4b23cb82e [file] [log] [blame]
<html lang="en-us">
<head>
<meta http-equiv="Content-Language" content="en-us">
<title>Javac Task</title>
</head>
<body>
<h2><a name="javac">Javac</a></h2>
<h3>Description</h3>
<p>Compiles a Java source tree.</p>
<p>The source and destination directory will be recursively scanned for Java
source files to compile. Only Java files that have no corresponding
<code>.class</code> file
or where the class file is older than the
<code>.java</code> file will be compiled.</p>
<p>Note: Ant uses only the names of the source and class files to find
the classes that need a rebuild. It will not scan the source and therefore
will have no knowledge about nested classes, classes that are named different
from the source file, and so on. See the
<a href="../OptionalTasks/depend.html"><code>&lt;depend&gt;</code></a> task
for dependency checking based on other than just
existence/modification times.</p>
<p>When the source files are part of a package, the directory structure of
the source tree should follow the package
hierarchy.</p>
<p>It is possible to refine the set of files that are being compiled.
This can be done with the <code>includes</code>, <code>includesfile</code>,
<code>excludes</code>, and <code>excludesfile</code>
attributes. With the <code>includes</code> or
<code>includesfile</code> attribute, you specify the files you want to
have included.
The <code>exclude</code> or <code>excludesfile</code> attribute is used
to specify
the files you want to have excluded. In both cases, the list of files
can be specified by either the filename, relative to the directory(s) specified
in the <code>srcdir</code> attribute or nested <code>&lt;src&gt;</code>
element(s), or by using wildcard patterns. See the section on
<a href="../dirtasks.html#directorybasedtasks">directory-based tasks</a>,
for information on how the
inclusion/exclusion of files works, and how to write wildcard patterns.</p>
<p>It is possible to use different compilers. This can be specified by
either setting the global <code>build.compiler</code> property, which will
affect all <code>&lt;javac&gt;</code> tasks throughout the build, or by
setting the <code>compiler</code> attribute, specific to the current
<code>&lt;javac&gt;</code> task.
<a name="compilervalues">Valid values for either the
<code>build.compiler</code> property or the <code>compiler</code>
attribute are:</a></p>
<ul>
<li><code>classic</code> (the standard compiler of JDK 1.1/1.2) &ndash;
<code>javac1.1</code> and
<code>javac1.2</code> can be used as aliases.</li>
<li><code>modern</code> (the standard compiler of JDK 1.3/1.4) &ndash;
<code>javac1.3</code> and
<code>javac1.4</code> can be used as aliases.</li>
<li><code>jikes</code> (the <a
href="http://oss.software.ibm.com/developerworks/opensource/jikes/" target="_top">Jikes</a>
compiler).</li>
<li><code>jvc</code> (the Command-Line Compiler from Microsoft's SDK
for Java / Visual J++) &ndash; <code>microsoft</code> can be used
as an alias.</li>
<li><code>kjc</code> (the <a href="http://www.dms.at/kopi/" target="_top">kopi</a>
compiler).</li>
<li><code>gcj</code> (the gcj compiler from gcc).</li>
<li><code>sj</code> (Symantec java compiler) &ndash;
<code>symantec</code> can be used as an alias.</li>
<li><code>extJavac</code> (run either modern or classic in a JVM of
its own).</li>
</ul>
<p>The default is <code>javac1.x</code> with <code>x</code> depending
on the JDK version you use while you are running Ant.
If you wish to use a different compiler interface than those
supplied, you can write a class that implements the CompilerAdapter interface
(<code>package org.apache.tools.ant.taskdefs.compilers</code>). Supply the full
classname in the <code>build.compiler</code> property or the
<code>compiler</code> attribute.
</p>
<p>The fork attribute overrides the <code>build.compiler</code> property
or <code>compiler</code> attribute setting and
expects a JDK1.1 or higher to be set in <code>JAVA_HOME</code>.
</p>
<p>You can also use the <code>compiler</code> attribute to tell Ant
which JDK version it shall assume when it puts together the command
line switches - even if you set <code>fork=&quot;true&quot;</code>.
This is useful if you want to run the compiler of JDK 1.1 while you
current JDK is 1.2+. If you use
<code>compiler=&quot;javac1.1&quot;</code> and (for example)
<code>depend=&quot;true&quot;</code> Ant will use the command line
switch <code>-depend</code> instead of <code>-Xdepend</code>.</p>
<p>This task will drop all entries that point to non-existent
files/directories from the classpath it passes to the compiler.</p>
<p><strong>Windows Note:</strong>When the modern compiler is used
in unforked mode on Windows, it locks up the files present in the
classpath of the <code>&lt;javac&gt;</code> task, and does not release them.
The side effect of this is that you will not be able to delete or move
those files later on in the build. The workaround is to fork when
invoking the compiler.</p>
<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
<td align="center" valign="top"><b>Required</b></td>
</tr>
<tr>
<td valign="top">srcdir</td>
<td valign="top">Location of the java files. (See the
<a href="#srcdirnote">note</a> below.)</td>
<td align="center" valign="top">Yes, unless nested <code>&lt;src&gt;</code> elements are present.</td>
</tr>
<tr>
<td valign="top">destdir</td>
<td valign="top">Location to store the class files.</td>
<td align="center" valign="top">No</td>
</tr>
<tr>
<td valign="top">includes</td>
<td valign="top">Comma- or space-separated list of files (may be specified using
wildcard patterns) that must be
included; all <code>.java</code> files are included when omitted.</td>
<td valign="top" align="center">No</td>
</tr>
<tr>
<td valign="top">includesfile</td>
<td valign="top">The name of a file that contains a list of files to
include (may be specified using wildcard patterns).</td>
<td valign="top" align="center">No</td>
</tr>
<tr>
<td valign="top">excludes</td>
<td valign="top">Comma- or space-separated list of files (may be specified using
wildcard patterns) that must be excluded; no files (except default
excludes) are excluded when omitted.</td>
<td valign="top" align="center">No</td>
</tr>
<tr>
<td valign="top">excludesfile</td>
<td valign="top">The name of a file that contains a list of files to
exclude (may be specified using wildcard patterns).</td>
<td valign="top" align="center">No</td>
</tr>
<tr>
<td valign="top">classpath</td>
<td valign="top">The classpath to use.</td>
<td align="center" valign="top">No</td>
</tr>
<tr>
<td valign="top">sourcepath</td>
<td valign="top">The sourcepath to use; defaults to the value of the srcdir attribute (or nested <code>&lt;src&gt;</code> elements).
To suppress the sourcepath switch, use <code>sourcepath=&quot;&quot;</code>.</td>
<td align="center" valign="top">No</td>
</tr>
<tr>
<td valign="top">bootclasspath</td>
<td valign="top">Location of bootstrap class files.</td>
<td align="center" valign="top">No</td>
</tr>
<tr>
<td valign="top">classpathref</td>
<td valign="top">The classpath to use, given as a
<a href="../using.html#references">reference</a> to a path defined elsewhere.</td>
<td align="center" valign="top">No</td>
</tr>
<tr>
<td valign="top">sourcepathref</td>
<td valign="top">The sourcepath to use, given as a
<a href="../using.html#references">reference</a> to a path defined elsewhere.</td>
<td align="center" valign="top">No</td>
</tr>
<tr>
<td valign="top">bootclasspathref</td>
<td valign="top">Location of bootstrap class files, given as a
<a href="../using.html#references">reference</a> to a path defined elsewhere.</td>
<td align="center" valign="top">No</td>
</tr>
<tr>
<td valign="top">extdirs</td>
<td valign="top">Location of installed extensions.</td>
<td align="center" valign="top">No</td>
</tr>
<tr>
<td valign="top">encoding</td>
<td valign="top">Encoding of source files. (Note: gcj doesn't support
this option yet.)</td>
<td align="center" valign="top">No</td>
</tr>
<tr>
<td valign="top">nowarn</td>
<td valign="top">Indicates whether the <code>-nowarn</code> switch
should be passed to the compiler; defaults to <code>off</code>.</td>
<td align="center" valign="top">No</td>
</tr>
<tr>
<td valign="top">debug</td>
<td valign="top">Indicates whether source should be compiled with debug
information; defaults to <code>off</code>.</td>
<td align="center" valign="top">No</td>
</tr>
<tr>
<td valign="top">debuglevel</td>
<td valign="top">Keyword list to be appended to the <code>-g</code>
command-line switch. This will be ignored by all implementations except
<code>modern</code> and <code>classic(ver &gt;= 1.2)</code>.
Legal values are <code>none</code> or a comma-separated list of the
following keywords:
<code>lines</code>, <code>vars</code>, and <code>source</code>.
If <code>debuglevel</code> is not specified, by default,
<code>:none</code> will be
appended to <code>-g</code>. If <code>debug</code> is not turned on,
this attribute will be ignored.
</td>
<td align="center" valign="top">No</td>
</tr>
<tr>
<td valign="top">optimize</td>
<td valign="top">Indicates whether source should be compiled with
optimization; defaults to <code>off</code>.</td>
<td align="center" valign="top">No</td>
</tr>
<tr>
<td valign="top">deprecation</td>
<td valign="top">Indicates whether source should be compiled with
deprecation information; defaults to <code>off</code>.</td>
<td align="center" valign="top">No</td>
</tr>
<tr>
<td valign="top">target</td>
<td valign="top">Generate class files for specific VM version
(e.g., <code>1.1</code> or <code>1.2</code>). <b>Note that the
default value depends on the JVM that is running Ant. In
particular, if you use JDK 1.4 the generated classes will not be
usable for a 1.1 Java VM unless you explicitly set this attribute
to the value 1.1 (which is the default value for JDK 1.1 to
1.3).</b></td>
<td align="center" valign="top">No</td>
</tr>
<tr>
<td valign="top">verbose</td>
<td valign="top">Asks the compiler for verbose output.</td>
<td align="center" valign="top">No</td>
</tr>
<tr>
<td valign="top">depend</td> <td valign="top">Enables dependency-tracking
for compilers that support this (<code>jikes</code> and
<code>classic</code>).</td>
<td align="center" valign="top">No</td>
</tr>
<tr>
<td valign="top">includeAntRuntime</td>
<td valign="top">Whether to include the Ant run-time libraries in the
classpath; defaults to <code>yes</code>.</td>
<td align="center" valign="top">No</td>
</tr>
<tr>
<td valign="top">includeJavaRuntime</td>
<td valign="top">Whether to include the default run-time
libraries from the executing VM in the classpath;
defaults to <code>yes</code>.</td>
<td align="center" valign="top">No</td>
</tr>
<tr>
<td valign="top">fork</td>
<td valign="top">Whether to execute <code>javac</code> using the
JDK compiler externally; defaults to <code>no</code>.</td>
<td align="center" valign="top">No</td>
</tr>
<tr>
<td valign="top">executable</td>
<td valign="top">Complete path to the <code>javac</code>
executable to use in case of <code>fork=&quot;yes&quot;</code>.
Defaults to the compiler of the Java version that is currently
running Ant. Ignored if <code>fork=&quot;no&quot;</code></td>
<td align="center" valign="top">No</td>
</tr>
<tr>
<td valign="top">memoryInitialSize</td>
<td valign="top">The initial size of the memory for the underlying VM,
if <code>javac</code> is run externally; ignored otherwise. Defaults
to the standard VM memory setting.
(Examples: <code>83886080</code>, <code>81920k</code>, or
<code>80m</code>)</td>
<td align="center" valign="top">No</td>
</tr>
<tr>
<td valign="top">memoryMaximumSize</td>
<td valign="top">The maximum size of the memory for the underlying VM,
if <code>javac</code> is run externally; ignored otherwise. Defaults
to the standard VM memory setting.
(Examples: <code>83886080</code>, <code>81920k</code>, or
<code>80m</code>)</td>
<td align="center" valign="top">No</td>
</tr>
<tr>
<td valign="top">failonerror</td> <td valign="top">
Indicates whether the build will continue even if there are compilation errors; defaults to <code>true</code>.
</td>
<td align="center" valign="top">No</td>
</tr>
<tr>
<td valign="top">source</td>
<td valign="top">Value of the <code>-source</code> command-line
switch; will be ignored by all implementations except
<code>javac1.4</code> (or <code>modern</code> when Ant is not
running in a 1.3 VM) and <code>jikes</code>.<br> If you use this
attribute together with <code>jikes</code>, you must make sure
that your version of jikes supports the <code>-source</code>
switch.<br> Legal values are <code>1.3</code> and <code>1.4</code>
&ndash; by default, no <code>-source</code> argument will be used
at all.</td>
<td align="center" valign="top">No</td>
</tr>
<tr>
<td valign="top">compiler</td>
<td valign="top">The compiler implementation to use.
If this attribute is not set, the value of the
<code>build.compiler</code> property, if set, will be used.
Otherwise, the default compiler for the current VM will be used.
(See the above <a href="#compilervalues">list</a> of valid
compilers.)</td>
<td align="center" valign="top">No</td>
</tr>
<tr>
<td valign="top">listfiles</td>
<td valign="top">Indicates whether the source files to be compiled will
be listed; defaults to <code>no</code>.</td>
<td align="center" valign="top">No</td>
</tr>
</table>
<h3>Parameters specified as nested elements</h3>
<p>This task forms an implicit <a href="../CoreTypes/fileset.html">FileSet</a> and
supports all attributes of <code>&lt;fileset&gt;</code>
(<code>dir</code> becomes <code>srcdir</code>) as well as the nested
<code>&lt;include&gt;</code>, <code>&lt;exclude&gt;</code> and
<code>&lt;patternset&gt;</code> elements.</p>
<h4><code>src</code>, <code>classpath</code>, <code>sourcepath</code>,
<code>bootclasspath</code> and <code>extdirs</code></h4>
<p><code>&lt;javac&gt;</code>'s <code>srcdir</code>, <code>classpath</code>,
<code>sourcepath</code>, <code>bootclasspath</code>, and
<code>extdirs</code> attributes are
<a href="../using.html#path">path-like structures</a>
and can also be set via nested
<code>&lt;src&gt;</code>,
<code>&lt;classpath&gt;</code>,
<code>&lt;sourcepath&gt;</code>,
<code>&lt;bootclasspath&gt;</code> and
<code>&lt;extdirs&gt;</code> elements, respectively.</p>
<h4>compilerarg</h4>
<p>You can specify additional command line arguments for the compiler
with nested <code>&lt;compilerarg&gt;</code> elements. These elements
are specified like <a href="../using.html#arg">Command-line
Arguments</a> but have an additional attribute that can be used to
enable arguments only if a given compiler implementation will be
used.</p>
<table border="1" cellpadding="2" cellspacing="0">
<tr>
<td width="12%" valign="top"><b>Attribute</b></td>
<td width="78%" valign="top"><b>Description</b></td>
<td width="10%" valign="top"><b>Required</b></td>
</tr>
<tr>
<td valign="top">value</td>
<td align="center" rowspan="4">See
<a href="../using.html#arg">Command-line Arguments</a>.</td>
<td align="center" rowspan="4">Exactly one of these.</td>
</tr>
<tr>
<td valign="top">line</td>
</tr>
<tr>
<td valign="top">file</td>
</tr>
<tr>
<td valign="top">path</td>
</tr>
<tr>
<td valign="top">compiler</td>
<td>Only pass the specified argument if the chosen
compiler implementation matches the value of this attribute.
Legal values are the
same as those in the above <a href="#compilervalues">list</a> of valid
compilers.)</td>
<td align="center">No</td>
</tr>
</table>
<h3>Examples</h3>
<pre> &lt;javac srcdir=&quot;${src}&quot;
destdir=&quot;${build}&quot;
classpath=&quot;xyz.jar&quot;
debug=&quot;on&quot;
/&gt;</pre>
<p>compiles all <code>.java</code> files under the <code>${src}</code>
directory, and stores
the <code>.class</code> files in the <code>${build}</code> directory.
The classpath used includes <code>xyz.jar</code>, and compiling with
debug information is on.</p>
<pre> &lt;javac srcdir=&quot;${src}&quot;
destdir=&quot;${build}&quot;
fork=&quot;true&quot;
/&gt;</pre>
<p>compiles all <code>.java</code> files under the <code>${src}</code>
directory, and stores the <code>.class</code> files in the
<code>${build}</code> directory. This will fork off the javac
compiler using the default <code>javac</code> executable.</p>
<pre> &lt;javac srcdir=&quot;${src}&quot;
destdir=&quot;${build}&quot;
fork=&quot;java$$javac.exe&quot;
/&gt;</pre>
<p>compiles all <code>.java</code> files under the <code>${src}</code>
directory, and stores the <code>.class</code> files in the
<code>${build}</code> directory. This will fork off the javac
compiler, using the executable named <code>java$javac.exe</code>. Note
that the <code>$</code> sign needs to be escaped by a second one.</p>
<pre> &lt;javac srcdir=&quot;${src}&quot;
destdir=&quot;${build}&quot;
includes=&quot;mypackage/p1/**,mypackage/p2/**&quot;
excludes=&quot;mypackage/p1/testpackage/**&quot;
classpath=&quot;xyz.jar&quot;
debug=&quot;on&quot;
/&gt;</pre>
<p>compiles <code>.java</code> files under the <code>${src}</code>
directory, and stores the
<code>.class</code> files in the <code>${build}</code> directory.
The classpath used includes <code>xyz.jar</code>, and debug information is on.
Only files under <code>mypackage/p1</code> and <code>mypackage/p2</code> are
used. All files in and below the <code>mypackage/p1/testpackage</code>
directory are excluded from compilation.</p>
<pre> &lt;javac srcdir=&quot;${src}:${src2}&quot;
destdir=&quot;${build}&quot;
includes=&quot;mypackage/p1/**,mypackage/p2/**&quot;
excludes=&quot;mypackage/p1/testpackage/**&quot;
classpath=&quot;xyz.jar&quot;
debug=&quot;on&quot;
/&gt;</pre>
<p>is the same as the previous example, with the addition of a second
source path, defined by
the property <code>src2</code>. This can also be represented using nested
<code>&lt;src&gt;</code> elements as follows:</p>
<pre> &lt;javac destdir=&quot;${build}&quot;
classpath=&quot;xyz.jar&quot;
debug=&quot;on&quot;&gt;
&lt;src path=&quot;${src}&quot;/&gt;
&lt;src path=&quot;${src2}&quot;/&gt;
&lt;include name=&quot;mypackage/p1/**&quot;/&gt;
&lt;include name=&quot;mypackage/p2/**&quot;/&gt;
&lt;exclude name=&quot;mypackage/p1/testpackage/**&quot;/&gt;
&lt;/javac&gt;</pre>
<p>If you want to run the javac compiler of a different JDK, you
should tell Ant, where to find the compiler and which version of JDK
you will be using so it can choose the correct command line switches.
The following example executes a JDK 1.1 javac in a new process and
uses the correct command line switches even when Ant is running in a
Java VM of a different version:</p>
<pre> &lt;javac srcdir=&quot;${src}&quot;
destdir=&quot;${build}&quot;
fork=&quot;yes&quot;
executable=&quot;/opt/java/jdk1.1/bin/javac&quot;
compiler=&quot;javac1.1&quot;
/&gt;</pre>
<p><a name="srcdirnote"><b>Note:</b></a>
If you wish to compile only source files located in certain packages below a
common root, use the <code>include</code>/<code>exclude</code> attributes
or <code>&lt;include&gt;</code>/<code>&lt;exclude&gt;</code> nested elements
to filter for these packages. Do not include part of your package structure
in the <code>srcdir</code> attribute
(or nested <code>&lt;src&gt;</code> elements), or Ant will recompile your
source files every time you run your compile target. See the
<a href="http://jakarta.apache.org/ant/faq.html#always-recompiles">Ant FAQ</a>
for additional information.</p>
<p><b>Note:</b> If you are using Ant on Windows and a new DOS window pops up
for every use of an external compiler, this may be a problem of the JDK you are
using. This problem may occur with all JDKs &lt; 1.2.</p>
<h3>Jikes Notes</h3>
<p>Jikes supports some extra options, which can be set be defining
the properties shown below prior to invoking the task. The setting
for each property will be in affect for all <code>&lt;javac&gt;</code>
tasks throughout the build.
The Ant developers are aware that
this is ugly and inflexible &ndash; expect a better solution in the future.
All the options are boolean, and must be set to <code>true</code> or
<code>yes</code> to be
interpreted as anything other than false. By default,
<code>build.compiler.warnings</code> is <code>true</code>,
while all others are <code>false</code>.</p>
<table border="1" cellpadding="2" cellspacing="0">
<tr>
<td valign="top"><b>Property</b></td>
<td valign="top"><b>Description</b></td>
<td align="center" valign="top"><b>Default</b></td>
</tr>
<tr>
<td valign="top">
build.compiler.emacs
</td>
<td valign="top">
Enable emacs-compatible error messages.
</td>
<td valign="top">
<code>false</code>
</td>
</tr>
<tr>
<td valign="top">
build.compiler.fulldepend
</td>
<td valign="top">
Enable full dependency checking; see<br>
the <code>+F</code> switch in the Jikes manual.
</td>
<td valign="top">
<code>false</code>
</td>
</tr>
<tr>
<td valign="top">
build.compiler.pedantic
</td>
<td valign="top">
Enable pedantic warnings.
</td>
<td valign="top">
<code>false</code>
</td>
</tr>
<tr>
<td valign="top">
build.compiler.warnings<br>
<strong>Deprecated</strong>. Use
<code>&lt;javac&gt;</code>'s <code>nowarn</code>
attribute instead.
</td>
<td valign="top">
Don't disable warning messages.
</td>
<td valign="top">
<code>true</code>
</td>
</tr>
</table>
<hr>
<p align="center">Copyright &copy; 2000-2002 Apache Software Foundation.
All rights Reserved.</p>
</body>
</html>