Package org.apache.tools.ant.taskdefs
Class Ant
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>
- Since:
- Ant 1.1
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classHelper class that implements the nested <reference> element of <ant> and <antcall>.static classHelper class that implements the nested <target> element of <ant> and <antcall>. -
Field Summary
Fields inherited from class org.apache.tools.ant.ProjectComponent
description, location, project -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidAdd a target to this Ant invocation.voidAdd a set of properties to pass to the new project.voidAdd a Reference element identifying a data type to carry over to the new project.Property to pass to the new project.voidexecute()Do the execution.protected StringGet the default build file name to use when launching the task.protected ProjectGet the (sub)-Project instance currently in use.voidhandleErrorFlush(String errorOutputToFlush) Handle error output.voidhandleErrorOutput(String errorOutputToHandle) Handle error output.voidhandleFlush(String toFlush) Handles output.inthandleInput(byte[] buffer, int offset, int length) Handles input.voidhandleOutput(String outputToHandle) Handles output.voidinit()Creates a Project instance for the project to call.voidsetAntfile(String antFile) The build file to use.voidThe directory to use as a base directory for the new Ant project.voidsetInheritAll(boolean value) If true, pass all properties to the new Ant project.voidsetInheritRefs(boolean value) If true, pass all references to the new Ant project.voidSet the filename to write the output to.voidThe target of the new Ant project to execute.voidsetUseNativeBasedir(boolean b) Whether the basedir of the new project should be the same one as it would be when running the build file directly - independent of dir and/or inheritAll settings.Methods inherited from class org.apache.tools.ant.Task
bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskTypeMethods inherited from class org.apache.tools.ant.ProjectComponent
clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
-
Constructor Details
-
Ant
public Ant()simple constructor -
Ant
-
-
Method Details
-
setUseNativeBasedir
public void setUseNativeBasedir(boolean b) Whether the basedir of the new project should be the same one as it would be when running the build file directly - independent of dir and/or inheritAll settings.- Parameters:
b- boolean- Since:
- Ant 1.8.0
-
setInheritAll
public void setInheritAll(boolean value) If true, pass all properties to the new Ant project. Defaults to true.- Parameters:
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.- Parameters:
value- if true, pass all references to the new Ant project
-
init
-
handleOutput
Handles output. Send it the the new project if is present, otherwise call the super class.- Overrides:
handleOutputin classTask- Parameters:
outputToHandle- The string output to output.- Since:
- Ant 1.5
- See Also:
-
handleInput
Handles input. Delegate to the created project, if present, otherwise call the super class.- Overrides:
handleInputin classTask- Parameters:
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.- Returns:
- the number of bytes read.
- Throws:
IOException- if the data cannot be read.- Since:
- Ant 1.6
- See Also:
-
handleFlush
Handles output. Send it the the new project if is present, otherwise call the super class.- Overrides:
handleFlushin classTask- Parameters:
toFlush- The string to output.- Since:
- Ant 1.5.2
- See Also:
-
handleErrorOutput
Handle error output. Send it the the new project if is present, otherwise call the super class.- Overrides:
handleErrorOutputin classTask- Parameters:
errorOutputToHandle- The string to output.- Since:
- Ant 1.5
- See Also:
-
handleErrorFlush
Handle error output. Send it the the new project if is present, otherwise call the super class.- Overrides:
handleErrorFlushin classTask- Parameters:
errorOutputToFlush- The string to output.- Since:
- Ant 1.5.2
- See Also:
-
execute
Do the execution.- Overrides:
executein classTask- Throws:
BuildException- if a target tries to call itself; probably also if a BuildException is thrown by the new project.
-
getDefaultBuildFile
Get the default build file name to use when launching the task.This function may be overridden by providers of custom ProjectHelper so they can easily implement their sublauncher.
- Returns:
- the name of the default file
- Since:
- Ant 1.8.0
-
setDir
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.- Parameters:
dir- new directory asFile.
-
setAntfile
The build file to use. Defaults to "build.xml". This file is expected to be a filename relative to the dir attribute given.- Parameters:
antFile- theStringbuild file name.
-
setTarget
The target of the new Ant project to execute. Defaults to the new project's default target.- Parameters:
targetToAdd- the name of the target to invoke.
-
setOutput
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.- Parameters:
outputFile- the name of the file to which the output should go.
-
createProperty
Property to pass to the new project. The property is passed as a 'user property'.- Returns:
- the created
Propertyobject.
-
addReference
Add a Reference element identifying a data type to carry over to the new project.- Parameters:
ref-Referenceto add.
-
addConfiguredTarget
Add a target to this Ant invocation.- Parameters:
t- theTargetElementto add.- Since:
- Ant 1.6.3
-
addPropertyset
Add a set of properties to pass to the new project.- Parameters:
ps-PropertySetto add.- Since:
- Ant 1.6
-
getNewProject
Get the (sub)-Project instance currently in use.- Returns:
- Project
- Since:
- Ant 1.7
-