Compiles Groovy source files using Ant.
Typically involves using Ant from the command-line and an Ant build file such as:
<?xml version="1.0"?> <project name="MyGroovyBuild" default="compile"> <property name="groovy.home" value="/Path/To/Groovy"/> <property name="groovy.version" value="X.Y.Z"/> <path id="groovy.classpath"> <fileset dir="${groovy.home}/embeddable"> <include name="groovy-all-${groovy.version}.jar" /> </fileset> </path> <taskdef name="groovyc" classname="org.codehaus.groovy.ant.Groovyc" classpathref="groovy.classpath"/> <target name="compile" description="compile groovy sources"> <groovyc srcdir="src" listfiles="true" classpathref="groovy.classpath"/> </target> </project>
This task can take the following arguments:
When this task executes, it will recursively scan srcdir and destdir looking for Groovy source files to compile. This task makes its compile decision based on timestamp.
A more elaborate build file showing joint compilation:
<?xml version="1.0"?> <project name="MyJointBuild" default="compile"> <property name="groovy.home" value="/Path/To/Groovy"/> <property name="groovy.version" value="X.Y.Z"/> <path id="groovy.classpath"> <fileset dir="${groovy.home}/embeddable"> <include name="groovy-all-${groovy.version}.jar" /> </fileset> </path> <target name="clean" description="remove all built files"> <delete dir="classes" /> </target> <target name="compile" depends="init" description="compile java and groovy sources"> <mkdir dir="classes" /> <groovyc destdir="classes" srcdir="src" listfiles="true" keepStubs="true" stubdir="stubs"> <javac debug="on" deprecation="true"/> <classpath> <fileset dir="classes"/> <path refid="groovy.classpath"/> </classpath> </groovyc> </target> <target name="init"> <taskdef name="groovyc" classname="org.codehaus.groovy.ant.Groovyc" classpathref="groovy.classpath"/> </target> </project>
Based heavily on the Javac implementation in Ant.
Can also be used from AntBuilder to allow the build file to be scripted in Groovy.
Modifiers | Name | Description |
---|---|---|
protected File[] |
compileList |
|
protected CompilerConfiguration |
configuration |
|
protected boolean |
failOnError |
|
protected boolean |
listFiles |
Type Params | Return Type | Name and description |
---|---|---|
|
void |
addConfiguredJavac(Javac javac) Add the configured nested javac task if present to initiate joint compilation. |
|
protected void |
addToCompileList(File[] newFiles) |
|
protected GroovyClassLoader |
buildClassLoaderFor() |
|
protected void |
checkParameters() |
|
protected void |
compile() |
|
Path |
createClasspath() Adds a path to the classpath. |
|
Path |
createSourcepath() Adds a path to sourcepath. |
|
Path |
createSrc() Adds a path for source compilation. |
|
void |
execute() Executes the task. |
|
Path |
getClasspath() Gets the classpath to be used for this compilation. |
|
String |
getConfigscript() Get the configuration file used to customize the compilation configuration. |
|
File |
getDestdir() Gets the destination directory into which the java source files should be compiled. |
|
String |
getEncoding() Returns the encoding to be used when creating files. |
|
String |
getExecutable() The value of the executable attribute, if any. |
|
boolean |
getFailonerror() Gets the failonerror flag. |
|
File[] |
getFileList() Gets the list of files to be compiled. |
|
boolean |
getForceLookupUnnamedFiles() Gets the forceLookupUnnamedFiles flag. |
|
boolean |
getIncludeantruntime() Gets whether or not the ant classpath is to be included in the classpath. |
|
boolean |
getIncludejavaruntime() Gets whether or not the java runtime should be included in this task's classpath. |
|
boolean |
getIndy() Get the value of the indy flag. |
|
boolean |
getKeepStubs() Gets the keepStubs flag. |
|
boolean |
getListfiles() Get the listfiles flag. |
|
String |
getMemoryInitialSize() Gets the memoryInitialSize flag. |
|
String |
getMemoryMaximumSize() Gets the memoryMaximumSize flag. |
|
String |
getScriptBaseClass() Get the base script class name for the scripts (must derive from Script) |
|
String |
getScriptExtension() Get the extension to use when searching for Groovy source files. |
|
Path |
getSourcepath() Gets the sourcepath to be used for this compilation. |
|
Path |
getSrcdir() Gets the source dirs to find the source java files. |
|
File |
getStubdir() Gets the stub directory into which the Java source stub files should be generated |
|
String |
getTargetBytecode() Retrieves the compiler bytecode compatibility mode. |
|
boolean |
getTaskSuccess() Get the result of the groovyc task (success or failure). |
|
boolean |
getVerbose() Gets the verbose flag. |
|
boolean |
isIncludeDestClasses() Get the value of the includeDestClasses property. |
|
protected CompilationUnit |
makeCompileUnit() |
|
protected Path |
recreateSrc() Recreate src. |
|
protected void |
resetFileLists() Clear the list of files to be compiled and copied. |
|
protected void |
scanDir(File srcDir, File destDir, String[] files) Scans the directory looking for source files to be compiled. |
|
void |
setClasspath(Path classpath) Set the classpath to be used for this compilation. |
|
void |
setClasspathRef(Reference r) Adds a reference to a classpath defined elsewhere. |
|
void |
setConfigscript(String configscript) Set the configuration file used to customize the compilation configuration. |
|
void |
setDestdir(File destDir) Set the destination directory into which the Java source files should be compiled. |
|
void |
setEncoding(String encoding) Sets the file encoding for generated files. |
|
void |
setErrorProperty(String errorProperty) The property to set on compilation failure. |
|
void |
setExecutable(String forkExecPath) Sets the name of the java executable to use when invoking the compiler in forked mode, ignored otherwise. |
|
void |
setFailonerror(boolean fail) Indicates whether the build will continue even if there are compilation errors; defaults to true. |
|
void |
setForceLookupUnnamedFiles(boolean forceLookupUnnamedFiles) Set the forceLookupUnnamedFiles flag. |
|
void |
setFork(boolean f) If true forks the Groovy compiler. |
|
void |
setIncludeDestClasses(boolean includeDestClasses) This property controls whether to include the destination classes directory in the classpath given to the compiler. |
|
void |
setIncludeantruntime(boolean include) If true, includes Ant's own classpath in the classpath. |
|
void |
setIncludejavaruntime(boolean include) If true, includes the Java runtime libraries in the classpath. |
|
void |
setIndy(boolean useIndy) Set the indy flag. |
|
void |
setJavaHome(File home) The JDK Home to use when forked. |
|
void |
setKeepStubs(boolean keepStubs) Set the keepStubs flag. |
|
void |
setListfiles(boolean list) If true, list the source files being handed off to the compiler. |
|
void |
setMemoryInitialSize(String memoryInitialSize) The initial size of the memory for the underlying VM if javac is run externally; ignored otherwise. |
|
void |
setMemoryMaximumSize(String memoryMaximumSize) The maximum size of the memory for the underlying VM if javac is run externally; ignored otherwise. |
|
void |
setProceed(boolean proceed) @param proceed inverse of failonerror |
|
void |
setScriptBaseClass(String scriptBaseClass) Set the base script class name for the scripts (must derive from Script) |
|
void |
setScriptExtension(String scriptExtension) Set the extension to use when searching for Groovy source files. |
|
void |
setSourcepath(Path sourcepath) Set the sourcepath to be used for this compilation. |
|
void |
setSourcepathRef(Reference r) Adds a reference to a source path defined elsewhere. |
|
void |
setSrcdir(Path srcDir) Set the source directories to find the source Java files. |
|
void |
setStacktrace(boolean stacktrace) Enable compiler to report stack trace information if a problem occurs during compilation. |
|
void |
setStubdir(File stubDir) Set the stub directory into which the Java source stub files should be generated. |
|
void |
setTargetBytecode(String version) Sets the bytecode compatibility mode |
|
void |
setUpdatedProperty(String updatedProperty) The property to set on compilation success. |
|
void |
setVerbose(boolean verbose) Enable verbose compiling which will display which files are being compiled. |
Add the configured nested javac task if present to initiate joint compilation.
Adds a path to the classpath.
Adds a path to sourcepath.
Adds a path for source compilation.
Executes the task.
Gets the classpath to be used for this compilation.
Get the configuration file used to customize the compilation configuration.
Gets the destination directory into which the java source files should be compiled.
Returns the encoding to be used when creating files.
The value of the executable attribute, if any.
Gets the failonerror flag.
Gets the list of files to be compiled.
Gets the forceLookupUnnamedFiles flag.
Gets whether or not the ant classpath is to be included in the classpath.
Gets whether or not the java runtime should be included in this task's classpath.
Get the value of the indy flag.
Gets the keepStubs flag.
Get the listfiles flag.
Gets the memoryInitialSize flag.
Gets the memoryMaximumSize flag.
Get the base script class name for the scripts (must derive from Script)
Get the extension to use when searching for Groovy source files.
Gets the sourcepath to be used for this compilation.
Gets the source dirs to find the source java files.
Gets the stub directory into which the Java source stub files should be generated
Retrieves the compiler bytecode compatibility mode.
Get the result of the groovyc task (success or failure).
Gets the verbose flag.
Get the value of the includeDestClasses property.
Recreate src.
Clear the list of files to be compiled and copied.
Scans the directory looking for source files to be compiled. The results are returned in the class variable compileList
srcDir
- The source directorydestDir
- The destination directoryfiles
- An array of filenamesSet the classpath to be used for this compilation.
classpath
- an Ant Path object containing the compilation classpath.Adds a reference to a classpath defined elsewhere.
r
- a reference to a classpathSet the configuration file used to customize the compilation configuration.
configscript
- a path to a configuration scriptSet the destination directory into which the Java source files should be compiled.
destDir
- the destination directorSets the file encoding for generated files.
encoding
- the file encoding to be usedThe property to set on compilation failure. This property will be set if the compilation fails.
errorProperty
- the property name to use.Sets the name of the java executable to use when invoking the compiler in forked mode, ignored otherwise.
forkExecPath
- the name of the executableIndicates whether the build will continue even if there are compilation errors; defaults to true.
fail
- if true halt the build on failure Set the forceLookupUnnamedFiles flag. Defaults to false.
The Groovyc Ant task is frequently used in the context of a build system
that knows the complete list of source files to be compiled. In such a
context, it is wasteful for the Groovy compiler to go searching the
classpath when looking for source files and hence by default the
Groovyc Ant task calls the compiler in a special mode with such searching
turned off. If you wish the compiler to search for source files then
you need to set this flag to true
.
forceLookupUnnamedFiles
- should unnamed source files be searched for on the classpathIf true forks the Groovy compiler. Default is false.
f
- "true|false|on|off|yes|no"This property controls whether to include the destination classes directory in the classpath given to the compiler. The default value is "true".
includeDestClasses
- the value to use.If true, includes Ant's own classpath in the classpath. Default is true. If setting to false and using groovyc in conjunction with AntBuilder you might need to explicitly add the Groovy jar(s) to the groovyc classpath using a nested classpath task.
include
- if true, includes Ant's own classpath in the classpathIf true, includes the Java runtime libraries in the classpath. Default is false.
include
- if true, includes the Java runtime libraries in the classpathSet the indy flag.
useIndy
- the indy flagThe JDK Home to use when forked. Ignored if "executable" is specified.
home
- the java.home value to use, default is the current JDK's homeSet the keepStubs flag. Defaults to false. Set to true for debugging. Ignored when forked.
keepStubs
- should stubs be retainedIf true, list the source files being handed off to the compiler. Default is false.
list
- if true list the source filesThe initial size of the memory for the underlying VM if javac is run externally; ignored otherwise. Defaults to the standard VM memory setting. (Examples: 83886080, 81920k, or 80m)
memoryInitialSize
- string to pass to VMThe maximum size of the memory for the underlying VM if javac is run externally; ignored otherwise. Defaults to the standard VM memory setting. (Examples: 83886080, 81920k, or 80m)
memoryMaximumSize
- string to pass to VM
proceed
- inverse of failonerrorSet the base script class name for the scripts (must derive from Script)
scriptBaseClass
- Base class name for scripts (must derive from Script)Set the extension to use when searching for Groovy source files. Accepts extensions in the form *.groovy, .groovy or groovy
scriptExtension
- the extension of Groovy source filesSet the sourcepath to be used for this compilation.
sourcepath
- the source pathAdds a reference to a source path defined elsewhere.
r
- a reference to a source pathSet the source directories to find the source Java files.
srcDir
- the source directories as a pathEnable compiler to report stack trace information if a problem occurs during compilation. Default is false.
Set the stub directory into which the Java source stub files should be generated. The directory need not exist and will not be deleted automatically - though its contents will be cleared unless 'keepStubs' is true. Ignored when forked.
stubDir
- the stub directorySets the bytecode compatibility mode
version
- the bytecode compatibility modeThe property to set on compilation success. This property will not be set if the compilation fails, or if there are no files to compile.
updatedProperty
- the property name to use.Enable verbose compiling which will display which files are being compiled. Default is false.