public class ScriptDef extends DefBase
Modifier and Type | Class and Description |
---|---|
static class |
ScriptDef.Attribute
Class representing an attribute definition
|
static class |
ScriptDef.NestedElement
Class to represent a nested element definition
|
description, location, project
Constructor and Description |
---|
ScriptDef() |
Modifier and Type | Method and Description |
---|---|
void |
add(ResourceCollection resource)
Adds any source resource.
|
void |
addAttribute(ScriptDef.Attribute attribute)
Adds an attribute definition to this script.
|
void |
addElement(ScriptDef.NestedElement nestedElement)
Adds a nested element definition.
|
void |
addText(java.lang.String text)
Sets the script text.
|
java.lang.Object |
createNestedElement(java.lang.String elementName)
Creates a nested element to be configured.
|
void |
execute()
Defines the script.
|
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.
|
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.
|
boolean |
isAttributeSupported(java.lang.String attributeName)
Indicates whether the task supports a given attribute name
|
void |
setCompiled(boolean compiled)
Defines the compilation feature; optional.
|
void |
setEncoding(java.lang.String encoding)
Sets the encoding of the script from an external file; optional.
|
void |
setLanguage(java.lang.String language)
Defines the language (required).
|
void |
setManager(java.lang.String manager)
Defines the manager.
|
void |
setName(java.lang.String name)
Sets the name under which this script will be activated in a build
file
|
void |
setProject(Project project)
Set the project.
|
void |
setSrc(java.io.File file)
Loads the script from an external file; optional.
|
createClasspath, createLoader, getClasspath, getClasspathId, getLoaderId, hasCpDelegate, init, isReverseLoader, setClasspath, setClasspathRef, setLoaderRef, setReverseLoader
getAntlibClassLoader, getURI, setAntlibClassLoader, setURI
bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
clone, getDescription, getLocation, getProject, setDescription, setLocation
public void setProject(Project project)
setProject
in class ProjectComponent
project
- the project that this definition belongs to.public void setName(java.lang.String name)
name
- the name of the scriptpublic boolean isAttributeSupported(java.lang.String attributeName)
attributeName
- the name of the attribute.public void addAttribute(ScriptDef.Attribute attribute)
attribute
- the attribute definition.public void addElement(ScriptDef.NestedElement nestedElement)
nestedElement
- the nested element definition.public java.lang.Object createNestedElement(java.lang.String elementName)
elementName
- the name of the nested element.@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)
attributes
- collection of attributeselements
- a list of nested element values.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, ScriptDefBase instance)
attributes
- collection of attributeselements
- a list of nested element values.instance
- the script instance; can be nullpublic void setManager(java.lang.String manager)
manager
- the scripting manager.public void setLanguage(java.lang.String language)
language
- the scripting language name for the script.public void setCompiled(boolean compiled)
compiled
- enables the script compilation if available.public void setSrc(java.io.File file)
file
- the file containing the script source.public void setEncoding(java.lang.String encoding)
encoding
- the encoding of the file containing the script source.public void addText(java.lang.String text)
text
- a component of the script text to be added.public void add(ResourceCollection resource)
resource
- source of script