org.apache.tools.ant.taskdefs

Class MacroDef

public class MacroDef extends AntlibDefinition

Describe class MacroDef here.

Since: Ant 1.6

Nested Class Summary
static classMacroDef.Attribute
An attribute for the MacroDef task.
static classMacroDef.NestedSequential
The class corresponding to the sequential nested element.
static classMacroDef.TemplateElement
A nested element for the MacroDef task.
static classMacroDef.Text
A nested text element for the MacroDef task.
Method Summary
voidaddConfiguredAttribute(MacroDef.Attribute attribute)
Add an attribute element.
voidaddConfiguredElement(MacroDef.TemplateElement element)
Add an element element.
voidaddConfiguredText(MacroDef.Text text)
Add the text element.
MacroDef.NestedSequentialcreateSequential()
This is the sequential nested element of the macrodef.
voidexecute()
Create a new ant type based on the embedded tasks and types.
ListgetAttributes()
Gets this macro's attribute (and define?)
booleangetBackTrace()
MapgetElements()
Gets this macro's elements.
UnknownElementgetNestedTask()
Convert the nested sequential to an unknown element
MacroDef.TextgetText()
static booleanisValidNameCharacter(char c)
Check if a character is a valid character for an element or attribute name.
booleansameDefinition(Object obj)
Equality method for this definition
voidsetBackTrace(boolean backTrace)
Set the backTrace attribute.
voidsetName(String name)
Name of the definition
booleansimilar(Object obj)
Similar method for this definition

Method Detail

addConfiguredAttribute

public void addConfiguredAttribute(MacroDef.Attribute attribute)
Add an attribute element.

Parameters: attribute an attribute nested element.

addConfiguredElement

public void addConfiguredElement(MacroDef.TemplateElement element)
Add an element element.

Parameters: element an element nested element.

addConfiguredText

public void addConfiguredText(MacroDef.Text text)
Add the text element.

Parameters: text the nested text element to add

Since: ant 1.6.1

createSequential

public MacroDef.NestedSequential createSequential()
This is the sequential nested element of the macrodef.

Returns: a sequential element to be configured.

execute

public void execute()
Create a new ant type based on the embedded tasks and types.

getAttributes

public List getAttributes()
Gets this macro's attribute (and define?) list.

Returns: the nested Attributes

getBackTrace

public boolean getBackTrace()

Returns: the backTrace attribute.

Since: ant 1.7

getElements

public Map getElements()
Gets this macro's elements.

Returns: the map nested elements, keyed by element name, with {@link TemplateElement} values.

getNestedTask

public UnknownElement getNestedTask()
Convert the nested sequential to an unknown element

Returns: the nested sequential as an unknown element.

getText

public MacroDef.Text getText()

Returns: the nested text element

Since: ant 1.6.1

isValidNameCharacter

public static boolean isValidNameCharacter(char c)
Check if a character is a valid character for an element or attribute name.

Parameters: c the character to check

Returns: true if the character is a letter or digit or '.' or '-' attribute name

sameDefinition

public boolean sameDefinition(Object obj)
Equality method for this definition

Parameters: obj another definition

Returns: true if the definitions are the same

setBackTrace

public void setBackTrace(boolean backTrace)
Set the backTrace attribute.

Parameters: backTrace if true and the macro instance generates an error, a backtrace of the location within the macro and call to the macro will be output. if false, only the location of the call to the macro will be shown. Default is true.

Since: ant 1.7

setName

public void setName(String name)
Name of the definition

Parameters: name the name of the definition

similar

public boolean similar(Object obj)
Similar method for this definition

Parameters: obj another definition

Returns: true if the definitions are similar