Class Script
java.lang.Object
org.apache.tools.ant.ProjectComponent
org.apache.tools.ant.Task
org.apache.tools.ant.taskdefs.optional.Script
- All Implemented Interfaces:
Cloneable
Executes a script.
-
Field Summary
Fields inherited from class org.apache.tools.ant.ProjectComponent
description, location, project -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidSet the script text.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.voidSet the classpath by reference.voidsetEncoding(String encoding) Set the encoding of the script from an external file; optional.voidsetLanguage(String language) Defines the language (required).voidsetManager(String manager) Deprecated.voidsetManager(ScriptManager manager) Set the script manager.voidsetProject(Project project) Set the project.voidsetSetBeans(boolean setBeans) Set the setbeans attribute.voidLoad the script from an external file; optional.Methods inherited from class org.apache.tools.ant.Task
bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskTypeMethods inherited from class org.apache.tools.ant.ProjectComponent
clone, getDescription, getLocation, getProject, setDescription, setLocation
-
Constructor Details
-
Script
public Script()
-
-
Method Details
-
setProject
Set the project.- Overrides:
setProjectin classProjectComponent- Parameters:
project- the project that this task belongs to.
-
execute
Run the script using the helper object.- Overrides:
executein classTask- Throws:
BuildException- if something goes wrong with the build
-
setManager
Deprecated.Defines the manager.- Parameters:
manager- the scripting manager.
-
setManager
Set the script manager.- Parameters:
manager-
-
setLanguage
Defines the language (required).- Parameters:
language- the scripting language name for the script.
-
setSrc
Load the script from an external file; optional.- Parameters:
fileName- the name of the file containing the script source.
-
addText
Set the script text.- Parameters:
text- a component of the script text to be added.
-
setClasspath
Set the classpath to be used when searching for classes and resources.- Parameters:
classpath- an Ant Path object containing the search path.
-
createClasspath
Classpath to be used when searching for classes and resources.- Returns:
- an empty Path instance to be configured by Ant.
-
setClasspathRef
Set the classpath by reference.- Parameters:
r- a Reference to a Path instance to be used as the classpath value.
-
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.
-
setEncoding
Set the encoding of the script from an external file; optional.- Parameters:
encoding- the encoding of the file containing the script source.- Since:
- Ant 1.10.2
-