Class AbstractScriptComponent
java.lang.Object
org.apache.tools.ant.ProjectComponent
org.apache.tools.ant.types.optional.AbstractScriptComponent
- All Implemented Interfaces:
Cloneable
- Direct Known Subclasses:
ScriptCondition,ScriptMapper
This is a
ProjectComponent that has script support built in
Use it as a foundation for scriptable things.-
Field Summary
Fields inherited from class org.apache.tools.ant.ProjectComponent
description, location, project -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidThe script text.Classpath to be used when searching for classes and resources.protected voidexecuteScript(String execName) Run a scriptGet our script runnerprotected voidInitialize the script runner.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.ProjectComponent
clone, getDescription, getLocation, getProject, log, log, setDescription, setLocation
-
Constructor Details
-
AbstractScriptComponent
public AbstractScriptComponent()
-
-
Method Details
-
setProject
Set the project.- Overrides:
setProjectin classProjectComponent- Parameters:
project- the owner of this component.
-
getRunner
Get our script runner- Returns:
- the runner
-
setSrc
Load the script from an external file; optional.- Parameters:
file- the file containing the script source.
-
addText
The script text.- Parameters:
text- a component of the script text to be added.
-
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.
-
initScriptRunner
protected void initScriptRunner()Initialize the script runner. Calls this before running the system -
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.
-
executeScript
Run a script- Parameters:
execName- name of the script
-
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.- Since:
- Ant 1.8.0
-
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
-