org.apache.tools.ant.taskdefs

Class CallTarget


public class CallTarget
extends Task

Call another target in the same project.
    <target name="foo">
      <antcall target="bar">
        <param name="property1" value="aaaaa" />
        <param name="foo" value="baz" />
       </antcall>
    </target>

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

This only works as expected if neither property1 nor foo are defined in the project itself.

Since:
Ant 1.2

Field Summary

Fields inherited from class org.apache.tools.ant.Task

description, location, target, taskName, taskType, wrapper

Fields inherited from class org.apache.tools.ant.ProjectComponent

project

Method Summary

void
addPropertyset(PropertySet ps)
Set of properties to pass to the new project.
void
addReference(Ant.Reference r)
Reference element identifying a data type to carry over to the invoked target.
Property
createParam()
Property to pass to the invoked target.
void
execute()
hand off the work to the ant task of ours, after setting it up
void
handleErrorFlush(String output)
Pass output sent to System.err to the new project and flush stream.
void
handleErrorOutput(String output)
Pass output sent to System.err to the new project.
void
handleFlush(String output)
Pass output sent to System.out to the new project.
int
handleInput(byte[] buffer, int offset, int length)
void
handleOutput(String output)
Pass output sent to System.out to the new project.
void
init()
init this task by creating new instance of the ant task and configuring it's by calling its own init method.
void
setInheritAll(boolean inherit)
If true, pass all properties to the new Ant project.
void
setInheritRefs(boolean inheritRefs)
If true, pass all references to the new Ant project.
void
setTarget(String target)
Target to execute, required.

Methods inherited from class org.apache.tools.ant.Task

execute, getDescription, getLocation, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, maybeConfigure, perform, reconfigure, setDescription, setLocation, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

Methods inherited from class org.apache.tools.ant.ProjectComponent

getProject, log, log, setProject

Method Details

addPropertyset

public void addPropertyset(PropertySet ps)
Set of properties to pass to the new project.

Since:
Ant 1.6


addReference

public void addReference(Ant.Reference r)
Reference element identifying a data type to carry over to the invoked target.

Since:
Ant 1.5


createParam

public Property createParam()
Property to pass to the invoked target.


execute

public void execute()
            throws BuildException
hand off the work to the ant task of ours, after setting it up
Overrides:
execute in interface Task

Throws:
BuildException - on validation failure or if the target didn't execute


handleErrorFlush

public void handleErrorFlush(String output)
Pass output sent to System.err to the new project and flush stream.
Overrides:
handleErrorFlush in interface Task

Since:
Ant 1.5.2


handleErrorOutput

public void handleErrorOutput(String output)
Pass output sent to System.err to the new project.
Overrides:
handleErrorOutput in interface Task

Since:
Ant 1.5


handleFlush

public void handleFlush(String output)
Pass output sent to System.out to the new project.
Overrides:
handleFlush in interface Task

Since:
Ant 1.5.2


handleInput

public int handleInput(byte[] buffer,
                       int offset,
                       int length)
            throws IOException
Overrides:
handleInput in interface Task

Since:
Ant 1.6

See Also:
Task.handleInput(byte[],int,int)


handleOutput

public void handleOutput(String output)
Pass output sent to System.out to the new project.
Overrides:
handleOutput in interface Task

Since:
Ant 1.5


init

public void init()
init this task by creating new instance of the ant task and configuring it's by calling its own init method.
Overrides:
init in interface Task


setInheritAll

public void setInheritAll(boolean inherit)
If true, pass all properties to the new Ant project. Defaults to true.


setInheritRefs

public void setInheritRefs(boolean inheritRefs)
If true, pass all references to the new Ant project. Defaults to false

Parameters:
inheritRefs - new value


setTarget

public void setTarget(String target)
Target to execute, required.


Copyright B) 2000-2005 Apache Software Foundation. All Rights Reserved.