org.apache.tools.ant.taskdefs
Class CallTarget

java.lang.Object
  |
  +--org.apache.tools.ant.ProjectComponent
        |
        +--org.apache.tools.ant.Task
              |
              +--org.apache.tools.ant.taskdefs.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
 
Constructor Summary
CallTarget()
           
 
Method Summary
 void addConfiguredTarget(Ant.TargetElement t)
          Add a target to the list of targets to invoke.
 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()
          Create a new Property to pass to the invoked target(s).
 void execute()
          Delegate the work to the ant task instance, after setting it up.
 void handleErrorFlush(java.lang.String output)
          Handles an error line by logging it with the WARN priority.
 void handleErrorOutput(java.lang.String output)
          Handles an error output by logging it with the WARN priority.
 void handleFlush(java.lang.String output)
          Handles output by logging it with the INFO priority.
 int handleInput(byte[] buffer, int offset, int length)
          Handle an input request by this task
 void handleOutput(java.lang.String output)
          Handles output by logging it with the INFO priority.
 void init()
          Initialize this task by creating new instance of the ant task and configuring it 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(java.lang.String target)
          Set target to execute.
 
Methods inherited from class org.apache.tools.ant.Task
getDescription, getLocation, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, isInvalid, log, log, maybeConfigure, perform, reconfigure, setDescription, setLocation, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
 
Methods inherited from class org.apache.tools.ant.ProjectComponent
getProject, setProject
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CallTarget

public CallTarget()
Method Detail

setInheritAll

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

Parameters:
inherit - boolean flag.

setInheritRefs

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

Parameters:
inheritRefs - boolean flag.

init

public void init()
Initialize this task by creating new instance of the ant task and configuring it by calling its own init method.

Overrides:
init in class Task

execute

public void execute()
             throws BuildException
Delegate the work to the ant task instance, after setting it up.

Overrides:
execute in class Task
Throws:
BuildException - on validation failure or if the target didn't execute.

createParam

public Property createParam()
Create a new Property to pass to the invoked target(s).

Returns:
a Property object.

addReference

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

Parameters:
r - the specified Ant.Reference.
Since:
Ant 1.5

addPropertyset

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

Parameters:
ps - the PropertySet to pass.
Since:
Ant 1.6

setTarget

public void setTarget(java.lang.String target)
Set target to execute.

Parameters:
target - the name of the target to execute.

addConfiguredTarget

public void addConfiguredTarget(Ant.TargetElement t)
Add a target to the list of targets to invoke.

Parameters:
t - Ant.TargetElement representing the target.
Since:
Ant 1.6.3

handleOutput

public void handleOutput(java.lang.String output)
Description copied from class: Task
Handles output by logging it with the INFO priority.

Overrides:
handleOutput in class Task
Parameters:
output - The output to log. Should not be null.
Since:
Ant 1.5
See Also:
Task.handleOutput(String)

handleInput

public int handleInput(byte[] buffer,
                       int offset,
                       int length)
                throws java.io.IOException
Description copied from class: Task
Handle an input request by this task

Overrides:
handleInput in class Task
Parameters:
buffer - the buffer into which data is to be read.
offset - the offset into the buffer at which data is stored.
length - the amount of data to read
Returns:
the number of bytes read
Throws:
java.io.IOException - if the data cannot be read
Since:
Ant 1.6
See Also:
Task.handleInput(byte[], int, int)

handleFlush

public void handleFlush(java.lang.String output)
Description copied from class: Task
Handles output by logging it with the INFO priority.

Overrides:
handleFlush in class Task
Parameters:
output - The output to log. Should not be null.
Since:
Ant 1.5.2
See Also:
Task.handleFlush(String)

handleErrorOutput

public void handleErrorOutput(java.lang.String output)
Description copied from class: Task
Handles an error output by logging it with the WARN priority.

Overrides:
handleErrorOutput in class Task
Parameters:
output - The error output to log. Should not be null.
Since:
Ant 1.5
See Also:
Task.handleErrorOutput(String)

handleErrorFlush

public void handleErrorFlush(java.lang.String output)
Description copied from class: Task
Handles an error line by logging it with the WARN priority.

Overrides:
handleErrorFlush in class Task
Parameters:
output - The error output to log. Should not be null.
Since:
Ant 1.5.2
See Also:
Task.handleErrorFlush(String)


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