Runs Ant on a supplied buildfile. This can be used to build subprojects.
When the antfile attribute is omitted, the file "build.xml" in the supplied directory (dir attribute) is used.
If no target attribute is supplied, the default target of the new project is used.
By default, all of the properties of the current project will be
available in the new project. Alternatively, you can
set the inheritAll attribute to false and only
"user" properties (i.e., those passed on the command-line)
will be passed to the new project. In either case, the set of
properties passed to the new project will override the properties that
are set in the new project (See also the property task).
You can also set properties in the new project from the old project by using nested property tags. These properties are always passed regardless of the setting of inheritAll. This allows you to parameterize your subprojects.
| Attribute | Description | Required |
| antfile | the buildfile to use. Defaults to "build.xml". This file is expected to be a filename relative to the dir attribute given. | No |
| dir | the directory to use as a basedir for the new Ant project. Defaults to the current project's basedir, unless inheritall has been set to false, in which case it doesn't have a default value. This will override the basedir setting of the called project. | No |
| target | the target of the new Ant project that should be executed. Defaults to the new project's default target. | No |
| output | Filename to write the ant output to. | No |
| inheritAll | If true, pass all properties to the new Ant
project. Defaults to true.
|
No |
The basedir value of the new project is affected by the two attributes dir and inheritall, see the following table for details:
| dir attribute | inheritAll attribute | new project's basedir |
| value provided | true | value of dir attribute |
| value provided | false | value of dir attribute |
| omitted | true | basedir of calling project (the one whose build file contains the <ant> task). |
| omitted | false | basedir attribute of the <project> element of the new project |
<ant antfile="subproject/subbuild.xml" dir="subproject" target="compile"/>
<ant dir="subproject"/>
<ant antfile="subproject/property_based_subbuild.xml">
<property name="param1" value="version 1.x"/>
<property file="config/subproject/default.properties"/>
</ant>
<ant inheritAll="false" antfile="subproject/subbuild.xml">
<property name="output.type" value="html"/>
</ant>
Copyright © 2000,2001 Apache Software Foundation. All rights Reserved.