org.apache.tools.ant.taskdefs.optional

Class Script

public class Script extends Task

Executes a script.

UNKNOWN: name="script"

Method Summary
voidaddText(String text)
Set the script text.
PathcreateClasspath()
Classpath to be used when searching for classes and resources.
voidexecute()
Run the script using the helper object.
voidsetClasspath(Path classpath)
Set the classpath to be used when searching for classes and resources.
voidsetClasspathRef(Reference r)
Set the classpath by reference.
voidsetLanguage(String language)
Defines the language (required).
voidsetManager(String manager)
Defines the manager.
voidsetProject(Project project)
Set the project.
voidsetSetBeans(boolean setBeans)
Set the setbeans attribute.
voidsetSrc(String fileName)
Load the script from an external file ; optional.

Method Detail

addText

public void addText(String text)
Set the script text.

Parameters: text a component of the script text to be added.

createClasspath

public Path createClasspath()
Classpath to be used when searching for classes and resources.

Returns: an empty Path instance to be configured by Ant.

execute

public void execute()
Run the script using the helper object.

Throws: BuildException if something goes wrong with the build

setClasspath

public void setClasspath(Path classpath)
Set the classpath to be used when searching for classes and resources.

Parameters: classpath an Ant Path object containing the search path.

setClasspathRef

public void setClasspathRef(Reference r)
Set the classpath by reference.

Parameters: r a Reference to a Path instance to be used as the classpath value.

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.

setProject

public void setProject(Project project)
Set the project.

Parameters: project the project that this task belongs to.

setSetBeans

public void setSetBeans(boolean setBeans)
Set the setbeans attribute. If this is true, <script> will create variables in the script instance for all properties, targets and references of the current project. It this is false, only the project and self variables will be set. The default is true.

Parameters: setBeans the value to set.

setSrc

public void setSrc(String fileName)
Load the script from an external file ; optional.

Parameters: fileName the name of the file containing the script source.