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

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

• javac

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.

Authors:

James Strachan

Hein Meling

Russel Winder

Danno Ferrin

Paul King

compileList

protected java.io.File[] compileList

configuration

protected CompilerConfiguration configuration

failOnError

protected boolean failOnError

listFiles

protected boolean listFiles

addConfiguredJavac

public void addConfiguredJavac(org.apache.tools.ant.taskdefs.Javac javac)

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

addToCompileList

protected void addToCompileList(java.io.File[] newFiles)

buildClassLoaderFor

protected GroovyClassLoader buildClassLoaderFor()

checkParameters

protected void checkParameters()

compile

protected void compile()

createClasspath

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

Adds a path to the classpath.

Returns:

a class path to be configured

createSourcepath

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

Adds a path to sourcepath.

Returns:

a sourcepath to be configured

createSrc

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

Adds a path for source compilation.

Returns:

a nested src element.

execute

public void execute()

Executes the task.

throws:

BuildException if an error occurs

getClasspath

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

Gets the classpath to be used for this compilation.

Returns:

the class path

getDestdir

public java.io.File getDestdir()

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

Returns:

the destination directory

getEncoding

public java.lang.String getEncoding()

Returns the encoding to be used when creating files.

Returns:

the file encoding to use

getExecutable

public java.lang.String getExecutable()

The value of the executable attribute, if any.

Returns:

the name of the java executable

Since:

Groovy 1.8.7

getFailonerror

public boolean getFailonerror()

Gets the failonerror flag.

Returns:

the failonerror flag

getFileList

public java.io.File[] getFileList()

Gets the list of files to be compiled.

Returns:

the list of files as an array

getForceLookupUnnamedFiles

public boolean getForceLookupUnnamedFiles()

Gets the forceLookupUnnamedFiles flag.

Returns:

the forceLookupUnnamedFiles flag

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

getIncludejavaruntime

public boolean getIncludejavaruntime()

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

Returns:

the includejavaruntime attribute

getIndy

public boolean getIndy()

Get the value of the indy flag.

Returns:

if to use indy

getKeepStubs

public boolean getKeepStubs()

Gets the keepStubs flag.

Returns:

the keepStubs flag

getListfiles

public boolean getListfiles()

Get the listfiles flag.

Returns:

the listfiles flag

getMemoryInitialSize

public java.lang.String getMemoryInitialSize()

Gets the memoryInitialSize flag.

Returns:

the memoryInitialSize flag

getMemoryMaximumSize

public java.lang.String getMemoryMaximumSize()

Gets the memoryMaximumSize flag.

Returns:

the memoryMaximumSize flag

getScriptBaseClass

public java.lang.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)

getScriptExtension

public java.lang.String getScriptExtension()

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

Returns:

the extension of Groovy source files

getSourcepath

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

Gets the sourcepath to be used for this compilation.

Returns:

the source path

getSrcdir

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

Gets the source dirs to find the source java files.

Returns:

the source directories as a path

getStubdir

public java.io.File getStubdir()

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

Returns:

the stub directory

getTargetBytecode

public java.lang.String getTargetBytecode()

Retrieves the compiler bytecode compatibility mode.

Returns:

bytecode compatibility mode. Can be either 1.5 or 1.4.

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.

getVerbose

public boolean getVerbose()

Gets the verbose flag.

Returns:

the verbose flag

isIncludeDestClasses

public boolean isIncludeDestClasses()

Get the value of the includeDestClasses property.

Returns:

the value.

makeCompileUnit

protected CompilationUnit makeCompileUnit()

recreateSrc

protected org.apache.tools.ant.types.Path recreateSrc()

Recreate src.

Returns:

a nested src element.

resetFileLists

protected void resetFileLists()

Clear the list of files to be compiled and copied.

scanDir

protected void scanDir(java.io.File srcDir, java.io.File destDir, java.lang.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

setClasspath

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

Set the classpath to be used for this compilation.

Parameters:

classpath - an Ant Path object containing the compilation classpath.

setClasspathRef

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

Adds a reference to a classpath defined elsewhere.

Parameters:

r - a reference to a classpath

setDestdir

public void setDestdir(java.io.File destDir)

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

Parameters:

destDir - the destination director

setEncoding

public void setEncoding(java.lang.String encoding)

Sets the file encoding for generated files.

Parameters:

encoding - the file encoding to be used

setErrorProperty

public void setErrorProperty(java.lang.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.

setExecutable

public void setExecutable(java.lang.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

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

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

setFork

public void setFork(boolean f)

If true forks the Groovy compiler. Default is false.

Parameters:

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

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.

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

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

setIndy

public void setIndy(boolean useIndy)

Set the indy flag.

Parameters:

useIndy - the indy flag

setJavaHome

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

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

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

setMemoryInitialSize

public void setMemoryInitialSize(java.lang.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

setMemoryMaximumSize

public void setMemoryMaximumSize(java.lang.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

setProceed

public void setProceed(boolean proceed)

Parameters:

proceed - inverse of failonerror

setScriptBaseClass

public void setScriptBaseClass(java.lang.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)

setScriptExtension

public void setScriptExtension(java.lang.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

setSourcepath

public void setSourcepath(org.apache.tools.ant.types.Path sourcepath)

Set the sourcepath to be used for this compilation.

Parameters:

sourcepath - the source path

setSourcepathRef

public void setSourcepathRef(org.apache.tools.ant.types.Reference r)

Adds a reference to a source path defined elsewhere.

Parameters:

r - a reference to a source path

setSrcdir

public void setSrcdir(org.apache.tools.ant.types.Path srcDir)

Set the source directories to find the source Java files.

Parameters:

srcDir - the source directories as a path

setStacktrace

public void setStacktrace(boolean stacktrace)

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

setStubdir

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

setTargetBytecode

public void setTargetBytecode(java.lang.String version)

Sets the bytecode compatibility mode

Parameters:

version - the bytecode compatibility mode

setUpdatedProperty

public void setUpdatedProperty(java.lang.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.

setVerbose

public void setVerbose(boolean verbose)

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

Groovy Documentation