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:
- java.lang.Cloneable
 
 public class ScriptDef extends DefBase Defines a task using a script.- Since:
- Ant 1.6
 
- 
- 
Nested Class SummaryNested Classes Modifier and Type Class Description static classScriptDef.AttributeClass representing an attribute definitionstatic classScriptDef.NestedElementClass to represent a nested element definition
 - 
Field Summary- 
Fields inherited from class org.apache.tools.ant.ProjectComponentdescription, location, project
 
- 
 - 
Constructor SummaryConstructors Constructor Description ScriptDef()
 - 
Method SummaryModifier and Type Method Description voidadd(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.voidaddText(java.lang.String text)Sets the script text.java.lang.ObjectcreateNestedElement(java.lang.String elementName)Creates a nested element to be configured.voidexecute()Defines the script.voidexecuteScript(java.util.Map<java.lang.String,java.lang.String> attributes, java.util.Map<java.lang.String,java.util.List<java.lang.Object>> elements)Deprecated.since 1.7.voidexecuteScript(java.util.Map<java.lang.String,java.lang.String> attributes, java.util.Map<java.lang.String,java.util.List<java.lang.Object>> elements, ScriptDefBase instance)Executes the script.booleanisAttributeSupported(java.lang.String attributeName)Indicates whether the task supports a given attribute namevoidsetCompiled(boolean compiled)Defines the compilation feature; optional.voidsetEncoding(java.lang.String encoding)Sets the encoding of the script from an external file; optional.voidsetLanguage(java.lang.String language)Defines the language (required).voidsetManager(java.lang.String manager)Defines the manager.voidsetName(java.lang.String name)Sets the name under which this script will be activated in a build filevoidsetProject(Project project)Set the project.voidsetSrc(java.io.File file)Loads the script from an external file; optional.- 
Methods inherited from class org.apache.tools.ant.taskdefs.DefBasecreateClasspath, createLoader, getClasspath, getClasspathId, getLoaderId, hasCpDelegate, init, isReverseLoader, setClasspath, setClasspathRef, setLoaderRef, setReverseLoader
 - 
Methods inherited from class org.apache.tools.ant.taskdefs.AntlibDefinitiongetAntlibClassLoader, getURI, setAntlibClassLoader, setURI
 - 
Methods inherited from class org.apache.tools.ant.TaskbindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
 - 
Methods inherited from class org.apache.tools.ant.ProjectComponentclone, getDescription, getLocation, getProject, setDescription, setLocation
 
- 
 
- 
- 
- 
Method Detail- 
setProjectpublic void setProject(Project project) Set the project.- Overrides:
- setProjectin class- ProjectComponent
- Parameters:
- project- the project that this definition belongs to.
 
 - 
setNamepublic void setName(java.lang.String name) Sets the name under which this script will be activated in a build file- Parameters:
- name- the name of the script
 
 - 
isAttributeSupportedpublic boolean isAttributeSupported(java.lang.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.
 
 - 
addAttributepublic void addAttribute(ScriptDef.Attribute attribute) Adds an attribute definition to this script.- Parameters:
- attribute- the attribute definition.
 
 - 
addElementpublic void addElement(ScriptDef.NestedElement nestedElement) Adds a nested element definition.- Parameters:
- nestedElement- the nested element definition.
 
 - 
createNestedElementpublic java.lang.Object createNestedElement(java.lang.String elementName) 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(java.util.Map<java.lang.String,java.lang.String> attributes, java.util.Map<java.lang.String,java.util.List<java.lang.Object>> elements)Deprecated.since 1.7. Use executeScript(attribute, elements, instance) instead.Executes the script.- Parameters:
- attributes- collection of attributes
- elements- a list of nested element values.
 
 - 
executeScriptpublic void executeScript(java.util.Map<java.lang.String,java.lang.String> attributes, java.util.Map<java.lang.String,java.util.List<java.lang.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 attributes
- elements- a list of nested element values.
- instance- the script instance; can be null
 
 - 
setManagerpublic void setManager(java.lang.String manager) Defines the manager.- Parameters:
- manager- the scripting manager.
 
 - 
setLanguagepublic void setLanguage(java.lang.String language) Defines the language (required).- Parameters:
- language- the scripting language name for the script.
 
 - 
setCompiledpublic void setCompiled(boolean compiled) Defines the compilation feature; optional.- Parameters:
- compiled- enables the script compilation if available.
- Since:
- Ant 1.10.2
 
 - 
setSrcpublic void setSrc(java.io.File file) Loads the script from an external file; optional.- Parameters:
- file- the file containing the script source.
 
 - 
setEncodingpublic void setEncoding(java.lang.String encoding) 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
 
 - 
addTextpublic void addText(java.lang.String text) Sets the script text.- Parameters:
- text- a component of the script text to be added.
 
 - 
addpublic void add(ResourceCollection resource) Adds any source resource.- Parameters:
- resource- source of script
- Since:
- Ant 1.7.1
 
 
- 
 
-