????
| Current Path : /opt/ant/manual/api/org/apache/tools/ant/taskdefs/ |
| Current File : //opt/ant/manual/api/org/apache/tools/ant/taskdefs/SubAnt.html |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_03) on Tue May 22 06:24:52 CEST 2012 -->
<title>SubAnt (Apache Ant API)</title>
<meta name="date" content="2012-05-22">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="SubAnt (Apache Ant API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/tools/ant/taskdefs/StreamPumper.html" title="class in org.apache.tools.ant.taskdefs"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/tools/ant/taskdefs/Sync.html" title="class in org.apache.tools.ant.taskdefs"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/tools/ant/taskdefs/SubAnt.html" target="_top">Frames</a></li>
<li><a href="SubAnt.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li><a href="#fields_inherited_from_class_org.apache.tools.ant.Task">Field</a> | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.tools.ant.taskdefs</div>
<h2 title="Class SubAnt" class="title">Class SubAnt</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/apache/tools/ant/ProjectComponent.html" title="class in org.apache.tools.ant">org.apache.tools.ant.ProjectComponent</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">org.apache.tools.ant.Task</a></li>
<li>
<ul class="inheritance">
<li>org.apache.tools.ant.taskdefs.SubAnt</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.lang.Cloneable</dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">SubAnt</span>
extends <a href="../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</a></pre>
<div class="block">Calls a given target for all defined sub-builds. This is an extension
of ant for bulk project execution.
<p>
<h2> Use with directories </h2>
<p>
subant can be used with directory sets to execute a build from different directories.
2 different options are offered
</p>
<ul>
<li>
run the same build file /somepath/otherpath/mybuild.xml
with different base directories use the genericantfile attribute
</li>
<li>if you want to run directory1/build.xml, directory2/build.xml, ....
use the antfile attribute. The base directory does not get set by the subant task in this case,
because you can specify it in each build file.
</li>
</ul></div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>Ant1.6</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="fields_inherited_from_class_org.apache.tools.ant.Task">
<!-- -->
</a>
<h3>Fields inherited from class org.apache.tools.ant.<a href="../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</a></h3>
<code><a href="../../../../../org/apache/tools/ant/Task.html#target">target</a>, <a href="../../../../../org/apache/tools/ant/Task.html#taskName">taskName</a>, <a href="../../../../../org/apache/tools/ant/Task.html#taskType">taskType</a>, <a href="../../../../../org/apache/tools/ant/Task.html#wrapper">wrapper</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="fields_inherited_from_class_org.apache.tools.ant.ProjectComponent">
<!-- -->
</a>
<h3>Fields inherited from class org.apache.tools.ant.<a href="../../../../../org/apache/tools/ant/ProjectComponent.html" title="class in org.apache.tools.ant">ProjectComponent</a></h3>
<code><a href="../../../../../org/apache/tools/ant/ProjectComponent.html#description">description</a>, <a href="../../../../../org/apache/tools/ant/ProjectComponent.html#location">location</a>, <a href="../../../../../org/apache/tools/ant/ProjectComponent.html#project">project</a></code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/tools/ant/taskdefs/SubAnt.html#SubAnt()">SubAnt</a></strong>()</code> </td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/taskdefs/SubAnt.html#add(org.apache.tools.ant.types.ResourceCollection)">add</a></strong>(<a href="../../../../../org/apache/tools/ant/types/ResourceCollection.html" title="interface in org.apache.tools.ant.types">ResourceCollection</a> rc)</code>
<div class="block">Adds a resource collection to the implicit build path.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/taskdefs/SubAnt.html#addConfiguredTarget(org.apache.tools.ant.taskdefs.Ant.TargetElement)">addConfiguredTarget</a></strong>(<a href="../../../../../org/apache/tools/ant/taskdefs/Ant.TargetElement.html" title="class in org.apache.tools.ant.taskdefs">Ant.TargetElement</a> t)</code>
<div class="block">Add a target to this Ant invocation.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/taskdefs/SubAnt.html#addDirset(org.apache.tools.ant.types.DirSet)">addDirset</a></strong>(<a href="../../../../../org/apache/tools/ant/types/DirSet.html" title="class in org.apache.tools.ant.types">DirSet</a> set)</code>
<div class="block">Adds a directory set to the implicit build path.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/taskdefs/SubAnt.html#addFilelist(org.apache.tools.ant.types.FileList)">addFilelist</a></strong>(<a href="../../../../../org/apache/tools/ant/types/FileList.html" title="class in org.apache.tools.ant.types">FileList</a> list)</code>
<div class="block">Adds an ordered file list to the implicit build path.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/taskdefs/SubAnt.html#addFileset(org.apache.tools.ant.types.FileSet)">addFileset</a></strong>(<a href="../../../../../org/apache/tools/ant/types/FileSet.html" title="class in org.apache.tools.ant.types">FileSet</a> set)</code>
<div class="block">Adds a file set to the implicit build path.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/taskdefs/SubAnt.html#addProperty(org.apache.tools.ant.taskdefs.Property)">addProperty</a></strong>(<a href="../../../../../org/apache/tools/ant/taskdefs/Property.html" title="class in org.apache.tools.ant.taskdefs">Property</a> p)</code>
<div class="block">Corresponds to <code><ant></code>'s
nested <code><property></code> element.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/taskdefs/SubAnt.html#addPropertyset(org.apache.tools.ant.types.PropertySet)">addPropertyset</a></strong>(<a href="../../../../../org/apache/tools/ant/types/PropertySet.html" title="class in org.apache.tools.ant.types">PropertySet</a> ps)</code>
<div class="block">Corresponds to <code><ant></code>'s
nested <code><propertyset></code> element.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/taskdefs/SubAnt.html#addReference(org.apache.tools.ant.taskdefs.Ant.Reference)">addReference</a></strong>(<a href="../../../../../org/apache/tools/ant/taskdefs/Ant.Reference.html" title="class in org.apache.tools.ant.taskdefs">Ant.Reference</a> r)</code>
<div class="block">Corresponds to <code><ant></code>'s
nested <code><reference></code> element.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/tools/ant/types/Path.html" title="class in org.apache.tools.ant.types">Path</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/taskdefs/SubAnt.html#createBuildpath()">createBuildpath</a></strong>()</code>
<div class="block">Creates a nested build path, and add it to the implicit build path.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/tools/ant/types/Path.PathElement.html" title="class in org.apache.tools.ant.types">Path.PathElement</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/taskdefs/SubAnt.html#createBuildpathElement()">createBuildpathElement</a></strong>()</code>
<div class="block">Creates a nested <code><buildpathelement></code>,
and add it to the implicit build path.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/taskdefs/SubAnt.html#execute()">execute</a></strong>()</code>
<div class="block">Runs the various sub-builds.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/taskdefs/SubAnt.html#getDefaultBuildFile()">getDefaultBuildFile</a></strong>()</code>
<div class="block">Get the default build file name to use when launching the task.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/taskdefs/SubAnt.html#handleErrorFlush(java.lang.String)">handleErrorFlush</a></strong>(java.lang.String output)</code>
<div class="block">Pass output sent to System.err to the new project.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/taskdefs/SubAnt.html#handleErrorOutput(java.lang.String)">handleErrorOutput</a></strong>(java.lang.String output)</code>
<div class="block">Pass output sent to System.err to the new project.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/taskdefs/SubAnt.html#handleFlush(java.lang.String)">handleFlush</a></strong>(java.lang.String output)</code>
<div class="block">Pass output sent to System.out to the new project.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/taskdefs/SubAnt.html#handleInput(byte[], int, int)">handleInput</a></strong>(byte[] buffer,
int offset,
int length)</code>
<div class="block">Process input into the ant task</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/taskdefs/SubAnt.html#handleOutput(java.lang.String)">handleOutput</a></strong>(java.lang.String output)</code>
<div class="block">Pass output sent to System.out to the new project.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/taskdefs/SubAnt.html#setAntfile(java.lang.String)">setAntfile</a></strong>(java.lang.String antfile)</code>
<div class="block">This method builds the file name to use in conjunction with directories.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/taskdefs/SubAnt.html#setBuildpath(org.apache.tools.ant.types.Path)">setBuildpath</a></strong>(<a href="../../../../../org/apache/tools/ant/types/Path.html" title="class in org.apache.tools.ant.types">Path</a> s)</code>
<div class="block">Set the buildpath to be used to find sub-projects.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/taskdefs/SubAnt.html#setBuildpathRef(org.apache.tools.ant.types.Reference)">setBuildpathRef</a></strong>(<a href="../../../../../org/apache/tools/ant/types/Reference.html" title="class in org.apache.tools.ant.types">Reference</a> r)</code>
<div class="block">Buildpath to use, by reference.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/taskdefs/SubAnt.html#setFailonerror(boolean)">setFailonerror</a></strong>(boolean failOnError)</code>
<div class="block">Sets whether to fail with a build exception on error, or go on.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/taskdefs/SubAnt.html#setGenericAntfile(java.io.File)">setGenericAntfile</a></strong>(java.io.File afile)</code>
<div class="block">This method builds a file path to use in conjunction with directories.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/taskdefs/SubAnt.html#setInheritall(boolean)">setInheritall</a></strong>(boolean b)</code>
<div class="block">Corresponds to <code><ant></code>'s
<code>inheritall</code> attribute.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/taskdefs/SubAnt.html#setInheritrefs(boolean)">setInheritrefs</a></strong>(boolean b)</code>
<div class="block">Corresponds to <code><ant></code>'s
<code>inheritrefs</code> attribute.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/taskdefs/SubAnt.html#setOutput(java.lang.String)">setOutput</a></strong>(java.lang.String s)</code>
<div class="block">Corresponds to <code><ant></code>'s
<code>output</code> attribute.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/taskdefs/SubAnt.html#setTarget(java.lang.String)">setTarget</a></strong>(java.lang.String target)</code>
<div class="block">The target to call on the different sub-builds.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/taskdefs/SubAnt.html#setVerbose(boolean)">setVerbose</a></strong>(boolean on)</code>
<div class="block">Enable/ disable verbose log messages showing when each sub-build path is entered/ exited.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.tools.ant.Task">
<!-- -->
</a>
<h3>Methods inherited from class org.apache.tools.ant.<a href="../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</a></h3>
<code><a href="../../../../../org/apache/tools/ant/Task.html#bindToOwner(org.apache.tools.ant.Task)">bindToOwner</a>, <a href="../../../../../org/apache/tools/ant/Task.html#getOwningTarget()">getOwningTarget</a>, <a href="../../../../../org/apache/tools/ant/Task.html#getRuntimeConfigurableWrapper()">getRuntimeConfigurableWrapper</a>, <a href="../../../../../org/apache/tools/ant/Task.html#getTaskName()">getTaskName</a>, <a href="../../../../../org/apache/tools/ant/Task.html#getTaskType()">getTaskType</a>, <a href="../../../../../org/apache/tools/ant/Task.html#getWrapper()">getWrapper</a>, <a href="../../../../../org/apache/tools/ant/Task.html#init()">init</a>, <a href="../../../../../org/apache/tools/ant/Task.html#isInvalid()">isInvalid</a>, <a href="../../../../../org/apache/tools/ant/Task.html#log(java.lang.String)">log</a>, <a href="../../../../../org/apache/tools/ant/Task.html#log(java.lang.String, int)">log</a>, <a href="../../../../../org/apache/tools/ant/Task.html#log(java.lang.String, java.lang.Throwable, int)">log</a>, <a href="../../../../../org/apache/tools/ant/Task.html#log(java.lang.Throwable, int)">log</a>, <a href="../../../../../org/apache/tools/ant/Task.html#maybeConfigure()">maybeConfigure</a>, <a href="../../../../../org/apache/tools/ant/Task.html#perform()">perform</a>, <a href="../../../../../org/apache/tools/ant/Task.html#reconfigure()">reconfigure</a>, <a href="../../../../../org/apache/tools/ant/Task.html#setOwningTarget(org.apache.tools.ant.Target)">setOwningTarget</a>, <a href="../../../../../org/apache/tools/ant/Task.html#setRuntimeConfigurableWrapper(org.apache.tools.ant.RuntimeConfigurable)">setRuntimeConfigurableWrapper</a>, <a href="../../../../../org/apache/tools/ant/Task.html#setTaskName(java.lang.String)">setTaskName</a>, <a href="../../../../../org/apache/tools/ant/Task.html#setTaskType(java.lang.String)">setTaskType</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.tools.ant.ProjectComponent">
<!-- -->
</a>
<h3>Methods inherited from class org.apache.tools.ant.<a href="../../../../../org/apache/tools/ant/ProjectComponent.html" title="class in org.apache.tools.ant">ProjectComponent</a></h3>
<code><a href="../../../../../org/apache/tools/ant/ProjectComponent.html#clone()">clone</a>, <a href="../../../../../org/apache/tools/ant/ProjectComponent.html#getDescription()">getDescription</a>, <a href="../../../../../org/apache/tools/ant/ProjectComponent.html#getLocation()">getLocation</a>, <a href="../../../../../org/apache/tools/ant/ProjectComponent.html#getProject()">getProject</a>, <a href="../../../../../org/apache/tools/ant/ProjectComponent.html#setDescription(java.lang.String)">setDescription</a>, <a href="../../../../../org/apache/tools/ant/ProjectComponent.html#setLocation(org.apache.tools.ant.Location)">setLocation</a>, <a href="../../../../../org/apache/tools/ant/ProjectComponent.html#setProject(org.apache.tools.ant.Project)">setProject</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="SubAnt()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SubAnt</h4>
<pre>public SubAnt()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getDefaultBuildFile()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDefaultBuildFile</h4>
<pre>protected java.lang.String getDefaultBuildFile()</pre>
<div class="block">Get the default build file name to use when launching the task.
<p>
This function may be overrided by providers of custom ProjectHelper so they can implement easily their sub
launcher.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the name of the default file</dd><dt><span class="strong">Since:</span></dt>
<dd>Ant 1.8.0</dd></dl>
</li>
</ul>
<a name="handleOutput(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>handleOutput</h4>
<pre>public void handleOutput(java.lang.String output)</pre>
<div class="block">Pass output sent to System.out to the new project.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../../org/apache/tools/ant/Task.html#handleOutput(java.lang.String)">handleOutput</a></code> in class <code><a href="../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>output</code> - a line of output</dd><dt><span class="strong">Since:</span></dt>
<dd>Ant 1.6.2</dd></dl>
</li>
</ul>
<a name="handleInput(byte[], int, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>handleInput</h4>
<pre>public int handleInput(byte[] buffer,
int offset,
int length)
throws java.io.IOException</pre>
<div class="block">Process input into the ant task</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../../org/apache/tools/ant/Task.html#handleInput(byte[], int, int)">handleInput</a></code> in class <code><a href="../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>buffer</code> - the buffer into which data is to be read.</dd><dd><code>offset</code> - the offset into the buffer at which data is stored.</dd><dd><code>length</code> - the amount of data to read</dd>
<dt><span class="strong">Returns:</span></dt><dd>the number of bytes read</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code> - if the data cannot be read</dd><dt><span class="strong">Since:</span></dt>
<dd>Ant 1.6.2</dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/tools/ant/Task.html#handleInput(byte[], int, int)"><code>Task.handleInput(byte[], int, int)</code></a></dd></dl>
</li>
</ul>
<a name="handleFlush(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>handleFlush</h4>
<pre>public void handleFlush(java.lang.String output)</pre>
<div class="block">Pass output sent to System.out to the new project.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../../org/apache/tools/ant/Task.html#handleFlush(java.lang.String)">handleFlush</a></code> in class <code><a href="../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>output</code> - The output to log. Should not be <code>null</code>.</dd><dt><span class="strong">Since:</span></dt>
<dd>Ant 1.6.2</dd></dl>
</li>
</ul>
<a name="handleErrorOutput(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>handleErrorOutput</h4>
<pre>public void handleErrorOutput(java.lang.String output)</pre>
<div class="block">Pass output sent to System.err to the new project.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../../org/apache/tools/ant/Task.html#handleErrorOutput(java.lang.String)">handleErrorOutput</a></code> in class <code><a href="../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>output</code> - The error output to log. Should not be <code>null</code>.</dd><dt><span class="strong">Since:</span></dt>
<dd>Ant 1.6.2</dd></dl>
</li>
</ul>
<a name="handleErrorFlush(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>handleErrorFlush</h4>
<pre>public void handleErrorFlush(java.lang.String output)</pre>
<div class="block">Pass output sent to System.err to the new project.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../../org/apache/tools/ant/Task.html#handleErrorFlush(java.lang.String)">handleErrorFlush</a></code> in class <code><a href="../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>output</code> - The error output to log. Should not be <code>null</code>.</dd><dt><span class="strong">Since:</span></dt>
<dd>Ant 1.6.2</dd></dl>
</li>
</ul>
<a name="execute()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>execute</h4>
<pre>public void execute()</pre>
<div class="block">Runs the various sub-builds.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../../org/apache/tools/ant/Task.html#execute()">execute</a></code> in class <code><a href="../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</a></code></dd>
</dl>
</li>
</ul>
<a name="setAntfile(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setAntfile</h4>
<pre>public void setAntfile(java.lang.String antfile)</pre>
<div class="block">This method builds the file name to use in conjunction with directories.
<p>Defaults to "build.xml".
If <code>genericantfile</code> is set, this attribute is ignored.</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>antfile</code> - the short build file name. Defaults to "build.xml".</dd></dl>
</li>
</ul>
<a name="setGenericAntfile(java.io.File)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setGenericAntfile</h4>
<pre>public void setGenericAntfile(java.io.File afile)</pre>
<div class="block">This method builds a file path to use in conjunction with directories.
<p>Use <code>genericantfile</code>, in order to run the same build file
with different basedirs.</p>
If this attribute is set, <code>antfile</code> is ignored.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>afile</code> - (path of the generic ant file, absolute or relative to
project base directory)</dd></dl>
</li>
</ul>
<a name="setFailonerror(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFailonerror</h4>
<pre>public void setFailonerror(boolean failOnError)</pre>
<div class="block">Sets whether to fail with a build exception on error, or go on.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>failOnError</code> - the new value for this boolean flag.</dd></dl>
</li>
</ul>
<a name="setTarget(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTarget</h4>
<pre>public void setTarget(java.lang.String target)</pre>
<div class="block">The target to call on the different sub-builds. Set to "" to execute
the default target.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>target</code> - the target
<p></dd></dl>
</li>
</ul>
<a name="addConfiguredTarget(org.apache.tools.ant.taskdefs.Ant.TargetElement)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addConfiguredTarget</h4>
<pre>public void addConfiguredTarget(<a href="../../../../../org/apache/tools/ant/taskdefs/Ant.TargetElement.html" title="class in org.apache.tools.ant.taskdefs">Ant.TargetElement</a> t)</pre>
<div class="block">Add a target to this Ant invocation.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>t</code> - the <code>TargetElement</code> to add.</dd><dt><span class="strong">Since:</span></dt>
<dd>Ant 1.7</dd></dl>
</li>
</ul>
<a name="setVerbose(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setVerbose</h4>
<pre>public void setVerbose(boolean on)</pre>
<div class="block">Enable/ disable verbose log messages showing when each sub-build path is entered/ exited.
The default value is "false".</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>on</code> - true to enable verbose mode, false otherwise (default).</dd></dl>
</li>
</ul>
<a name="setOutput(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setOutput</h4>
<pre>public void setOutput(java.lang.String s)</pre>
<div class="block">Corresponds to <code><ant></code>'s
<code>output</code> attribute.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>s</code> - the filename to write the output to.</dd></dl>
</li>
</ul>
<a name="setInheritall(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setInheritall</h4>
<pre>public void setInheritall(boolean b)</pre>
<div class="block">Corresponds to <code><ant></code>'s
<code>inheritall</code> attribute.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>b</code> - the new value for this boolean flag.</dd></dl>
</li>
</ul>
<a name="setInheritrefs(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setInheritrefs</h4>
<pre>public void setInheritrefs(boolean b)</pre>
<div class="block">Corresponds to <code><ant></code>'s
<code>inheritrefs</code> attribute.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>b</code> - the new value for this boolean flag.</dd></dl>
</li>
</ul>
<a name="addProperty(org.apache.tools.ant.taskdefs.Property)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addProperty</h4>
<pre>public void addProperty(<a href="../../../../../org/apache/tools/ant/taskdefs/Property.html" title="class in org.apache.tools.ant.taskdefs">Property</a> p)</pre>
<div class="block">Corresponds to <code><ant></code>'s
nested <code><property></code> element.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>p</code> - the property to pass on explicitly to the sub-build.</dd></dl>
</li>
</ul>
<a name="addReference(org.apache.tools.ant.taskdefs.Ant.Reference)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addReference</h4>
<pre>public void addReference(<a href="../../../../../org/apache/tools/ant/taskdefs/Ant.Reference.html" title="class in org.apache.tools.ant.taskdefs">Ant.Reference</a> r)</pre>
<div class="block">Corresponds to <code><ant></code>'s
nested <code><reference></code> element.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>r</code> - the reference to pass on explicitly to the sub-build.</dd></dl>
</li>
</ul>
<a name="addPropertyset(org.apache.tools.ant.types.PropertySet)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addPropertyset</h4>
<pre>public void addPropertyset(<a href="../../../../../org/apache/tools/ant/types/PropertySet.html" title="class in org.apache.tools.ant.types">PropertySet</a> ps)</pre>
<div class="block">Corresponds to <code><ant></code>'s
nested <code><propertyset></code> element.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>ps</code> - the propertset</dd></dl>
</li>
</ul>
<a name="addDirset(org.apache.tools.ant.types.DirSet)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addDirset</h4>
<pre>public void addDirset(<a href="../../../../../org/apache/tools/ant/types/DirSet.html" title="class in org.apache.tools.ant.types">DirSet</a> set)</pre>
<div class="block">Adds a directory set to the implicit build path.
<p>
<em>Note that the directories will be added to the build path
in no particular order, so if order is significant, one should
use a file list instead!</em></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>set</code> - the directory set to add.</dd></dl>
</li>
</ul>
<a name="addFileset(org.apache.tools.ant.types.FileSet)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addFileset</h4>
<pre>public void addFileset(<a href="../../../../../org/apache/tools/ant/types/FileSet.html" title="class in org.apache.tools.ant.types">FileSet</a> set)</pre>
<div class="block">Adds a file set to the implicit build path.
<p>
<em>Note that the directories will be added to the build path
in no particular order, so if order is significant, one should
use a file list instead!</em></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>set</code> - the file set to add.</dd></dl>
</li>
</ul>
<a name="addFilelist(org.apache.tools.ant.types.FileList)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addFilelist</h4>
<pre>public void addFilelist(<a href="../../../../../org/apache/tools/ant/types/FileList.html" title="class in org.apache.tools.ant.types">FileList</a> list)</pre>
<div class="block">Adds an ordered file list to the implicit build path.
<p>
<em>Note that contrary to file and directory sets, file lists
can reference non-existent files or directories!</em></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>list</code> - the file list to add.</dd></dl>
</li>
</ul>
<a name="add(org.apache.tools.ant.types.ResourceCollection)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>add</h4>
<pre>public void add(<a href="../../../../../org/apache/tools/ant/types/ResourceCollection.html" title="interface in org.apache.tools.ant.types">ResourceCollection</a> rc)</pre>
<div class="block">Adds a resource collection to the implicit build path.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>rc</code> - the resource collection to add.</dd><dt><span class="strong">Since:</span></dt>
<dd>Ant 1.7</dd></dl>
</li>
</ul>
<a name="setBuildpath(org.apache.tools.ant.types.Path)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setBuildpath</h4>
<pre>public void setBuildpath(<a href="../../../../../org/apache/tools/ant/types/Path.html" title="class in org.apache.tools.ant.types">Path</a> s)</pre>
<div class="block">Set the buildpath to be used to find sub-projects.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>s</code> - an Ant Path object containing the buildpath.</dd></dl>
</li>
</ul>
<a name="createBuildpath()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createBuildpath</h4>
<pre>public <a href="../../../../../org/apache/tools/ant/types/Path.html" title="class in org.apache.tools.ant.types">Path</a> createBuildpath()</pre>
<div class="block">Creates a nested build path, and add it to the implicit build path.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the newly created nested build path.</dd></dl>
</li>
</ul>
<a name="createBuildpathElement()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createBuildpathElement</h4>
<pre>public <a href="../../../../../org/apache/tools/ant/types/Path.PathElement.html" title="class in org.apache.tools.ant.types">Path.PathElement</a> createBuildpathElement()</pre>
<div class="block">Creates a nested <code><buildpathelement></code>,
and add it to the implicit build path.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the newly created nested build path element.</dd></dl>
</li>
</ul>
<a name="setBuildpathRef(org.apache.tools.ant.types.Reference)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setBuildpathRef</h4>
<pre>public void setBuildpathRef(<a href="../../../../../org/apache/tools/ant/types/Reference.html" title="class in org.apache.tools.ant.types">Reference</a> r)</pre>
<div class="block">Buildpath to use, by reference.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>r</code> - a reference to an Ant Path object containing the buildpath.</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/tools/ant/taskdefs/StreamPumper.html" title="class in org.apache.tools.ant.taskdefs"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/tools/ant/taskdefs/Sync.html" title="class in org.apache.tools.ant.taskdefs"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/tools/ant/taskdefs/SubAnt.html" target="_top">Frames</a></li>
<li><a href="SubAnt.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li><a href="#fields_inherited_from_class_org.apache.tools.ant.Task">Field</a> | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>