Package org.codehaus.groovy.ant

Class Groovy

java.lang.Object
org.apache.tools.ant.ProjectComponent
org.apache.tools.ant.Task
org.apache.tools.ant.taskdefs.Java
org.codehaus.groovy.ant.Groovy
All Implemented Interfaces:
Cloneable
public class Groovy extends Java
Executes a series of Groovy statements.

Statements can either be read in from a text file using the src attribute or from between the enclosing groovy tags.

  • Constructor Details

    • Groovy

      public Groovy()

  • Method Details

    • setFork

      public void setFork(boolean fork)
      Should the script be executed using a forked process. Defaults to false.
      Overrides:
      setFork in class Java
      Parameters:
      fork - true if the script should be executed in a forked process

    • setUseGroovyShell

      public void setUseGroovyShell(boolean useGroovyShell)
      Should a new GroovyShell be used when forking. Special variables won't be available but you don't need Ant in the classpath.
      Parameters:
      useGroovyShell - true if GroovyShell should be used to run the script directly

    • setIncludeAntRuntime

      public void setIncludeAntRuntime(boolean includeAntRuntime)
      Should the system classpath be included on the classpath when forking. Defaults to true.
      Parameters:
      includeAntRuntime - true if the system classpath should be on the classpath

    • setStacktrace

      public void setStacktrace(boolean stacktrace)
      Enable compiler to report stack trace information if a problem occurs during compilation.
      Parameters:
      stacktrace - set to true to enable stacktrace reporting

    • setSrc

      public void setSrc(File srcFile)
      Set the name of the file to be run. The folder of the file is automatically added to the classpath. Required unless statements are enclosed in the build file
      Parameters:
      srcFile - the file containing the groovy script to execute

    • addText

      public void addText(String txt)
      Set an inline command to execute. NB: Properties are not expanded in this text.
      Parameters:
      txt - the inline groovy commands to execute

    • addFileset

      public void addFileset(FileSet set)
      Adds a set of files (nested fileset attribute).
      Parameters:
      set - the fileset representing source files

    • setOutput

      public void setOutput(File output)
      Set the output file; optional, defaults to the Ant log.
      Overrides:
      setOutput in class Java
      Parameters:
      output - the output file

    • setAppend

      public void setAppend(boolean append)
      Whether output should be appended to or overwrite an existing file. Defaults to false.
      Overrides:
      setAppend in class Java
      Parameters:
      append - set to true to append

    • setClasspath

      public void setClasspath(Path classpath)
      Sets the classpath for loading.
      Overrides:
      setClasspath in class Java
      Parameters:
      classpath - The classpath to set

    • createClasspath

      public Path createClasspath()
      Returns a new path element that can be configured. Gets called for instance by Ant when it encounters a nested <classpath> element.
      Overrides:
      createClasspath in class Java
      Returns:
      the resulting created path

    • setClasspathRef

      public void setClasspathRef(Reference ref)
      Set the classpath for loading using the classpath reference.
      Overrides:
      setClasspathRef in class Java
      Parameters:
      ref - the refid to use

    • getClasspath

      public Path getClasspath()
      Gets the classpath.
      Returns:
      Returns a Path

    • setConfigscript

      public void setConfigscript(String configscript)
      Sets the configuration script for the groovy compiler configuration.
      Parameters:
      configscript - path to the configuration script

    • setIndy

      public void setIndy(boolean indy)
      Sets the indy flag to enable or disable invokedynamic
      Parameters:
      indy - true means invokedynamic support is active

    • setScriptBaseClass

      public void setScriptBaseClass(String scriptBaseClass)
      Set the script base class name
      Parameters:
      scriptBaseClass - the name of the base class for scripts

    • execute

      public void execute() throws BuildException
      Load the file and then execute it
      Overrides:
      execute in class Java
      Throws:
      BuildException

    • createArg

      public Commandline.Argument createArg()
      Overrides:
      createArg in class Java

    • runStatements

      protected void runStatements(Reader reader, PrintStream out) throws IOException
      Read in lines and execute them.
      Parameters:
      reader - the reader from which to get the groovy source to exec
      out - the outputstream to use
      Throws:
      IOException - if something goes wrong

    • execGroovy

      protected void execGroovy(String txt, PrintStream out)
      Exec the statement.
      Parameters:
      txt - the groovy source to exec
      out - not used?

    • main

      public static void main(String[] args)

    • addClassPathes

      protected void addClassPathes(GroovyClassLoader classLoader)
      Adds the class paths (if any)
      Parameters:
      classLoader - the classloader to configure

    • printResults

      protected void printResults(PrintStream out)
      print any results in the statement.
      Parameters:
      out - the output PrintStream to print to

    • setContextClassLoader

      public void setContextClassLoader(boolean contextClassLoader)
      Setting to true will cause the contextClassLoader to be set with the classLoader of the shell used to run the script. Not used if fork is true. Not allowed when running from Maven but in that case the context classLoader is set appropriately for Maven.
      Parameters:
      contextClassLoader - set to true to set the context classloader