Save This Page
Home » apache-ant-1.7.1-src » org.apache.tools » ant » taskdefs » [javadoc | source]
org.apache.tools.ant.taskdefs
public class: Ant [javadoc | source]
java.lang.Object
   org.apache.tools.ant.ProjectComponent
      org.apache.tools.ant.Task
         org.apache.tools.ant.taskdefs.Ant

All Implemented Interfaces:
    Cloneable

Build a sub-project.
<target name="foo" depends="init">
<ant antfile="build.xml" target="bar" >
<property name="property1" value="aaaaa" />
<property name="foo" value="baz" />
</ant>
</target>

<target name="bar" depends="init">
<echo message="prop is ${property1} ${foo}" />
</target>
Nested Class Summary:
public static class  Ant.Reference  Helper class that implements the nested <reference> element of <ant> and <antcall>. 
public static class  Ant.TargetElement  Helper class that implements the nested <target> element of <ant> and <antcall>. 
Fields inherited from org.apache.tools.ant.Task:
target,  taskName,  taskType,  wrapper
Fields inherited from org.apache.tools.ant.ProjectComponent:
project,  location,  description
Constructor:
 public Ant() 
 public Ant(Task owner) 
    create a task bound to its creator
    Parameters:
    owner - owning task
Method from org.apache.tools.ant.taskdefs.Ant Summary:
addConfiguredTarget,   addPropertyset,   addReference,   createProperty,   execute,   getNewProject,   handleErrorFlush,   handleErrorOutput,   handleFlush,   handleInput,   handleOutput,   init,   setAntfile,   setDir,   setInheritAll,   setInheritRefs,   setOutput,   setTarget
Methods from org.apache.tools.ant.Task:
bindToOwner,   execute,   getOwningTarget,   getRuntimeConfigurableWrapper,   getTaskName,   getTaskType,   getWrapper,   handleErrorFlush,   handleErrorOutput,   handleFlush,   handleInput,   handleOutput,   init,   isInvalid,   log,   log,   log,   log,   markInvalid,   maybeConfigure,   perform,   reconfigure,   setOwningTarget,   setRuntimeConfigurableWrapper,   setTaskName,   setTaskType
Methods from org.apache.tools.ant.ProjectComponent:
clone,   getDescription,   getLocation,   getProject,   log,   log,   setDescription,   setLocation,   setProject
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.tools.ant.taskdefs.Ant Detail:
 public  void addConfiguredTarget(Ant.TargetElement t) 
    Add a target to this Ant invocation.
 public  void addPropertyset(PropertySet ps) 
    Add a set of properties to pass to the new project.
 public  void addReference(Ant.Reference ref) 
    Add a Reference element identifying a data type to carry over to the new project.
 public Property createProperty() 
    Property to pass to the new project. The property is passed as a 'user property'.
 public  void execute() throws BuildException 
    Do the execution.
 protected Project getNewProject() 
    Get the (sub)-Project instance currently in use.
 public  void handleErrorFlush(String errorOutputToFlush) 
    Handle error output. Send it the the new project if is present, otherwise call the super class.
 public  void handleErrorOutput(String errorOutputToHandle) 
    Handle error output. Send it the the new project if is present, otherwise call the super class.
 public  void handleFlush(String toFlush) 
    Handles output. Send it the the new project if is present, otherwise call the super class.
 public int handleInput(byte[] buffer,
    int offset,
    int length) throws IOException 
    Handles input. Deleate to the created project, if present, otherwise call the super class.
 public  void handleOutput(String outputToHandle) 
    Handles output. Send it the the new project if is present, otherwise call the super class.
 public  void init() 
    Creates a Project instance for the project to call.
 public  void setAntfile(String antFile) 
    The build file to use. Defaults to "build.xml". This file is expected to be a filename relative to the dir attribute given.
 public  void setDir(File dir) 
    The directory to use as a base directory for the new Ant project. Defaults to the current project's basedir, unless inheritall has been set to false, in which case it doesn't have a default value. This will override the basedir setting of the called project.
 public  void setInheritAll(boolean value) 
    If true, pass all properties to the new Ant project. Defaults to true.
 public  void setInheritRefs(boolean value) 
    If true, pass all references to the new Ant project. Defaults to false.
 public  void setOutput(String outputFile) 
    Set the filename to write the output to. This is relative to the value of the dir attribute if it has been set or to the base directory of the current project otherwise.
 public  void setTarget(String targetToAdd) 
    The target of the new Ant project to execute. Defaults to the new project's default target.