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
- 
Nested Class SummaryNested ClassesModifier and TypeClassDescriptionstatic classAn attribute for the MacroDef task.static classThe class corresponding to the sequential nested element.static classA nested element for the MacroDef task.static classA nested text element for the MacroDef task.
- 
Field SummaryFields inherited from class org.apache.tools.ant.ProjectComponentdescription, location, project
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionvoidaddConfiguredAttribute(MacroDef.Attribute attribute) Add an attribute element.voidAdd an element element.voidAdd the text element.This is the sequential nested element of the macrodef.voidexecute()Create a new ant type based on the embedded tasks and types.Gets this macro's attribute (and define?) list.booleanGets this macro's elements.Convert the nested sequential to an unknown elementgetText()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 definitionvoidsetBackTrace(boolean backTrace) Set the backTrace attribute.voidName of the definitionbooleanSimilar method for this definitionMethods inherited from class org.apache.tools.ant.taskdefs.AntlibDefinitiongetAntlibClassLoader, getURI, setAntlibClassLoader, setURIMethods inherited from class org.apache.tools.ant.TaskbindToOwner, 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.ProjectComponentclone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
- 
Constructor Details- 
MacroDefpublic MacroDef()
 
- 
- 
Method Details- 
setNameName of the definition- Parameters:
- name- the name of the definition
 
- 
addConfiguredTextAdd 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
 
- 
setBackTracepublic 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
 
- 
getBackTracepublic boolean getBackTrace()- Returns:
- the backTrace attribute.
- Since:
- ant 1.7
 
- 
createSequentialThis is the sequential nested element of the macrodef.- Returns:
- a sequential element to be configured.
 
- 
getNestedTaskConvert the nested sequential to an unknown element- Returns:
- the nested sequential as an unknown element.
 
- 
getAttributesGets this macro's attribute (and define?) list.- Returns:
- the nested Attributes
 
- 
getElementsGets this macro's elements.- Returns:
- the map nested elements, keyed by element name, with
         MacroDef.TemplateElementvalues.
 
- 
isValidNameCharacterpublic 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
 
- 
addConfiguredAttributeAdd an attribute element.- Parameters:
- attribute- an attribute nested element.
 
- 
addConfiguredElementAdd an element element.- Parameters:
- element- an element nested element.
 
- 
execute
- 
similarSimilar method for this definition- Parameters:
- obj- another definition
- Returns:
- true if the definitions are similar
 
- 
sameDefinitionEquality method for this definition- Parameters:
- obj- another definition
- Returns:
- true if the definitions are the same
 
 
-