org.apache.tools.ant.taskdefs
Class Ant
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>
- Ant 1.1
static class | Ant.Reference - Helper class that implements the nested <reference>
element of <ant> and <antcall>.
|
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 new project.
|
Property | createProperty() - Property to pass to the new project.
|
void | execute() - Do the execution.
|
void | handleErrorFlush(String output) - Pass output sent to System.err to the new project.
|
void | handleErrorOutput(String output) - Pass output sent to System.err to the new project.
|
void | handleFlush(String output) - Pass output sent to System.out to the new project.
|
int | handleInput(byte[] buffer, int offset, int length) - Process input into the ant task
|
void | handleOutput(String output) - Pass output sent to System.out to the new project.
|
void | init() - Creates a Project instance for the project to call.
|
void | setAntfile(String s) - The build file to use.
|
void | setDir(File d) - The directory to use as a base directory for the new Ant project.
|
void | setInheritAll(boolean value) - If true, pass all properties to the new Ant project.
|
void | setInheritRefs(boolean value) - If true, pass all references to the new Ant project.
|
void | setOutput(String s) - Filename to write the output to.
|
void | setTarget(String s) - The target of the new Ant project to execute.
|
execute , getDescription , getLocation , getOwningTarget , getRuntimeConfigurableWrapper , getTaskName , getTaskType , getWrapper , handleErrorFlush , handleErrorOutput , handleFlush , handleInput , handleOutput , init , isInvalid , log , log , maybeConfigure , perform , reconfigure , setDescription , setLocation , setOwningTarget , setRuntimeConfigurableWrapper , setTaskName , setTaskType |
addPropertyset
public void addPropertyset(PropertySet ps)
Set of properties to pass to the new project.
ps
- property set to add
- Ant 1.6
addReference
public void addReference(Ant.Reference r)
Reference element identifying a data type to carry
over to the new project.
r
- reference to add
createProperty
public Property createProperty()
Property to pass to the new project.
The property is passed as a 'user property'
- new property created
execute
public void execute()
throws BuildException
Do the execution.
- execute in interface Task
BuildException
- if a target tries to call itself
probably also if a BuildException is thrown by the new project
handleErrorFlush
public void handleErrorFlush(String output)
Pass output sent to System.err to the new project.
- handleErrorFlush in interface Task
output
- The error output to log. Should not be null
.
- Ant 1.5.2
handleErrorOutput
public void handleErrorOutput(String output)
Pass output sent to System.err to the new project.
- handleErrorOutput in interface Task
output
- The error output to log. Should not be null
.
- Ant 1.5
handleFlush
public void handleFlush(String output)
Pass output sent to System.out to the new project.
- handleFlush in interface Task
output
- The output to log. Should not be null
.
- Ant 1.5.2
handleInput
public int handleInput(byte[] buffer,
int offset,
int length)
throws IOException
Process input into the ant task
- handleInput in interface Task
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
- the number of bytes read
- Ant 1.6
Task.handleInput(byte[],int,int)
handleOutput
public void handleOutput(String output)
Pass output sent to System.out to the new project.
- handleOutput in interface Task
output
- a line of output
- Ant 1.5
init
public void init()
Creates a Project instance for the project to call.
- init in interface Task
setAntfile
public void setAntfile(String s)
The build file to use.
Defaults to "build.xml". This file is expected to be a filename relative
to the dir attribute given.
s
- build file to use
setDir
public void setDir(File d)
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.
d
- new directory
setInheritAll
public void setInheritAll(boolean value)
If true, pass all properties to the new Ant project.
Defaults to true.
value
- if true pass all properties to the new Ant project.
setInheritRefs
public void setInheritRefs(boolean value)
If true, pass all references to the new Ant project.
Defaults to false.
value
- if true, pass all references to the new Ant project
setOutput
public void setOutput(String s)
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.
s
- file to which the output should go to
setTarget
public void setTarget(String s)
The target of the new Ant project to execute.
Defaults to the new project's default target.
s
- target to invoke
Copyright B) 2000-2005 Apache Software Foundation. All Rights Reserved.