Top Description Inners Fields Constructors Methods
org.apache.tools.ant.taskdefs

public Class MacroInstance

extends Task
implements DynamicAttribute, TaskContainer
Class Inheritance
All Implemented Interfaces
org.apache.tools.ant.TaskContainer, org.apache.tools.ant.DynamicAttribute
Imports
java.util.ArrayList, .Collections, .HashMap, .HashSet, .Hashtable, .List, .Locale, .Map, .Set, org.apache.tools.ant.BuildException, .DynamicAttribute, .ProjectHelper, .RuntimeConfigurable, .Target, .Task, .TaskContainer, .UnknownElement, org.apache.tools.ant.property.LocalProperties, org.apache.tools.ant.taskdefs.MacroDef.Attribute
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 and Inner Type Summary

Modifier and TypeClass and Description
public static class
MacroInstance.Element

Embedded element in macro instance

Field Summary

Modifier and TypeField and Description
private String
implicitTag

private Map<String, String>
localAttributes

private MacroDef
macroDef

private Map<String, String>
map

private Map<String, MacroDef.TemplateElement>
nsElements

private Map<String, UnknownElement>
presentElements

private static final int
STATE_EXPECT_BRACKET

private static final int
STATE_EXPECT_NAME

private static final int
STATE_NORMAL

private String
text

private List<Task>
unknownElements

Inherited from org.apache.tools.ant.Task:
targettaskNametaskTypewrapper

Constructor Summary

AccessConstructor and Description
public
MacroInstance()

Method Summary

Modifier and TypeMethod and Description
public void
addTask(Task
a nested element.
nestedTask)

Implements org.apache.tools.ant.TaskContainer.addTask.

Add a unknownElement for the macro instances nested elements.
public void
addText(String
the text to be added to the macro.
text)

Set the text contents for the macro.

private UnknownElement
copy(UnknownElement ue, boolean nested)

public Object

Returns:

nothing
createDynamicElement(String
not used
name)

Deprecated since 1.6.x.
Method present for BC purposes.
public void
execute()

Overrides org.apache.tools.ant.Task.execute.

Execute the templates instance.
public MacroDef

Returns:

the macro definition object for this macro instance.
getMacroDef()

private Map<String, MacroDef.TemplateElement>
getNsElements()

private String
macroSubs(String s, Map<String, String> macroMapping)

private void
processTasks()

public void
setDynamicAttribute(String
the name of the attribute
name, String
the value of the attribute
value)

Implements org.apache.tools.ant.DynamicAttribute.setDynamicAttribute.

A parameter name value pair as a xml attribute.
public void
setMacroDef(MacroDef
a MacroDef value
macroDef)

Called from MacroDef.MyAntTypeDefinition#create()

Inherited from org.apache.tools.ant.Task:
bindToOwnergetOwningTargetgetRuntimeConfigurableWrappergetTaskNamegetTaskTypegetWrapperhandleErrorFlushhandleErrorOutputhandleFlushhandleInputhandleOutputinitisInvalidloglogloglogmaybeConfigureperformreconfiguresetOwningTargetsetRuntimeConfigurableWrappersetTaskNamesetTaskType

Field Detail

implicitTagback to summary
private String implicitTag
localAttributesback to summary
private Map<String, String> localAttributes
macroDefback to summary
private MacroDef macroDef
mapback to summary
private Map<String, String> map
nsElementsback to summary
private Map<String, MacroDef.TemplateElement> nsElements
presentElementsback to summary
private Map<String, UnknownElement> presentElements
STATE_EXPECT_BRACKETback to summary
private static final int STATE_EXPECT_BRACKET
STATE_EXPECT_NAMEback to summary
private static final int STATE_EXPECT_NAME
STATE_NORMALback to summary
private static final int STATE_NORMAL
textback to summary
private String text
unknownElementsback to summary
private List<Task> unknownElements

Constructor Detail

MacroInstanceback to summary
public MacroInstance()

Method Detail

addTaskback to summary
public void addTask(Task nestedTask)

Implements org.apache.tools.ant.TaskContainer.addTask.

Add a unknownElement for the macro instances nested elements.

Parameters
nestedTask:Task

a nested element.

Annotations
@Override
addTextback to summary
public void addText(String text)

Set the text contents for the macro.

Parameters
text:String

the text to be added to the macro.

copyback to summary
private UnknownElement copy(UnknownElement ue, boolean nested)
createDynamicElementback to summary
public Object createDynamicElement(String name) throws BuildException

Deprecated

since 1.6.x.

Method present for BC purposes.

Parameters
name:String

not used

Returns:Object

nothing

Annotations
@Deprecated
Exceptions
BuildException:
always
executeback to summary
public void execute()

Overrides org.apache.tools.ant.Task.execute.

Execute the templates instance. Copies the unknown element, substitutes the attributes, and calls perform on the unknown element.

Annotations
@Override
getMacroDefback to summary
public MacroDef getMacroDef()
Returns:MacroDef

the macro definition object for this macro instance.

getNsElementsback to summary
private Map<String, MacroDef.TemplateElement> getNsElements()
macroSubsback to summary
private String macroSubs(String s, Map<String, String> macroMapping)
processTasksback to summary
private void processTasks()
setDynamicAttributeback to summary
public void setDynamicAttribute(String name, String value)

Implements org.apache.tools.ant.DynamicAttribute.setDynamicAttribute.

A parameter name value pair as a xml attribute.

Parameters
name:String

the name of the attribute

value:String

the value of the attribute

Annotations
@Override
setMacroDefback to summary
public void setMacroDef(MacroDef macroDef)

Called from MacroDef.MyAntTypeDefinition#create()

Parameters
macroDef:MacroDef

a MacroDef value

org.apache.tools.ant.taskdefs back to summary

public Class MacroInstance.Element

extends Object
implements TaskContainer
Class Inheritance
All Implemented Interfaces
org.apache.tools.ant.TaskContainer
Embedded element in macro instance

Field Summary

Modifier and TypeField and Description
private List<Task>
unknownElements

Constructor Summary

AccessConstructor and Description
public
Element()

Method Summary

Modifier and TypeMethod and Description
public void
addTask(Task
an unknown element
nestedTask)

Implements org.apache.tools.ant.TaskContainer.addTask.

Add an unknown element (to be snipped into the macroDef instance)
public List<Task>

Returns:

the list of unknown elements
getUnknownElements()

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

unknownElementsback to summary
private List<Task> unknownElements

Constructor Detail

Elementback to summary
public Element()

Method Detail

addTaskback to summary
public void addTask(Task nestedTask)

Implements org.apache.tools.ant.TaskContainer.addTask.

Add an unknown element (to be snipped into the macroDef instance)

Parameters
nestedTask:Task

an unknown element

Annotations
@Override
getUnknownElementsback to summary
public List<Task> getUnknownElements()
Returns:List<Task>

the list of unknown elements