Class ScriptDef
java.lang.Object
org.apache.tools.ant.ProjectComponent
org.apache.tools.ant.Task
org.apache.tools.ant.taskdefs.AntlibDefinition
org.apache.tools.ant.taskdefs.DefBase
org.apache.tools.ant.taskdefs.optional.script.ScriptDef
- All Implemented Interfaces:
Cloneable
Defines a task using a script.
- Since:
- Ant 1.6
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classClass representing an attribute definitionstatic classClass to represent a nested element definition -
Field Summary
Fields inherited from class org.apache.tools.ant.ProjectComponent
description, location, project -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidadd(ResourceCollection resource) Adds any source resource.voidaddAttribute(ScriptDef.Attribute attribute) Adds an attribute definition to this script.voidaddElement(ScriptDef.NestedElement nestedElement) Adds a nested element definition.voidSets the script text.createNestedElement(String elementName) Creates a nested element to be configured.voidexecute()Defines the script.voidDeprecated.since 1.7.voidexecuteScript(Map<String, String> attributes, Map<String, List<Object>> elements, ScriptDefBase instance) Executes the script.booleanisAttributeSupported(String attributeName) Indicates whether the task supports a given attribute namevoidsetCompiled(boolean compiled) Defines the compilation feature; optional.voidsetEncoding(String encoding) Sets the encoding of the script from an external file; optional.voidsetLanguage(String language) Defines the language (required).voidsetManager(String manager) Defines the manager.voidSets the name under which this script will be activated in a build filevoidsetProject(Project project) Set the project.voidLoads the script from an external file; optional.Methods inherited from class org.apache.tools.ant.taskdefs.DefBase
createClasspath, createLoader, getClasspath, getClasspathId, getLoaderId, hasCpDelegate, init, isReverseLoader, setClasspath, setClasspathRef, setLoaderRef, setReverseLoaderMethods inherited from class org.apache.tools.ant.taskdefs.AntlibDefinition
getAntlibClassLoader, getURI, setAntlibClassLoader, setURIMethods inherited from class org.apache.tools.ant.Task
bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, 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
-
ScriptDef
public ScriptDef()
-
-
Method Details
-
setProject
Set the project.- Overrides:
setProjectin classProjectComponent- Parameters:
project- the project that this definition belongs to.
-
setName
Sets the name under which this script will be activated in a build file- Parameters:
name- the name of the script
-
isAttributeSupported
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.
-
addAttribute
Adds an attribute definition to this script.- Parameters:
attribute- the attribute definition.
-
addElement
Adds a nested element definition.- Parameters:
nestedElement- the nested element definition.
-
execute
public void execute()Defines the script. -
createNestedElement
Creates a nested element to be configured.- Parameters:
elementName- the name of the nested element.- Returns:
- object representing the element name.
-
executeScript
@Deprecated public void executeScript(Map<String, String> attributes, Map<String, List<Object>> elements) Deprecated.since 1.7. Use executeScript(attribute, elements, instance) instead.Executes the script.- Parameters:
attributes- collection of attributeselements- a list of nested element values.
-
executeScript
public void executeScript(Map<String, String> attributes, Map<String, List<Object>> elements, ScriptDefBase instance) Executes the script. This is called by the script instance to execute the script for this definition.- Parameters:
attributes- collection of attributeselements- a list of nested element values.instance- the script instance; can be null
-
setManager
Defines the manager.- Parameters:
manager- the scripting manager.
-
setLanguage
Defines the language (required).- Parameters:
language- the scripting language name for the script.
-
setCompiled
public void setCompiled(boolean compiled) Defines the compilation feature; optional.- Parameters:
compiled- enables the script compilation if available.- Since:
- Ant 1.10.2
-
setSrc
Loads the script from an external file; optional.- Parameters:
file- the file containing the script source.
-
setEncoding
Sets 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
-
addText
Sets the script text.- Parameters:
text- a component of the script text to be added.
-
add
Adds any source resource.- Parameters:
resource- source of script- Since:
- Ant 1.7.1
-