|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.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
public class ScriptDef
Define a task using a script
| Nested Class Summary | |
|---|---|
static class |
ScriptDef.Attribute
Class representing an attribute definition |
static class |
ScriptDef.NestedElement
Class to represent a nested element definition |
| Field Summary |
|---|
| Fields inherited from class org.apache.tools.ant.Task |
|---|
target, taskName, taskType, wrapper |
| Fields inherited from class org.apache.tools.ant.ProjectComponent |
|---|
description, location, project |
| Constructor Summary | |
|---|---|
ScriptDef()
|
|
| Method Summary | |
|---|---|
void |
add(ResourceCollection resource)
Add any source resource. |
void |
addAttribute(ScriptDef.Attribute attribute)
Add an attribute definition to this script. |
void |
addElement(ScriptDef.NestedElement nestedElement)
Add a nested element definition. |
void |
addText(java.lang.String text)
Set the script text. |
java.lang.Object |
createNestedElement(java.lang.String elementName)
Create a nested element to be configured. |
void |
execute()
Define the script. |
void |
executeScript(java.util.Map attributes,
java.util.Map elements)
Deprecated. since 1.7. Use executeScript(attribute, elements, instance) instead. |
void |
executeScript(java.util.Map attributes,
java.util.Map elements,
ScriptDefBase instance)
Execute the script. |
boolean |
isAttributeSupported(java.lang.String attributeName)
Indicates whether the task supports a given attribute name |
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)
set 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)
Load 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, setReverseLoader |
| Methods inherited from class org.apache.tools.ant.taskdefs.AntlibDefinition |
|---|
getAntlibClassLoader, getURI, setAntlibClassLoader, setURI |
| Methods 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, setTaskType |
| Methods inherited from class org.apache.tools.ant.ProjectComponent |
|---|
clone, getDescription, getLocation, getProject, setDescription, setLocation |
| Methods inherited from class java.lang.Object |
|---|
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public ScriptDef()
| Method Detail |
|---|
public void setProject(Project project)
setProject in class ProjectComponentproject - the project that this def belows 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 void execute()
execute in class Taskpublic java.lang.Object createNestedElement(java.lang.String elementName)
elementName - the name of the nested element.
public void executeScript(java.util.Map attributes,
java.util.Map elements)
attributes - collection of attributeselements - a list of nested element values.
public void executeScript(java.util.Map attributes,
java.util.Map 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 setSrc(java.io.File file)
file - 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
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||