Class MacroInstance

java.lang.Object

org.apache.tools.ant.ProjectComponent

org.apache.tools.ant.Task

org.apache.tools.ant.taskdefs.MacroInstance

All Implemented Interfaces:

Cloneable, DynamicAttribute, TaskContainer

public class MacroInstance
extends Task
implements DynamicAttribute, TaskContainer

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 Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MacroInstance.Element	Embedded element in macro instance

Field Summary

Fields inherited from class Task

target, taskName, taskType, wrapper

Modifier and Type	Field	Description
protected Target	target	Deprecated. since 1.6.x.
protected String	taskName	Deprecated. since 1.6.x.
protected String	taskType	Deprecated. since 1.6.x.
protected RuntimeConfigurable	wrapper	Deprecated. since 1.6.x.

Fields inherited from class ProjectComponent

description, location, project

Modifier and Type	Field	Description
protected String	description	Deprecated. since 1.6.x.
protected Location	location	Deprecated. since 1.6.x.
protected Project	project	Deprecated. since 1.6.x.

Constructor Summary

Constructors

Constructor	Description
MacroInstance()

Method Summary

Modifier and Type	Method	Description
void	addTask(Task nestedTask)	Add a unknownElement for the macro instances nested elements.
void	addText(String text)	Set the text contents for the macro.
Object	createDynamicElement(String name)	Deprecated. since 1.6.x.
void	execute()	Execute the templates instance.
MacroDef	getMacroDef()
void	setDynamicAttribute(String name, String value)	A parameter name value pair as a xml attribute.
void	setMacroDef(MacroDef macroDef)	Called from MacroDef.MyAntTypeDefinition#create()

Methods inherited from class Task

bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

Modifier and Type	Method	Description
final void	bindToOwner(Task owner)	Bind a task to another; use this when configuring a newly created task to do work on behalf of another.
Target	getOwningTarget()	Returns the container target of this task.
RuntimeConfigurable	getRuntimeConfigurableWrapper()	Returns the wrapper used for runtime configuration.
String	getTaskName()	Returns the name to use in logging messages.
String	getTaskType()	Return the type of task.
protected RuntimeConfigurable	getWrapper()	Return the runtime configurable structure for this task.
protected void	handleErrorFlush(String output)	Handles an error line by logging it with the WARN priority.
protected void	handleErrorOutput(String output)	Handles an error output by logging it with the WARN priority.
protected void	handleFlush(String output)	Handles output by logging it with the INFO priority.
protected int	handleInput(byte[] buffer, int offset, int length)	Handle an input request by this task.
protected void	handleOutput(String output)	Handles output by logging it with the INFO priority.
void	init()	Called by the project to let the task initialize properly.
protected final boolean	isInvalid()	Has this task been marked invalid?
void	log(String msg)	Logs a message with the default (INFO) priority.
void	log(String msg, int msgLevel)	Logs a message with the given priority.
void	log(String msg, Throwable t, int msgLevel)	Logs a message with the given priority.
void	log(Throwable t, int msgLevel)	Logs a message with the given priority.
void	maybeConfigure()	Configures this task - if it hasn't been done already.
final void	perform()	Performs this task if it's still valid, or gets a replacement version and performs that otherwise.
void	reconfigure()	Force the task to be reconfigured from its RuntimeConfigurable.
void	setOwningTarget(Target target)	Sets the target container of this task.
void	setRuntimeConfigurableWrapper(RuntimeConfigurable wrapper)	Sets the wrapper to be used for runtime configuration.
void	setTaskName(String name)	Sets the name to use in logging messages.
void	setTaskType(String type)	Sets the name with which the task has been invoked.

Methods inherited from class ProjectComponent

clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject

Modifier and Type	Method	Description
Object	clone()
String	getDescription()	Returns the description of the current action.
Location	getLocation()	Returns the file/location where this task was defined.
Project	getProject()	Returns the project to which this component belongs.
void	setDescription(String desc)	Sets a description of the current action.
void	setLocation(Location location)	Sets the file/location where this task was defined.
void	setProject(Project project)	Sets the project object of this component.

Methods inherited from class Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

MacroInstance

public MacroInstance()

Method Details

setMacroDef

public void setMacroDef(MacroDef macroDef)

Called from MacroDef.MyAntTypeDefinition#create()

Parameters:

macroDef - a MacroDef value

getMacroDef

public MacroDef getMacroDef()

Returns:

the macro definition object for this macro instance.

setDynamicAttribute

public void setDynamicAttribute(String name,
 String value)

A parameter name value pair as a xml attribute.

Specified by:

setDynamicAttribute in interface DynamicAttribute

Parameters:

name - the name of the attribute

value - the value of the attribute

createDynamicElement

@Deprecated
public Object createDynamicElement(String name)
                            throws BuildException

Deprecated.

since 1.6.x.

Method present for BC purposes.

Parameters:

name - not used

Returns:

nothing

Throws:

BuildException - always

addTask

public void addTask(Task nestedTask)

Add a unknownElement for the macro instances nested elements.

Specified by:

addTask in interface TaskContainer

Parameters:

nestedTask - a nested element.

addText

public void addText(String text)

Set the text contents for the macro.

Parameters:

text - the text to be added to the macro.

execute

public void execute()

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

Overrides:

execute in class Task