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:
java.lang.Cloneable
public class Groovy extends org.apache.tools.ant.taskdefs.JavaExecutes 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 Summary
Constructors Constructor Description Groovy()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description protected voidaddClassPathes(GroovyClassLoader classLoader)Adds the class paths (if any)voidaddFileset(org.apache.tools.ant.types.FileSet set)Adds a set of files (nested fileset attribute).voidaddText(java.lang.String txt)Set an inline command to execute.org.apache.tools.ant.types.Commandline.ArgumentcreateArg()org.apache.tools.ant.types.PathcreateClasspath()Returns a new path element that can be configured.protected voidexecGroovy(java.lang.String txt, java.io.PrintStream out)Exec the statement.voidexecute()Load the file and then execute itorg.apache.tools.ant.types.PathgetClasspath()Gets the classpath.booleangetParameters()Returns true if parameter metadata generation has been enabled.static voidmain(java.lang.String[] args)protected voidprintResults(java.io.PrintStream out)print any results in the statement.protected voidrunStatements(java.io.Reader reader, java.io.PrintStream out)Read in lines and execute them.voidsetAppend(boolean append)Whether output should be appended to or overwrite an existing file.voidsetClasspath(org.apache.tools.ant.types.Path classpath)Sets the classpath for loading.voidsetClasspathRef(org.apache.tools.ant.types.Reference ref)Set the classpath for loading using the classpath reference.voidsetConfigscript(java.lang.String configscript)Sets the configuration script for the groovy compiler configuration.voidsetContextClassLoader(boolean contextClassLoader)Setting to true will cause the contextClassLoader to be set with the classLoader of the shell used to run the script.voidsetFork(boolean fork)Should the script be executed using a forked process.voidsetIncludeAntRuntime(boolean includeAntRuntime)Should the system classpath be included on the classpath when forking.voidsetIndy(boolean indy)Sets the indy flag to enable or disable invokedynamicvoidsetOutput(java.io.File output)Set the output file; optional, defaults to the Ant log.voidsetParameters(boolean parameters)If true, generates metadata for reflection on method parameter names (jdk8+ only).voidsetScriptBaseClass(java.lang.String scriptBaseClass)Set the script base class namevoidsetSrc(java.io.File srcFile)Set the name of the file to be run.voidsetStacktrace(boolean stacktrace)Enable compiler to report stack trace information if a problem occurs during compilation.voidsetUseGroovyShell(boolean useGroovyShell)Should a new GroovyShell be used when forking.-
Methods inherited from class org.apache.tools.ant.taskdefs.Java
addAssertions, addConfiguredRedirector, addEnv, addSysproperty, addSyspropertyset, checkConfiguration, clearArgs, createBootclasspath, createJvmarg, createModulepath, createPermissions, createUpgrademodulepath, createWatchdog, executeJava, executeJava, getCommandLine, getSysProperties, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, maybeSetResultPropertyValue, run, setArgs, setClassname, setCloneVm, setDir, setError, setErrorProperty, setFailonerror, setInput, setInputString, setJar, setJvm, setJvmargs, setJVMVersion, setLogError, setMaxmemory, setModule, setModulepath, setModulepathRef, setNewenvironment, setOutputproperty, setResultProperty, setSpawn, setTimeout, setupRedirector
-
Methods inherited from class org.apache.tools.ant.Task
bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
-
-
-
-
Method Detail
-
setFork
public void setFork(boolean fork)
Should the script be executed using a forked process. Defaults to false.- Overrides:
setForkin classorg.apache.tools.ant.taskdefs.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(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
-
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 commands to execute
-
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
-
setOutput
public void setOutput(java.io.File output)
Set the output file; optional, defaults to the Ant log.- Overrides:
setOutputin classorg.apache.tools.ant.taskdefs.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:
setAppendin classorg.apache.tools.ant.taskdefs.Java- Parameters:
append- set to true to append
-
setClasspath
public void setClasspath(org.apache.tools.ant.types.Path classpath)
Sets the classpath for loading.- Overrides:
setClasspathin classorg.apache.tools.ant.taskdefs.Java- Parameters:
classpath- The classpath to set
-
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.- Overrides:
createClasspathin classorg.apache.tools.ant.taskdefs.Java- Returns:
- the resulting created path
-
setClasspathRef
public void setClasspathRef(org.apache.tools.ant.types.Reference ref)
Set the classpath for loading using the classpath reference.- Overrides:
setClasspathRefin classorg.apache.tools.ant.taskdefs.Java- Parameters:
ref- the refid to use
-
getClasspath
public org.apache.tools.ant.types.Path getClasspath()
Gets the classpath.- Returns:
- Returns a Path
-
setConfigscript
public void setConfigscript(java.lang.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(java.lang.String scriptBaseClass)
Set the script base class name- Parameters:
scriptBaseClass- the name of the base class for scripts
-
setParameters
public void setParameters(boolean parameters)
If true, generates metadata for reflection on method parameter names (jdk8+ only). Defaults to false.- Parameters:
parameters- set to true to generate metadata.
-
getParameters
public boolean getParameters()
Returns true if parameter metadata generation has been enabled.
-
execute
public void execute() throws org.apache.tools.ant.BuildExceptionLoad the file and then execute it- Overrides:
executein classorg.apache.tools.ant.taskdefs.Java- Throws:
org.apache.tools.ant.BuildException
-
createArg
public org.apache.tools.ant.types.Commandline.Argument createArg()
- Overrides:
createArgin classorg.apache.tools.ant.taskdefs.Java
-
runStatements
protected void runStatements(java.io.Reader reader, java.io.PrintStream out) throws java.io.IOExceptionRead in lines and execute them.- Parameters:
reader- the reader from which to get the groovy source to execout- the outputstream to use- Throws:
java.io.IOException- if something goes wrong
-
execGroovy
protected void execGroovy(java.lang.String txt, java.io.PrintStream out)Exec the statement.- Parameters:
txt- the groovy source to execout- not used?
-
main
public static void main(java.lang.String[] args)
-
addClassPathes
protected void addClassPathes(GroovyClassLoader classLoader)
Adds the class paths (if any)- Parameters:
classLoader- the classloader to configure
-
printResults
protected void printResults(java.io.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
-
-