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

description, location, target, taskName, taskType, wrapper

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

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)
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
setName(String name)
set the name under which this script will be activated in a build file
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, 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

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

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

getProject, log, log, 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)
Execute the script.
Parameters:
attributes - collection of attributes
elements - a list of nested element values.

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.

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

setSrc

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

Copyright © 2000-2006 Apache Software Foundation. All Rights Reserved.