org.codehaus.groovy.ant

Class Groovyc

java.lang.Object

org.apache.tools.ant.ProjectComponent

org.apache.tools.ant.Task

org.apache.tools.ant.taskdefs.MatchingTask

org.codehaus.groovy.ant.Groovyc

All Implemented Interfaces:

Cloneable, SelectorContainer

public class Groovyc
extends MatchingTask

Compiles Groovy source files. This task can take the following arguments:

• srcdir
• scriptExtension
• targetBytecode
• destdir
• sourcepath
• sourcepathRef
• classpath
• classpathRef
• listfiles
• failonerror
• proceed
• memoryInitialSize
• memoryMaximumSize
• encoding
• verbose
• includeantruntime
• includejavaruntime
• fork
• javaHome
• executable
• updatedProperty
• errorProperty
• includeDestClasses
• jointCompilationOptions
• stacktrace
• indy
• scriptBaseClass
• stubdir
• keepStubs
• forceLookupUnnamedFiles
• configscript

And these nested tasks:

• javac

Of these arguments, the srcdir and destdir are required.

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.

Based heavily on the Javac implementation in Ant.

Author:

James Strachan, Hein Meling, Russel Winder, Danno Ferrin, Paul King

Field Summary

Fields

Modifier and Type	Field and Description
protected File[]	compileList
protected CompilerConfiguration	configuration
protected boolean	failOnError
protected boolean	listFiles

Fields inherited from class org.apache.tools.ant.taskdefs.MatchingTask

fileset

Fields inherited from class org.apache.tools.ant.Task

target, taskName, taskType, wrapper

Fields inherited from class org.apache.tools.ant.ProjectComponent

description, location, project

Constructor Summary

Constructors

Constructor and Description
Groovyc()

Method Summary

Methods

Modifier and Type	Method 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	setIncludeantruntime(boolean include) If true, includes Ant's own classpath in the classpath.
void	setIncludeDestClasses(boolean includeDestClasses) This property controls whether to include the destination classes directory in the classpath given to the compiler.
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)
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.

Methods inherited from class org.apache.tools.ant.taskdefs.MatchingTask

add, addAnd, addContains, addContainsRegexp, addCustom, addDate, addDepend, addDepth, addDifferent, addFilename, addMajority, addModified, addNone, addNot, addOr, addPresent, addSelector, addSize, addType, appendSelector, createExclude, createExcludesFile, createInclude, createIncludesFile, createPatternSet, getDirectoryScanner, getImplicitFileSet, getSelectors, hasSelectors, selectorCount, selectorElements, setCaseSensitive, setDefaultexcludes, setExcludes, setExcludesfile, setFollowSymlinks, setIncludes, setIncludesfile, setProject, XsetIgnore, XsetItems

Methods inherited from class org.apache.tools.ant.Task

bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

Methods inherited from class org.apache.tools.ant.ProjectComponent

clone, getDescription, getLocation, getProject, setDescription, setLocation

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

failOnError

protected boolean failOnError

listFiles

protected boolean listFiles

compileList

protected File[] compileList

configuration

protected CompilerConfiguration configuration

Constructor Detail

Groovyc

public Groovyc()

Method Detail

createSrc

public Path createSrc()

Adds a path for source compilation.

Returns:

a nested src element.

recreateSrc

protected Path recreateSrc()

Recreate src.

Returns:

a nested src element.

setSrcdir

public void setSrcdir(Path srcDir)

Set the source directories to find the source Java files.

Parameters:

srcDir - the source directories as a path

getSrcdir

public Path getSrcdir()

Gets the source dirs to find the source java files.

Returns:

the source directories as a path

setScriptExtension

public void setScriptExtension(String scriptExtension)

Set the extension to use when searching for Groovy source files. Accepts extensions in the form *.groovy, .groovy or groovy

Parameters:

scriptExtension - the extension of Groovy source files

getScriptExtension

public String getScriptExtension()

Get the extension to use when searching for Groovy source files.

Returns:

the extension of Groovy source files

setTargetBytecode

public void setTargetBytecode(String version)

Sets the bytecode compatibility mode

Parameters:

version - the bytecode compatibility mode

getTargetBytecode

public String getTargetBytecode()

Retrieves the compiler bytecode compatibility mode.

Returns:

bytecode compatibility mode. Can be either 1.5 or 1.4.

setDestdir

public void setDestdir(File destDir)

Set the destination directory into which the Java source files should be compiled.

Parameters:

destDir - the destination director

getDestdir

public File getDestdir()

Gets the destination directory into which the java source files should be compiled.

Returns:

the destination directory

setSourcepath

public void setSourcepath(Path sourcepath)

Set the sourcepath to be used for this compilation.

Parameters:

sourcepath - the source path

getSourcepath

public Path getSourcepath()

Gets the sourcepath to be used for this compilation.

Returns:

the source path

createSourcepath

public Path createSourcepath()

Adds a path to sourcepath.

Returns:

a sourcepath to be configured

setSourcepathRef

public void setSourcepathRef(Reference r)

Adds a reference to a source path defined elsewhere.

Parameters:

r - a reference to a source path

setClasspath

public void setClasspath(Path classpath)

Set the classpath to be used for this compilation.

Parameters:

classpath - an Ant Path object containing the compilation classpath.

getClasspath

public Path getClasspath()

Gets the classpath to be used for this compilation.

Returns:

the class path

createClasspath

public Path createClasspath()

Adds a path to the classpath.

Returns:

a class path to be configured

setClasspathRef

public void setClasspathRef(Reference r)

Adds a reference to a classpath defined elsewhere.

Parameters:

r - a reference to a classpath

setListfiles

public void setListfiles(boolean list)

If true, list the source files being handed off to the compiler. Default is false.

Parameters:

list - if true list the source files

getListfiles

public boolean getListfiles()

Get the listfiles flag.

Returns:

the listfiles flag

setFailonerror

public void setFailonerror(boolean fail)

Indicates whether the build will continue even if there are compilation errors; defaults to true.

Parameters:

fail - if true halt the build on failure

setProceed

public void setProceed(boolean proceed)

Parameters:

proceed - inverse of failonerror

getFailonerror

public boolean getFailonerror()

Gets the failonerror flag.

Returns:

the failonerror flag

setMemoryInitialSize

public void setMemoryInitialSize(String memoryInitialSize)

The 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)

Parameters:

memoryInitialSize - string to pass to VM

getMemoryInitialSize

public String getMemoryInitialSize()

Gets the memoryInitialSize flag.

Returns:

the memoryInitialSize flag

setMemoryMaximumSize

public void setMemoryMaximumSize(String memoryMaximumSize)

The 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)

Parameters:

memoryMaximumSize - string to pass to VM

getMemoryMaximumSize

public String getMemoryMaximumSize()

Gets the memoryMaximumSize flag.

Returns:

the memoryMaximumSize flag

setEncoding

public void setEncoding(String encoding)

Sets the file encoding for generated files.

Parameters:

encoding - the file encoding to be used

getEncoding

public String getEncoding()

Returns the encoding to be used when creating files.

Returns:

the file encoding to use

setVerbose

public void setVerbose(boolean verbose)

Enable verbose compiling which will display which files are being compiled. Default is false.

getVerbose

public boolean getVerbose()

Gets the verbose flag.

Returns:

the verbose flag

setIncludeantruntime

public void setIncludeantruntime(boolean include)

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.

Parameters:

include - if true, includes Ant's own classpath in the classpath

getIncludeantruntime

public boolean getIncludeantruntime()

Gets whether or not the ant classpath is to be included in the classpath.

Returns:

whether or not the ant classpath is to be included in the classpath

setIncludejavaruntime

public void setIncludejavaruntime(boolean include)

If true, includes the Java runtime libraries in the classpath. Default is false.

Parameters:

include - if true, includes the Java runtime libraries in the classpath

getIncludejavaruntime

public boolean getIncludejavaruntime()

Gets whether or not the java runtime should be included in this task's classpath.

Returns:

the includejavaruntime attribute

setFork

public void setFork(boolean f)

If true forks the Groovy compiler. Default is false.

Parameters:

f - "true|false|on|off|yes|no"

setJavaHome

public void setJavaHome(File home)

The JDK Home to use when forked. Ignored if "executable" is specified.

Parameters:

home - the java.home value to use, default is the current JDK's home

setExecutable

public void setExecutable(String forkExecPath)

Sets the name of the java executable to use when invoking the compiler in forked mode, ignored otherwise.

Parameters:

forkExecPath - the name of the executable

Since:

Groovy 1.8.7

getExecutable

public String getExecutable()

The value of the executable attribute, if any.

Returns:

the name of the java executable

Since:

Groovy 1.8.7

setUpdatedProperty

public void setUpdatedProperty(String updatedProperty)

The property to set on compilation success. This property will not be set if the compilation fails, or if there are no files to compile.

Parameters:

updatedProperty - the property name to use.

setErrorProperty

public void setErrorProperty(String errorProperty)

The property to set on compilation failure. This property will be set if the compilation fails.

Parameters:

errorProperty - the property name to use.

setIncludeDestClasses

public void setIncludeDestClasses(boolean includeDestClasses)

This property controls whether to include the destination classes directory in the classpath given to the compiler. The default value is "true".

Parameters:

includeDestClasses - the value to use.

isIncludeDestClasses

public boolean isIncludeDestClasses()

Get the value of the includeDestClasses property.

Returns:

the value.

getTaskSuccess

public boolean getTaskSuccess()

Get the result of the groovyc task (success or failure).

Returns:

true if compilation succeeded, or was not necessary, false if the compilation failed.

addConfiguredJavac

public void addConfiguredJavac(Javac javac)

Add the configured nested javac task if present to initiate joint compilation.

setStacktrace

public void setStacktrace(boolean stacktrace)

Enable compiler to report stack trace information if a problem occurs during compilation. Default is false.

setIndy

public void setIndy(boolean useIndy)

Set the indy flag.

Parameters:

useIndy - the indy flag

getIndy

public boolean getIndy()

Get the value of the indy flag.

Returns:

if to use indy

setScriptBaseClass

public void setScriptBaseClass(String scriptBaseClass)

Set the base script class name for the scripts (must derive from Script)

Parameters:

scriptBaseClass - Base class name for scripts (must derive from Script)

getScriptBaseClass

public String getScriptBaseClass()

Get the base script class name for the scripts (must derive from Script)

Returns:

Base class name for scripts (must derive from Script)

getConfigscript

public String getConfigscript()

Get the configuration file used to customize the compilation configuration.

Returns:

a path to a configuration script

setConfigscript

public void setConfigscript(String configscript)

Set the configuration file used to customize the compilation configuration.

Parameters:

configscript - a path to a configuration script

setStubdir

public void setStubdir(File stubDir)

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.

Parameters:

stubDir - the stub directory

getStubdir

public File getStubdir()

Gets the stub directory into which the Java source stub files should be generated

Returns:

the stub directory

setKeepStubs

public void setKeepStubs(boolean keepStubs)

Set the keepStubs flag. Defaults to false. Set to true for debugging. Ignored when forked.

Parameters:

keepStubs - should stubs be retained

getKeepStubs

public boolean getKeepStubs()

Gets the keepStubs flag.

Returns:

the keepStubs flag

setForceLookupUnnamedFiles

public void setForceLookupUnnamedFiles(boolean forceLookupUnnamedFiles)

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.

Parameters:

forceLookupUnnamedFiles - should unnamed source files be searched for on the classpath

getForceLookupUnnamedFiles

public boolean getForceLookupUnnamedFiles()

Gets the forceLookupUnnamedFiles flag.

Returns:

the forceLookupUnnamedFiles flag

execute

public void execute()
             throws BuildException

Executes the task.

Overrides:

execute in class Task

Throws:

BuildException - if an error occurs

resetFileLists

protected void resetFileLists()

Clear the list of files to be compiled and copied.

scanDir

protected void scanDir(File srcDir,
           File destDir,
           String[] files)

Scans the directory looking for source files to be compiled. The results are returned in the class variable compileList

Parameters:

srcDir - The source directory

destDir - The destination directory

files - An array of filenames

addToCompileList

protected void addToCompileList(File[] newFiles)

getFileList

public File[] getFileList()

Gets the list of files to be compiled.

Returns:

the list of files as an array

checkParameters

protected void checkParameters()
                        throws BuildException

Throws:

BuildException

compile

protected void compile()

makeCompileUnit

protected CompilationUnit makeCompileUnit()

buildClassLoaderFor

protected GroovyClassLoader buildClassLoaderFor()