Package groovy.util
Class AntBuilder
java.lang.Object
groovy.lang.GroovyObjectSupport
groovy.util.BuilderSupport
groovy.util.AntBuilder
- All Implemented Interfaces:
GroovyObject
Allows Ant tasks to
be used with a Groovy builder-style markup. Requires that {{ant.jar}} is on your classpath which will
happen automatically if you are using the Groovy distribution but will be up
to you to organize if you are embedding Groovy. If you wish to use the
optional tasks
you will need to add one or more additional jars from the ant distribution to
your classpath - see the library
dependencies for more details.
- Author:
- James Strachan, Dierk Koenig (dk), Marc Guillemot, Paul King
-
Constructor Summary
ConstructorDescriptionAntBuilder
(Project project) AntBuilder
(Project project, Target owningTarget) AntBuilder
(Task parentTask) -
Method Summary
Modifier and TypeMethodDescriptionprotected static Attributes
buildAttributes
(Map attributes) Builds anAttributes
from aMap
protected Object
createNode
(Object tagName) protected Object
createNode
(Object name, Object value) protected Object
createNode
(Object name, Map attributes) protected Object
createNode
(Object name, Map attributes, Object value) protected static Project
protected Object
doInvokeMethod
(String methodName, Object name, Object args) We don't want to return the node as created increateNode(Object, Map, Object)
but the one made ready bynodeCompleted(Object, Object)
Gets the xml context of Ant used while creating tasks# Gets the Ant project in which the tasks are executedboolean
Whether stdin, stdout, stderr streams are saved.protected void
nodeCompleted
(Object parent, Object node) Determines, when the ANT Task that is represented by the "node" should perform.protected void
void
setSaveStreams
(boolean saveStreams) Indicates that we save stdin, stdout, stderr and replace them while AntBuilder is executing tasks with streams that funnel the normal streams into Ant's logs.protected void
Methods inherited from class groovy.util.BuilderSupport
getCurrent, getName, invokeMethod, invokeMethod, postNodeCompletion, setClosureDelegate, setCurrent
Methods inherited from class groovy.lang.GroovyObjectSupport
getMetaClass, getProperty, setMetaClass, setProperty
-
Constructor Details
-
AntBuilder
public AntBuilder() -
AntBuilder
-
AntBuilder
-
AntBuilder
-
-
Method Details
-
getProject
# Gets the Ant project in which the tasks are executed- Returns:
- the project
-
getAntXmlContext
Gets the xml context of Ant used while creating tasks- Returns:
- the Ant xml context
-
isSaveStreams
public boolean isSaveStreams()Whether stdin, stdout, stderr streams are saved.- Returns:
- true if we are saving streams
- See Also:
-
setSaveStreams
public void setSaveStreams(boolean saveStreams) Indicates that we save stdin, stdout, stderr and replace them while AntBuilder is executing tasks with streams that funnel the normal streams into Ant's logs.- Parameters:
saveStreams
- set to false to disable this behavior
-
createProject
- Returns:
- Factory method to create new Project instances
-
setParent
- Specified by:
setParent
in classBuilderSupport
-
doInvokeMethod
We don't want to return the node as created increateNode(Object, Map, Object)
but the one made ready bynodeCompleted(Object, Object)
- Overrides:
doInvokeMethod
in classBuilderSupport
- See Also:
-
nodeCompleted
Determines, when the ANT Task that is represented by the "node" should perform. Node must be an ANT Task or no "perform" is called. If node is an ANT Task, it performs right after complete construction. If node is nested in a TaskContainer, calling "perform" is delegated to that TaskContainer.- Overrides:
nodeCompleted
in classBuilderSupport
- Parameters:
parent
- note: null when node is rootnode
- the node that now has all its children applied
-
createNode
- Specified by:
createNode
in classBuilderSupport
-
createNode
- Specified by:
createNode
in classBuilderSupport
-
createNode
- Specified by:
createNode
in classBuilderSupport
-
buildAttributes
Builds anAttributes
from aMap
- Parameters:
attributes
- the attributes to wrap- Returns:
- the wrapped attributes
-
createNode
- Specified by:
createNode
in classBuilderSupport
-
setText
-
getAntProject
-