Package org.apache.tools.ant.taskdefs.optional

# Class Script

java.lang.Object
org.apache.tools.ant.ProjectComponent
org.apache.tools.ant.Task
org.apache.tools.ant.taskdefs.optional.Script

All Implemented Interfaces:
  `Cloneable`

public class Script extends Task
Executes a script.

- ## 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

  Constructors
  Constructor
  Description
  `Script()`

- ## Method Summary

  Modifier and Type
  Method
  Description
  `void`
  `addText​(String text)`
  Set the script text.
  `Path`
  `createClasspath()`
  Classpath to be used when searching for classes and resources.
  `void`
  `execute()`
  Run the script using the helper object.
  `void`
  `setClasspath​(Path classpath)`
  Set the classpath to be used when searching for classes and resources.
  `void`
  `setClasspathRef​(Reference r)`
  Set the classpath by reference.
  `void`
  `setEncoding​(String encoding)`
  Set the encoding of the script from an external file; optional.
  `void`
  `setLanguage​(String language)`
  Defines the language (required).
  `void`
  `setManager​(String manager)`
  Defines the manager.
  `void`
  `setProject​(Project project)`
  Set the project.
  `void`
  `setSetBeans​(boolean setBeans)`
  Set the setbeans attribute.
  `void`
  `setSrc​(String fileName)`
  Load the script from an external file; optional.

  ### Methods inherited from class org.apache.tools.ant.Task

  `bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, 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 Details

  - ### Script

    public Script()

- ## Method Details

  - ### setProject

    public void setProject​(Project project)
    Set the project.
    Overrides:
      `setProject` in class `ProjectComponent`
    Parameters:
      `project` - the project that this task belongs to.

  - ### execute

    public void execute() throws BuildException
    Run the script using the helper object.
    Overrides:
      `execute` in class `Task`
    Throws:
      `BuildException` - if something goes wrong with the build

  - ### setManager

    public void setManager​(String manager)
    Defines the manager.
    Parameters:
      `manager` - the scripting manager.

  - ### setLanguage

    public void setLanguage​(String language)
    Defines the language (required).
    Parameters:
      `language` - the scripting language name for the script.

  - ### setSrc

    public void setSrc​(String fileName)
    Load the script from an external file; optional.
    Parameters:
      `fileName` - the name of the file containing the script source.

  - ### addText

    public void addText​(String text)
    Set the script text.
    Parameters:
      `text` - a component of the script text to be added.

  - ### setClasspath

    public void setClasspath​(Path classpath)
    Set the classpath to be used when searching for classes and resources.
    Parameters:
      `classpath` - an Ant Path object containing the search path.

  - ### createClasspath

    public Path createClasspath()
    Classpath to be used when searching for classes and resources.
    Returns:
      an empty Path instance to be configured by Ant.

  - ### setClasspathRef

    public void setClasspathRef​(Reference r)
    Set the classpath by reference.
    Parameters:
      `r` - a Reference to a Path instance to be used as the classpath value.

  - ### setSetBeans

    public 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.

  - ### setEncoding

    public void setEncoding​(String encoding)
    Set 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