Package org.apache.tools.ant.taskdefs
Class MacroDef
java.lang.Object
org.apache.tools.ant.ProjectComponent
org.apache.tools.ant.Task
org.apache.tools.ant.taskdefs.AntlibDefinition
org.apache.tools.ant.taskdefs.MacroDef
- All Implemented Interfaces:
java.lang.Cloneable
public class MacroDef extends AntlibDefinition
Describe class
MacroDef here.- Since:
- Ant 1.6
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classMacroDef.AttributeAn attribute for the MacroDef task.static classMacroDef.NestedSequentialThe class corresponding to the sequential nested element.static classMacroDef.TemplateElementA nested element for the MacroDef task.static classMacroDef.TextA nested text element for the MacroDef task. -
Field Summary
-
Constructor Summary
Constructors Constructor Description MacroDef() -
Method Summary
Modifier and Type Method Description 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.java.util.List<MacroDef.Attribute>getAttributes()Gets this macro's attribute (and define?) list.booleangetBackTrace()java.util.Map<java.lang.String,MacroDef.TemplateElement>getElements()Gets this macro's elements.UnknownElementgetNestedTask()Convert the nested sequential to an unknown elementMacroDef.TextgetText()static booleanisValidNameCharacter(char c)Check if a character is a valid character for an element or attribute name.booleansameDefinition(java.lang.Object obj)Equality method for this definitionvoidsetBackTrace(boolean backTrace)Set the backTrace attribute.voidsetName(java.lang.String name)Name of the definitionbooleansimilar(java.lang.Object obj)Similar method for this definitionMethods inherited from class org.apache.tools.ant.taskdefs.AntlibDefinition
getAntlibClassLoader, getURI, setAntlibClassLoader, setURIMethods 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
-
MacroDef
public MacroDef()
-
-
Method Details
-
setName
public void setName(java.lang.String name)Name of the definition- Parameters:
name- the name of the definition
-
addConfiguredText
Add the text element.- Parameters:
text- the nested text element to add- Since:
- ant 1.6.1
-
getText
- Returns:
- the nested text element
- Since:
- ant 1.6.1
-
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
-
getBackTrace
public boolean getBackTrace()- Returns:
- the backTrace attribute.
- Since:
- ant 1.7
-
createSequential
This is the sequential nested element of the macrodef.- Returns:
- a sequential element to be configured.
-
getNestedTask
Convert the nested sequential to an unknown element- Returns:
- the nested sequential as an unknown element.
-
getAttributes
Gets this macro's attribute (and define?) list.- Returns:
- the nested Attributes
-
getElements
Gets this macro's elements.- Returns:
- the map nested elements, keyed by element name, with
MacroDef.TemplateElementvalues.
-
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
-
addConfiguredAttribute
Add an attribute element.- Parameters:
attribute- an attribute nested element.
-
addConfiguredElement
Add an element element.- Parameters:
element- an element nested element.
-
execute
public void execute()Create a new ant type based on the embedded tasks and types. -
similar
public boolean similar(java.lang.Object obj)Similar method for this definition- Parameters:
obj- another definition- Returns:
- true if the definitions are similar
-
sameDefinition
public boolean sameDefinition(java.lang.Object obj)Equality method for this definition- Parameters:
obj- another definition- Returns:
- true if the definitions are the same
-