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

Class ScriptDef

Implemented Interfaces:
Cloneable

public class ScriptDef
extends DefBase

Define a task using a script
Since:
Ant 1.6

Nested Class Summary

static class
ScriptDef.Attribute
Class representing an attribute definition
static class
ScriptDef.NestedElement
Class to represent a nested element definition

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
addAttribute(ScriptDef.Attribute attribute)
Add an attribute definition to this script.
void
addElement(ScriptDef.NestedElement nestedElement)
Add a nested element definition.
void
addText(String text)
Set the script text.
Object
createNestedElement(String elementName)
Create a nested element to be configured.
void
execute()
Define the script.
void
executeScript(Map attributes, Map elements)
Deprecated. since 1.7.
void
executeScript(Map attributes, Map elements, ScriptDefBase instance)
Execute the script.
boolean
isAttributeSupported(String attributeName)
Indicates whether the task supports a given attribute name
void
setLanguage(String language)
Defines the language (required).
void
setManager(String manager)
Defines the manager.
void
setName(String name)
set the name under which this script will be activated in a build file
void
setProject(Project project)
Set the project.
void
setSrc(File file)
Load the script from an external file ; optional.

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

createClasspath, createLoader, getClasspath, getClasspathId, getLoaderId, hasCpDelegate, init, isReverseLoader, setClasspath, setClasspathRef, setLoaderRef, setReverseLoader

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

getAntlibClassLoader, getURI, setAntlibClassLoader, setURI

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

addAttribute

public void addAttribute(ScriptDef.Attribute attribute)
Add an attribute definition to this script.
Parameters:
attribute - the attribute definition.

addElement

public void addElement(ScriptDef.NestedElement nestedElement)
Add a nested element definition.
Parameters:
nestedElement - the nested element definition.

addText

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

createNestedElement

public Object createNestedElement(String elementName)
Create a nested element to be configured.
Parameters:
elementName - the name of the nested element.
Returns:
object representing the element name.

execute

public void execute()
Define the script.
Overrides:
execute in interface Task

executeScript

public void executeScript(Map attributes,
                          Map elements)

Deprecated. since 1.7. Use executeScript(attribute, elements, instance) instead.

Execute the script.
Parameters:
attributes - collection of attributes
elements - a list of nested element values.

executeScript

public void executeScript(Map attributes,
                          Map elements,
                          ScriptDefBase instance)
Execute the script. This is called by the script instance to execute the script for this definition.
Parameters:
attributes - collection of attributes
elements - a list of nested element values.
instance - the script instance; can be null

isAttributeSupported

public boolean isAttributeSupported(String attributeName)
Indicates whether the task supports a given attribute name
Parameters:
attributeName - the name of the attribute.
Returns:
true if the attribute is supported by the script.

setLanguage

public void setLanguage(String language)
Defines the language (required).
Parameters:
language - the scripting language name for the script.

setManager

public void setManager(String manager)
Defines the manager.
Parameters:
manager - the scripting manager.

setName

public void setName(String name)
set the name under which this script will be activated in a build file
Parameters:
name - the name of the script

setProject

public void setProject(Project project)
Set the project.
Overrides:
setProject in interface ProjectComponent
Parameters:
project - the project that this def belows to.

setSrc

public void setSrc(File file)
Load the script from an external file ; optional.
Parameters:
file - the file containing the script source.