org.codehaus.groovy.ant
[Java] 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

public class Groovy
extends org.apache.tools.ant.taskdefs.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.

Version:

\$Id\$

addClassPathes

protected void addClassPathes(GroovyClassLoader classLoader)

Adds the class paths (if any)

Parameters:

classLoader - the classloader to configure

addFileset

public void addFileset(org.apache.tools.ant.types.FileSet set)

Adds a set of files (nested fileset attribute).

Parameters:

set - the fileset representing source files

addText

public void addText(java.lang.String txt)

Set an inline command to execute. NB: Properties are not expanded in this text.

Parameters:

txt - the inline groovy ommands to execute

createArg

public org.apache.tools.ant.types.Commandline$Argument createArg()

createClasspath

public org.apache.tools.ant.types.Path createClasspath()

Returns a new path element that can be configured. Gets called for instance by Ant when it encounters a nested <classpath> element.

Returns:

the resulting created path

execGroovy

protected void execGroovy(java.lang.String txt, java.io.PrintStream out)

Exec the statement.

Parameters:

txt - the groovy source to exec

out - not used?

execute

public void execute()

Load the file and then execute it

getClasspath

public org.apache.tools.ant.types.Path getClasspath()

Gets the classpath.

Returns:

Returns a Path

main

public static void main(java.lang.String[] args)

printResults

protected void printResults(java.io.PrintStream out)

runStatements

protected void runStatements(java.io.Reader reader, java.io.PrintStream out)

setAppend

public void setAppend(boolean append)

Whether output should be appended to or overwrite an existing file. Defaults to false.

Parameters:

append - set to true to append

setClasspath

public void setClasspath(org.apache.tools.ant.types.Path classpath)

Sets the classpath for loading.

Parameters:

classpath - The classpath to set

setClasspathRef

public void setClasspathRef(org.apache.tools.ant.types.Reference ref)

Set the classpath for loading using the classpath reference.

Parameters:

ref - the refid to use

setContextClassLoader

public void setContextClassLoader(boolean contextClassLoader)

setFork

public void setFork(boolean fork)

Should the script be executed using a forked process. Defaults to false.

Parameters:

fork - true if the script should be executed in a forked process

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

setOutput

public void setOutput(java.io.File output)

Set the output file; optional, defaults to the Ant log.

Parameters:

output - the output file

setSrc

public void setSrc(java.io.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

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

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

Groovy Documentation