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

Class ScriptDef

public class ScriptDef extends DefBase

Define a task using a script

Since: Ant 1.6

Nested Class Summary
static classScriptDef.Attribute
Class representing an attribute definition
static classScriptDef.NestedElement
Class to represent a nested element definition
Method Summary
voidadd(ResourceCollection resource)
Add any source resource.
voidaddAttribute(ScriptDef.Attribute attribute)
Add an attribute definition to this script.
voidaddElement(ScriptDef.NestedElement nestedElement)
Add a nested element definition.
voidaddText(String text)
Set the script text.
ObjectcreateNestedElement(String elementName)
Create a nested element to be configured.
voidexecute()
Define the script.
voidexecuteScript(Map attributes, Map elements)
Execute the script.
voidexecuteScript(Map attributes, Map elements, ScriptDefBase instance)
Execute the script.
booleanisAttributeSupported(String attributeName)
Indicates whether the task supports a given attribute name
voidsetLanguage(String language)
Defines the language (required).
voidsetManager(String manager)
Defines the manager.
voidsetName(String name)
set the name under which this script will be activated in a build file
voidsetProject(Project project)
Set the project.
voidsetSrc(File file)
Load the script from an external file ; optional.

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.

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.

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.