org.apache.tools.ant.taskdefs.optional.script

Class ScriptDefBase

Implemented Interfaces:
Cloneable, DynamicAttribute, DynamicConfigurator, DynamicElement

public class ScriptDefBase
extends Task
implements DynamicConfigurator

The script execution class. This class finds the defining script task and passes control to that task's executeScript method.
Since:
Ant 1.6

Field Summary

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

target, taskName, taskType, wrapper

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

description, location, project

Method Summary

void
addText(String text)
Set the script text.
Object
createDynamicElement(String name)
Create a nested element
void
execute()
Locate the script defining task and execute the script by passing control to it
void
fail(String message)
Utility method for nested scripts; throws a BuildException with the given message.
String
getText()
get the text of this element; may be null
void
setDynamicAttribute(String name, String value)
Set a task attribute

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

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

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

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

Method Details

addText

public void addText(String text)
Set the script text.
Parameters:
text - a component of the script text to be added.
Since:
ant1.7

createDynamicElement

public Object createDynamicElement(String name)
Create a nested element
Specified by:
createDynamicElement in interface DynamicElement
Parameters:
name - the nested element name
Returns:
the element to be configured

execute

public void execute()
Locate the script defining task and execute the script by passing control to it
Overrides:
execute in interface Task

fail

public void fail(String message)
Utility method for nested scripts; throws a BuildException with the given message.
Parameters:
message - text to pass to the BuildException
Since:
ant1.7

getText

public String getText()
get the text of this element; may be null
Returns:
text or null for no nested text
Since:
ant1.7

setDynamicAttribute

public void setDynamicAttribute(String name,
                                String value)
Set a task attribute
Specified by:
setDynamicAttribute in interface DynamicAttribute
Parameters:
name - the attribute name.
value - the attribute's string value