org.apache.tools.ant.taskdefs

Class MacroDef


public class MacroDef
extends AntlibDefinition

Describe class MacroDef here.

Since:
Ant 1.6

Nested Class Summary

static class
MacroDef.Attribute
A nested element for the MacroDef task.
static class
MacroDef.NestedSequential
The class corresponding to the sequential nested element.
static class
MacroDef.TemplateElement
A nested element for the MacroDef task.
static class
MacroDef.Text
A nested text element for the MacroDef task.

Field Summary

Fields inherited from class org.apache.tools.ant.Task

description, location, target, taskName, taskType, wrapper

Fields inherited from class org.apache.tools.ant.ProjectComponent

project

Method Summary

void
addConfiguredAttribute(MacroDef.Attribute attribute)
Add an attribute element.
void
addConfiguredElement(MacroDef.TemplateElement element)
Add an element element.
void
addConfiguredText(MacroDef.Text text)
Add the text element.
MacroDef.NestedSequential
createSequential()
This is the sequential nested element of the macrodef.
void
execute()
Create a new ant type based on the embedded tasks and types.
List
getAttributes()
Map
getElements()
UnknownElement
getNestedTask()
Convert the nested sequential to an unknown element
MacroDef.Text
getText()
static boolean
isValidNameCharacter(char c)
Check if a character is a valid character for an element or attribute name
boolean
sameDefinition(Object obj)
Equality method for this definition
void
setName(String name)
Name of the definition
boolean
similar(Object obj)
Similar method for this definition

Methods inherited from class org.apache.tools.ant.taskdefs.AntlibDefinition

getAntlibClassLoader, getURI, setAntlibClassLoader, setURI

Methods inherited from class org.apache.tools.ant.Task

execute, getDescription, getLocation, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, maybeConfigure, perform, reconfigure, setDescription, setLocation, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

Methods inherited from class org.apache.tools.ant.ProjectComponent

getProject, log, log, setProject

Method Details

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.
Overrides:
execute in interface Task


getAttributes

public List getAttributes()

Returns:
the nested Attributes


getElements

public Map getElements()

Returns:
the nested elements


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


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


Copyright B) 2000-2005 Apache Software Foundation. All Rights Reserved.