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 SummaryNested ClassesModifier and TypeClassDescriptionstatic classClass representing an attribute definitionstatic classClass to represent a nested element definition
- 
Field SummaryFields inherited from class org.apache.tools.ant.ProjectComponentdescription, location, project
- 
Constructor SummaryConstructors
- 
Method SummaryModifier 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) Deprecated.voidsetManager(ScriptManager manager) Set the script manager.voidSets the name under which this script will be activated in a build filevoidsetProject(Project project) Set the project.voidsetSetBeans(boolean setBeans) Set the setbeans attribute.voidLoads 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, setReverseLoaderMethods inherited from class org.apache.tools.ant.taskdefs.AntlibDefinitiongetAntlibClassLoader, getURI, setAntlibClassLoader, setURIMethods 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, setTaskTypeMethods inherited from class org.apache.tools.ant.ProjectComponentclone, getDescription, getLocation, getProject, setDescription, setLocation
- 
Constructor Details- 
ScriptDefpublic ScriptDef()Create a newScriptDef.
 
- 
- 
Method Details- 
setProjectSet the project.- Overrides:
- setProjectin class- ProjectComponent
- Parameters:
- project- the project that this definition belongs to.
 
- 
setNameSets the name under which this script will be activated in a build file- Parameters:
- name- the name of the script
 
- 
isAttributeSupportedIndicates 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.
 
- 
addAttributeAdds an attribute definition to this script.- Parameters:
- attribute- the attribute definition.
 
- 
addElementAdds a nested element definition.- Parameters:
- nestedElement- the nested element definition.
 
- 
executepublic void execute()Defines the script.
- 
createNestedElementCreates 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 attributes
- elements- a list of nested element values.
 
- 
executeScriptpublic 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 attributes
- elements- a list of nested element values.
- instance- the script instance; can be null
 
- 
setManagerDeprecated.Defines the manager.- Parameters:
- manager- the scripting manager.
 
- 
setManagerSet the script manager.- Parameters:
- manager-
 
- 
setLanguageDefines 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
 
- 
setSrcLoads the script from an external file; optional.- Parameters:
- file- the file containing the script source.
 
- 
setEncodingSets 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
 
- 
setSetBeanspublic 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.
 
- 
addTextSets the script text.- Parameters:
- text- a component of the script text to be added.
 
- 
addAdds any source resource.- Parameters:
- resource- source of script
- Since:
- Ant 1.7.1
 
 
-