The for task iterates over a list, a list of paths, or any type that has a public iterator() method. The list will be evaluated first. Nested paths are evaluated in the order they appear in the task. Nested types will then be evalulated.
This task is the same as the <foreach> task, except that it uses a nested sequential for each iteration. It makes use of ant's macrodef task, so the @{} notation is used for parameter substition.
This task only works for ant version greater than or equal to ant 1.6.0.
Attribute | Description | Required |
---|---|---|
list | The list of values to process, with the delimiter character, indicated by the "delimiter" attribute, separating each value. | Yes, unless a nested path has been specified. |
param | Name of the parameter to pass the tokens or files in as to the sequential. | Yes |
delimiter | The delimiter string that separates the values in the "list" attribute. | No, defaults to ",". |
parallel | If true , all instances of the called
target will execute in parallel. Defaults to false ,
which forces sequential execution of the targets. It is up to
the caller to ensure that parallel execution is safe.
| No |
threadCount | The maximum number of allowable threads when executing in parallel. | No. Defaults to 5. |
trim | If true , any leading or trailing
whitespace will be removed from the list item before it is passed
to the sequential.
|
No. Defaults to false. |
Paths are used to select sets of files or directories to iterate over.
Using a path allows you to determine the order by which files
are considered by using
filelists
or explicit pathelements
. You also can specify
whether you want to iterate over files or directories by chosing
either filesets or
dirsets.
FileSets are used to select sets of files to iterate over.
DirSets are used to select sets of directories to iterate over.
To print out the first five letters of the latin alphabet:
<echo message="The first five letters of the alphabet are:"/> <for list="a,b,c,d,e" param="letter"> <sequential> <echo>Letter @{letter}</echo> </sequential> </for>
A more complicated example to to iterate over a set of c++ source files and invoke the cc task on them:
<for param="file"> <path> <fileset dir="${test.dir}/mains" includes="*.cpp"/> </path> <sequential> <propertyregex override="yes" property="program" input="@{file}" regexp=".*/([^\.]*)\.cpp" replace="\1"/> <mkdir dir="${obj.dir}/${program}"/> <mkdir dir="${build.bin.dir}"/> <cc link="executable" objdir="${obj.dir}/${program}" outfile="${build.bin.dir}/${program}"> <compiler refid="compiler.options"/> <fileset file="@{file}"/> <linker refid="linker-libs"/> </cc> </sequential> </for>
The following example embeds an outofdate type and iterates over the sources that are newer than their corresponding targets.
<ac:for param="xmlfile" xmlns:ac="antlib:net.sf.antcontrib"> <ac:outofdate> <ac:sourcefiles> <ac:fileset dir="${basedir}/xdocs" includes="**/*.xml"/> </ac:sourcefiles> <ac:mapper dir="${basedir}/xdocs" type="glob" from="*.xml" to="${basedir}/docs/*.html"/> </ac:outofdate> <ac:sequential> <echo>Need to generate a target html file from source file @{xmlfile}</echo> </ac:sequential> </ac:for>
Copyright © 2003-2004 Ant-Contrib Project. All rights Reserved.