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.

  • 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

      @Deprecated public void setManager(String manager)
      Deprecated.
      Defines the manager.
      Parameters:
      manager - the scripting manager.

    • setManager

      public void setManager(ScriptManager manager)
      Set the script manager.
      Parameters:
      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