Subant Task
EXPERIMENTAL: This task is experimental and may be under continual change till Ant1.6 ships; it may even be omitted from the product.
Apache Ant
 
Description

EXPERIMENTAL: This task is experimental and may be under continual change till Ant1.6 ships; it may even be omitted from the product.

Calls a given target for all defined sub-builds. This is an extension of ant for bulk project execution.

 
Parameters
Attribute Description Type Requirement
antfile Sets the default build file name to append to directory names found in the build path -default "build.xml" String Optional
buildpath Set the buildpath to be used to find sub-projects. Path
buildpathref Buildpath to use, by reference. Reference
failonerror Sets whether to fail with a build exception on error, or go on. boolean
inheritall Corresponds to <ant>'s inheritall attribute. boolean
inheritrefs Corresponds to <ant>'s inheritrefs attribute. boolean
target String
 
Parameters as nested elements
 
dirset (org.apache.tools.ant.types.DirSet)
Adds a directory set to the implicit build path.

Note that the directories will be added to the build path in no particular order, so if order is significant, one should use a file list instead! Note that the directories will be added to the build path in no particular order, so if order is significant, one should use a file list instead!]]>

 
filelist (org.apache.tools.ant.types.FileList)
Adds an ordered file list to the implicit build path.

Note that contrary to file and directory sets, file lists can reference non-existent files or directories! Note that contrary to file and directory sets, file lists can reference non-existent files or directories!]]>

 
fileset (org.apache.tools.ant.types.FileSet)
Adds a file set to the implicit build path.

Note that the directories will be added to the build path in no particular order, so if order is significant, one should use a file list instead! Note that the directories will be added to the build path in no particular order, so if order is significant, one should use a file list instead!]]>

 
property (org.apache.tools.ant.taskdefs.Property)
Corresponds to <ant>'s nested <property> element. <ant>'s nested <property> element.]]> <ant>'s nested <property> element.]]>
 
propertyset (org.apache.tools.ant.types.PropertySet)
Corresponds to <ant>'s nested <propertyset> element. <ant>'s nested <propertyset> element.]]> <ant>'s nested <propertyset> element.]]>
 
reference (org.apache.tools.ant.taskdefs.Ant.Reference)
Corresponds to <ant>'s nested <reference> element. <ant>'s nested <reference> element.]]> <ant>'s nested <reference> element.]]>
 
buildpath (org.apache.tools.ant.types.Path)
Creates a nested build path, and add it to the implicit build path.
 
buildpathelement (org.apache.tools.ant.types.Path.PathElement)
Creates a nested <buildpathelement>, and add it to the implicit build path. <buildpathelement>, and add it to the implicit build path.]]> <buildpathelement>, and add it to the implicit build path.]]>
 
Example
        <project name="subant" default="subant1">
        <property name="build.dir" value="subant.build"/>
        <target name="subant1">
              <subant failonerror="false" target="">
                  <property name="build.dir" value="subant1.build"/>
                  <property name="not.overloaded" value="not.overloaded"/>
                  <dirset dir="." includes="*"/>
              </subant>
        </target>
        </project>
        

this snippet build file will run ant in each subdirectory of the project directory, where a file called build.xml can be found.


Copyright © 2000-2003, Apache Software Foundation