Package org.apache.tools.ant.taskdefs
Class MacroInstance
java.lang.Object
org.apache.tools.ant.ProjectComponent
org.apache.tools.ant.Task
org.apache.tools.ant.taskdefs.MacroInstance
- All Implemented Interfaces:
Cloneable,DynamicAttribute,TaskContainer
The class to be placed in the ant type definition.
It is given a pointer to the template definition,
and makes a copy of the unknown element, substituting
the parameter values in attributes and text.
- Since:
- Ant 1.6
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classEmbedded element in macro instance -
Field Summary
Fields inherited from class org.apache.tools.ant.ProjectComponent
description, location, project -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidAdd a unknownElement for the macro instances nested elements.voidSet the text contents for the macro.createDynamicElement(String name) Deprecated.since 1.6.x.voidexecute()Execute the templates instance.voidsetDynamicAttribute(String name, String value) A parameter name value pair as a xml attribute.voidsetMacroDef(MacroDef macroDef) Called from MacroDef.MyAntTypeDefinition#create()Methods inherited from class org.apache.tools.ant.Task
bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, 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
-
MacroInstance
public MacroInstance()
-
-
Method Details
-
setMacroDef
Called from MacroDef.MyAntTypeDefinition#create()- Parameters:
macroDef- aMacroDefvalue
-
getMacroDef
- Returns:
- the macro definition object for this macro instance.
-
setDynamicAttribute
A parameter name value pair as a xml attribute.- Specified by:
setDynamicAttributein interfaceDynamicAttribute- Parameters:
name- the name of the attributevalue- the value of the attribute
-
createDynamicElement
Deprecated.since 1.6.x.Method present for BC purposes.- Parameters:
name- not used- Returns:
- nothing
- Throws:
BuildException- always
-
addTask
Add a unknownElement for the macro instances nested elements.- Specified by:
addTaskin interfaceTaskContainer- Parameters:
nestedTask- a nested element.
-
addText
Set the text contents for the macro.- Parameters:
text- the text to be added to the macro.
-
execute
public void execute()Execute the templates instance. Copies the unknown element, substitutes the attributes, and calls perform on the unknown element.
-