[guide] $iteration:

The $iteration: value uri lets you extract information about the current iteration for diagnostic and debugging purposes. You must explicitly install this value uri’s handler; read the Examples section to see how this is done.

Parameters

The general form of the uri is: $iteration:feature[?arg1[,,arg2]] where feature is the iteration feature you want to inspect and arg1 and arg2 are optional arguments that control the operation. Not every feature requires additional arguments. The standard AntX iteration’s visible features are listed below; other AntX-based tools can extend this set to include additional features.

• id: the iteration’s unique identifier.
• classname: the iteration’s fully qualified class name.
• property?name: the value of iteration property name.
• propertieslike?pattern: the key-values of iteration properties whose keys match pattern.
• valueuri?scheme: the scheme value uri handler’s class name.

Examples

1) The following snippet declares the default scheme name for the iteration info uri handler: $iteration:. This is usually done by an “init” target or at the project’s top level.

    <manageuris action="install">
        <parameter name="iteration"
            value="com.idaremedia.antx.valueuri.info.IterationInfoValueURIHandler"/>
    </manageuris>

2) The following snippet defines part of a debugging target dumpfixture that includes iteration information in the generated snapshot file.

    <target name="dumpfixture">
        <assert isnotset="dumpfile"/>
        <newtempfile persist="yes" pathproperty="dumpfile">
            <line value="Iteration ID: ${$iteration:id}"/>
            <line value="Iteration Class: ${$iteration:classname}"/>
            <propertyset>
                …[other bits of information]
            </propertyset>
        </newtempfile>
        <echo message="DumpFixture File: ${dumpfile}"/>
    </target>

Related Topics

• IterationInfoValueURIHandler implements the $iteration: handler.