API Overview API Index Package Overview Direct link to this page
Apache Ant 1.7.1
  org.apache.tools.ant.taskdefs. SubAnt View Source
Author(s)
Since
Ant1.6
Version
Serial
Hierarchy
 Object
      ProjectComponent
          Task
              SubAnt
Implements
Subclasses
Description
public class SubAnt
  Calls a given target for all defined sub-builds.
See also:   
Constructors
public SubAnt ()
Methods
Hide/Show inherited methods
public void add (ResourceCollection rc)
  Adds a resource collection to the implicit build path.
public void addConfiguredTarget (TargetElement t)
  Add a target to this Ant invocation.
public void addDirset (DirSet set)
  Adds a directory set to the implicit build path.
public void addFilelist (FileList list)
  Adds an ordered file list to the implicit build path.
public void addFileset (FileSet set)
  Adds a file set to the implicit build path.
public void addProperty (Property p)
  Corresponds to <ant>'s nested <property> element.
public void addPropertyset (PropertySet ps)
  Corresponds to <ant>'s nested <propertyset> element.
public void addReference (Reference r)
  Corresponds to <ant>'s nested <reference> element.
publicfinal void bindToOwner (Task owner) [Inherited From Task]
  Bind a task to another; use this when configuring a newly created task to do work on behalf of another.
public java.lang.Object clone () throws java.lang.CloneNotSupportedException [Inherited From ProjectComponent]
 
public Path createBuildpath ()
  Creates a nested build path, and add it to the implicit build path.
public PathElement createBuildpathElement ()
  Creates a nested <buildpathelement>, and add it to the implicit build path.
public void execute () [Overrides Task]
Runs the various sub-builds.
public java.lang.String getDescription () [Inherited From ProjectComponent]
  Returns the description of the current action.
public Location getLocation () [Inherited From ProjectComponent]
  Returns the file/location where this task was defined.
public Target getOwningTarget () [Inherited From Task]
  Returns the container target of this task.
public Project getProject () [Inherited From ProjectComponent]
  Returns the project to which this component belongs.
public RuntimeConfigurable getRuntimeConfigurableWrapper () [Inherited From Task]
  Returns the wrapper used for runtime configuration.
public java.lang.String getTaskName () [Inherited From Task]
  Returns the name to use in logging messages.
public java.lang.String getTaskType () [Inherited From Task]
  Return the type of task.
protected RuntimeConfigurable getWrapper () [Inherited From Task]
  Return the runtime configurable structure for this task.
public void handleErrorFlush (java.lang.String output) [Overrides Task]
  Pass output sent to System.err to the new project.
public void handleErrorOutput (java.lang.String output) [Overrides Task]
  Pass output sent to System.err to the new project.
public void handleFlush (java.lang.String output) [Overrides Task]
  Pass output sent to System.out to the new project.
public int handleInput (byte[] buffer, int offset, int length) throws java.io.IOException [Overrides Task]
  Process input into the ant task
public void handleOutput (java.lang.String output) [Overrides Task]
  Pass output sent to System.out to the new project.
public void init () throws BuildException [Inherited From Task]
  Called by the project to let the task initialize properly.
protectedfinal boolean isInvalid () [Inherited From Task]
  Has this task been marked invalid?
public void log (java.lang.String msg) [Inherited From Task]
  Logs a message with the default (INFO) priority.
public void log (java.lang.String msg, int msgLevel) [Inherited From Task]
  Logs a message with the given priority.
public void log (java.lang.String msg, java.lang.Throwable t, int msgLevel) [Inherited From Task]
  Logs a message with the given priority.
public void log (java.lang.Throwable t, int msgLevel) [Inherited From Task]
  Logs a message with the given priority.
public void maybeConfigure () throws BuildException [Inherited From Task]
  Configures this task - if it hasn't been done already.
publicfinal void perform () [Inherited From Task]
  Performs this task if it's still valid, or gets a replacement version and performs that otherwise.
public void reconfigure () [Inherited From Task]
Force the task to be reconfigured from its RuntimeConfigurable.
public void setAntfile (java.lang.String antfile)
  This method builds the file name to use in conjunction with directories.
public void setBuildpath (Path s)
  Set the buildpath to be used to find sub-projects.
public void setBuildpathRef (Reference r)
  Buildpath to use, by reference.
public void setDescription (java.lang.String desc) [Inherited From ProjectComponent]
  Sets a description of the current action.
public void setFailonerror (boolean failOnError)
  Sets whether to fail with a build exception on error, or go on.
public void setGenericAntfile (java.io.File afile)
  This method builds a file path to use in conjunction with directories.
public void setInheritall (boolean b)
  Corresponds to <ant>'s inheritall attribute.
public void setInheritrefs (boolean b)
  Corresponds to <ant>'s inheritrefs attribute.
public void setLocation (Location location) [Inherited From ProjectComponent]
  Sets the file/location where this task was defined.
public void setOutput (java.lang.String s)
  Corresponds to <ant>'s output attribute.
public void setOwningTarget (Target target) [Inherited From Task]
  Sets the target container of this task.
public void setProject (Project project) [Inherited From ProjectComponent]
  Sets the project object of this component.
public void setRuntimeConfigurableWrapper (RuntimeConfigurable wrapper) [Inherited From Task]
  Sets the wrapper to be used for runtime configuration.
public void setTarget (java.lang.String target)
  The target to call on the different sub-builds.
public void setTaskName (java.lang.String name) [Inherited From Task]
  Sets the name to use in logging messages.
public void setTaskType (java.lang.String type) [Inherited From Task]
  Sets the name with which the task has been invoked.
public void setVerbose (boolean on)
  Enable/ disable verbose log messages showing when each sub-build path is entered/ exited.
Fields
Hide/Show inherited fields
protected java.lang.String description [Inherited From ProjectComponent]
Description of this component, if any.
protected Location location [Inherited From ProjectComponent]
Location within the build file of this task definition.
protected Project project [Inherited From ProjectComponent]
Project object of this component.
protected Target target [Inherited From Task]
Target this task belongs to, if any.
protected java.lang.String taskName [Inherited From Task]
  Name of this task to be used for logging purposes.
protected java.lang.String taskType [Inherited From Task]
Type of this task.
protected RuntimeConfigurable wrapper [Inherited From Task]
Wrapper for this object, used to configure it at runtime.
Nested Classes
Generated By: JavaOnTracks Doclet 0.1.4     ©Thibaut Colar