Java Doc for SubAnt.java in » Build » ANT » org » apache » tools » ant » taskdefs » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » Build » ANT » org.apache.tools.ant.taskdefs

Source Cross Reference Class Diagram Java Document (Java Doc)

org.apache.tools.ant .Task

org.apache.tools.ant.taskdefs .SubAnt

SubAnt

public class SubAnt extends Task (Code)

Calls a given target for all defined sub-builds. This is an extension of ant for bulk project execution.

Use with directories

subant can be used with directory sets to execute a build from different directories. 2 different options are offered

run the same build file /somepath/otherpath/mybuild.xml with different base directories use the genericantfile attribute
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.

since:
Ant1.6

Method Summary
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(Ant.Reference r) Corresponds to `<ant>`'s nested `<reference>` element.
public Path	createBuildpath() Creates a nested build path, and add it to the implicit build path.
public Path.PathElement	createBuildpathElement() Creates a nested `<buildpathelement>`, and add it to the implicit build path.
public void	execute() Runs the various sub-builds.
public void	handleErrorFlush(String output) Pass output sent to System.err to the new project. Parameters: output - The error output to log.
public void	handleErrorOutput(String output) Pass output sent to System.err to the new project. Parameters: output - The error output to log.
public void	handleFlush(String output) Pass output sent to System.out to the new project. Parameters: output - The output to log.
public int	handleInput(byte[] buffer, int offset, int length)
public void	handleOutput(String output) Pass output sent to System.out to the new project.
public void	setAntfile(String antfile) This method builds the file name to use in conjunction with directories. Defaults to "build.xml". If `genericantfile` is set, this attribute is ignored. Parameters: antfile - the short build file name.
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	setFailonerror(boolean failOnError) Sets whether to fail with a build exception on error, or go on.
public void	setGenericAntfile(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	setOutput(String s) Corresponds to `<ant>`'s `output` attribute.
public void	setTarget(String target) The target to call on the different sub-builds.
public void	setVerbose(boolean on) Enable/ disable verbose log messages showing when each sub-build path is entered/ exited.

Method Detail

add
public void add(ResourceCollection rc)(Code)
	Adds a resource collection to the implicit build path. Parameters: rc - the resource collection to add. since: Ant 1.7

addConfiguredTarget
public void addConfiguredTarget(TargetElement t)(Code)
	Add a target to this Ant invocation. Parameters: t - the `TargetElement` to add. since: Ant 1.7

addDirset
public void addDirset(DirSet set)(Code)
	Adds a directory set to the implicit build path. 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! Parameters: set - the directory set to add.

addFilelist
public void addFilelist(FileList list)(Code)
	Adds an ordered file list to the implicit build path. Note that contrary to file and directory sets, file lists can reference non-existent files or directories! Parameters: list - the file list to add.

addFileset
public void addFileset(FileSet set)(Code)
	Adds a file set to the implicit build path. 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! Parameters: set - the file set to add.

addProperty
public void addProperty(Property p)(Code)
	Corresponds to `<ant>`'s nested `<property>` element. Parameters: p - the property to pass on explicitly to the sub-build.

addPropertyset
public void addPropertyset(PropertySet ps)(Code)
	Corresponds to `<ant>`'s nested `<propertyset>` element. Parameters: ps - the propertset

addReference
public void addReference(Ant.Reference r)(Code)
	Corresponds to `<ant>`'s nested `<reference>` element. Parameters: r - the reference to pass on explicitly to the sub-build.

createBuildpath
public Path createBuildpath()(Code)
	Creates a nested build path, and add it to the implicit build path. the newly created nested build path.

createBuildpathElement
public Path.PathElement createBuildpathElement()(Code)
	Creates a nested `<buildpathelement>`, and add it to the implicit build path. the newly created nested build path element.

execute
public void execute()(Code)
	Runs the various sub-builds.

handleErrorFlush
public void handleErrorFlush(String output)(Code)
	Pass output sent to System.err to the new project. Parameters: output - The error output to log. Should not be `null`. since: Ant 1.6.2

handleErrorOutput
public void handleErrorOutput(String output)(Code)
	Pass output sent to System.err to the new project. Parameters: output - The error output to log. Should not be `null`. since: Ant 1.6.2

handleFlush
public void handleFlush(String output)(Code)
	Pass output sent to System.out to the new project. Parameters: output - The output to log. Should not be `null`. since: Ant 1.6.2

handleInput
public int handleInput(byte[] buffer, int offset, int length) throws IOException(Code)
	Process input into the ant task Parameters: buffer - the buffer into which data is to be read. Parameters: offset - the offset into the buffer at which data is stored. Parameters: length - the amount of data to read the number of bytes read exception: IOException - if the data cannot be read See Also: Task.handleInput(byte[]intint) since: Ant 1.6.2

handleOutput
public void handleOutput(String output)(Code)
	Pass output sent to System.out to the new project. Parameters: output - a line of output since: Ant 1.6.2

setAntfile
public void setAntfile(String antfile)(Code)
	This method builds the file name to use in conjunction with directories. Defaults to "build.xml". If `genericantfile` is set, this attribute is ignored. Parameters: antfile - the short build file name. Defaults to "build.xml".

setBuildpath
public void setBuildpath(Path s)(Code)
	Set the buildpath to be used to find sub-projects. Parameters: s - an Ant Path object containing the buildpath.

setBuildpathRef
public void setBuildpathRef(Reference r)(Code)
	Buildpath to use, by reference. Parameters: r - a reference to an Ant Path object containing the buildpath.

setFailonerror
public void setFailonerror(boolean failOnError)(Code)
	Sets whether to fail with a build exception on error, or go on. Parameters: failOnError - the new value for this boolean flag.

setGenericAntfile
public void setGenericAntfile(File afile)(Code)
	This method builds a file path to use in conjunction with directories. Use `genericantfile`, in order to run the same build file with different basedirs. If this attribute is set, `antfile` is ignored. Parameters: afile - (path of the generic ant file, absolute or relative toproject base directory)

setInheritall
public void setInheritall(boolean b)(Code)
	Corresponds to `<ant>`'s `inheritall` attribute. Parameters: b - the new value for this boolean flag.

setInheritrefs
public void setInheritrefs(boolean b)(Code)
	Corresponds to `<ant>`'s `inheritrefs` attribute. Parameters: b - the new value for this boolean flag.

setOutput
public void setOutput(String s)(Code)
	Corresponds to `<ant>`'s `output` attribute. Parameters: s - the filename to write the output to.

setTarget
public void setTarget(String target)(Code)
	The target to call on the different sub-builds. Set to "" to execute the default target. Parameters: target - the target

setVerbose
public void setVerbose(boolean on)(Code)
	Enable/ disable verbose log messages showing when each sub-build path is entered/ exited. The default value is "false". Parameters: on - true to enable verbose mode, false otherwise (default).

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

protected Target target(Code)(Java Doc)
protected String taskName(Code)(Java Doc)
protected String taskType(Code)(Java Doc)
protected RuntimeConfigurable wrapper(Code)(Java Doc)

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

final public void bindToOwner(Task owner)(Code)(Java Doc)
public void execute() throws BuildException(Code)(Java Doc)
public Target getOwningTarget()(Code)(Java Doc)
public RuntimeConfigurable getRuntimeConfigurableWrapper()(Code)(Java Doc)
public String getTaskName()(Code)(Java Doc)
public String getTaskType()(Code)(Java Doc)
protected RuntimeConfigurable getWrapper()(Code)(Java Doc)
protected void handleErrorFlush(String output)(Code)(Java Doc)
protected void handleErrorOutput(String output)(Code)(Java Doc)
protected void handleFlush(String output)(Code)(Java Doc)
protected int handleInput(byte[] buffer, int offset, int length) throws IOException(Code)(Java Doc)
protected void handleOutput(String output)(Code)(Java Doc)
public void init() throws BuildException(Code)(Java Doc)
final protected boolean isInvalid()(Code)(Java Doc)
public void log(String msg)(Code)(Java Doc)
public void log(String msg, int msgLevel)(Code)(Java Doc)
public void log(Throwable t, int msgLevel)(Code)(Java Doc)
public void log(String msg, Throwable t, int msgLevel)(Code)(Java Doc)
public void maybeConfigure() throws BuildException(Code)(Java Doc)
final public void perform()(Code)(Java Doc)
public void reconfigure()(Code)(Java Doc)
public void setOwningTarget(Target target)(Code)(Java Doc)
public void setRuntimeConfigurableWrapper(RuntimeConfigurable wrapper)(Code)(Java Doc)
public void setTaskName(String name)(Code)(Java Doc)
public void setTaskType(String type)(Code)(Java Doc)

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.