<control : Ant>

Description

Build a sub-project.
  <target name="foo" depends="init">
    <ant antfile="build.xml" target="bar" >
      <property name="property1" value="aaaaa" />
      <property name="foo" value="baz" />
    </ant>
  </target>

  <target name="bar" depends="init">
    <echo message="prop is ${property1} ${foo}" />
  </target>
 

Parameters

Attribute Description Type Required?
output Set the filename to write the output to. This is relative to the value of the dir attribute if it has been set or to the base directory of the current project otherwise. String ?
inheritall If true, pass all properties to the new Ant project. Defaults to true. boolean ?
dir The directory to use as a base directory 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. File ?
inheritrefs If true, pass all references to the new Ant project. Defaults to false. boolean ?
target The target of the new Ant project to execute. Defaults to the new project's default target. String ?
antfile The build file to use. Defaults to "build.xml". This file is expected to be a filename relative to the dir attribute given. String ?

Parameters accepted as nested elements

<reference>

Helper class that implements the nested <reference> element of <ant> and <antcall>.
Attribute Description Type Required
torefid Set the id that this reference to be stored under in the new project. String ?
refid String ?

<propertyset> ...

A set of properties.
Attribute Description Type Required
refid Sets the value of the refid attribute. Reference ?
dynamic Set whether to reevaluate the set everytime the set is used. Default is true. boolean ?
negate Set whether to negate results. If "true", all properties not selected by nested elements will be returned. Default is "false". boolean ?

<property> ...

Sets a property by name, or set of properties (from file or resource) in the project.

Properties are immutable: whoever sets a property first freezes it for the rest of the build; they are most definitely not variable.

There are five ways to set properties:

Although combinations of these ways are possible, only one should be used at a time. Problems might occur with the order in which properties are set, for instance.

The value part of the properties being set, might contain references to other properties. These references are resolved at the time these properties are set. This also holds for properties loaded from a property file.

Properties are case sensitive.
Attribute Description Type Required
refid Sets a reference to an Ant datatype declared elsewhere. Only yields reasonable results for references PATH like structures or properties. Reference ?
url The url from which to load properties. URL ?
name The name of the property to set. String ?
classpath The classpath to use when looking up a resource. Path ?
userproperty boolean ?
file Filename of a property file to load. File ?
resource The resource name of a property file to load String ?
environment Prefix to use when retrieving environment variables. Thus if you specify environment="myenv" you will be able to access OS-specific environment variables via property names "myenv.PATH" or "myenv.TERM".

Note that if you supply a property name with a final "." it will not be doubled. ie environment="myenv." will still allow access of environment variables through "myenv.PATH" and "myenv.TERM". This functionality is currently only implemented on select platforms. Feel free to send patches to increase the number of platforms this functionality is supported on ;).
Note also that properties are case sensitive, even if the environment variables on your operating system are not, e.g. it will be ${env.Path} not ${env.PATH} on Windows 2000.

String ?
prefix Prefix to apply to properties loaded using file or resource. A "." is appended to the prefix if not specified. String ?
classpathref the classpath to use when looking up a resource, given as reference to a <path> defined elsewhere Reference ?
value The value of the property. String ?

<target>

Helper class that implements the nested <target> element of <ant> and <antcall>.
Attribute Description Type Required
name Set the name of this TargetElement. String ?