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

Class ScriptDef

java.lang.Object

org.apache.tools.ant.ProjectComponent

org.apache.tools.ant.Task

org.apache.tools.ant.taskdefs.AntlibDefinition

org.apache.tools.ant.taskdefs.DefBase

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

All Implemented Interfaces:

Cloneable

public class ScriptDef
extends DefBase

Define a task using a script

Since:

Ant 1.6

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
ScriptDef()

Method Summary

Modifier and Type	Method and Description
void	add(ResourceCollection resource) Add any source resource.
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, 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

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

getAntlibClassLoader, getURI, setAntlibClassLoader, setURI

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

bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, 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, setDescription, setLocation

Methods inherited from class java.lang.Object

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

Constructor Detail

ScriptDef

public ScriptDef()

Method Detail

add

public void add(ResourceCollection resource)

Add any source resource.

Parameters:

resource - source of script

Since:

Ant1.7.1

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 class Task

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 class 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.