currentJVMVersion

public static final String currentJVMVersion

CompilerConfiguration

public CompilerConfiguration()

Sets the Flags to defaults.

CompilerConfiguration

public CompilerConfiguration(CompilerConfiguration configuration)

Copy constructor. Use this if you have a mostly correct configuration for your compilation but you want to make a some changes programmatically. An important reason to prefer this approach is that your code will most likely be forward compatible with future changes to this configuration API.
An example of this copy constructor at work:

    // In all likelihood there is already a configuration in your code's context
    // for you to copy, but for the sake of this example we'll use the global default.
    CompilerConfiguration myConfiguration = new CompilerConfiguration(CompilerConfiguration.DEFAULT);
    myConfiguration.setDebug(true);

Parameters:

configuration - The configuration to copy.

CompilerConfiguration

public CompilerConfiguration(Properties configuration)

Sets the Flags to the specified configuration, with defaults for those not supplied. Note that those "defaults" here do not include checking the settings in System.getProperties in general, only file.encoding, groovy.target.directory and groovy.source.encoding are.
If you want to set a few flags but keep Groovy's default configuration behavior then be sure to make your settings in a Properties that is backed by System.getProperties() (which is done using this constructor).
That might be done like this:

    Properties myProperties = new Properties(System.getProperties());
    myProperties.setProperty("groovy.output.debug", "true");
    myConfiguration = new CompilerConfiguration(myProperties);
 

And you also have to contend with a possible SecurityException when getting the system properties (See System.getProperties).
An safer method would be to copy a default CompilerConfiguration and make your changes there using the setter.

    // In all likelihood there is already a configuration for you to copy,
    // but for the sake of this example we'll use the global default.
    CompilerConfiguration myConfiguration = new CompilerConfiguration(CompilerConfiguration.DEFAULT);
    myConfiguration.setDebug(true);
 

Another reason to use the copy constructor rather than this one is that you must call setOutput. Calling setOutput(null) is valid and will set up a PrintWriter to a bit bucket. The copy constructor will of course set the same one as the original.

Property Key	Get/Set Property Name
"groovy.warnings"	getWarningLevel
"groovy.source.encoding"	getSourceEncoding
"groovy.target.directory"	getTargetDirectory
"groovy.target.bytecode"	getTargetBytecode
"groovy.classpath"	getClasspath
"groovy.output.verbose"	getVerbose
"groovy.output.debug"	getDebug
"groovy.errors.tolerance"	getTolerance
"groovy.script.extension"	getDefaultScriptExtension
"groovy.script.base"	getScriptBaseClass
"groovy.recompile"	getRecompileGroovySource
"groovy.recompile.minimumInterval"	getMinimumRecompilationInterval

Parameters:

configuration - The properties to get flag values from.

configure

public void configure(Properties configuration)

Method to configure a this CompilerConfiguration by using Properties. For a list of available properties look at {link CompilerConfiguration(Properties).

Parameters:

configuration - The properties to get flag values from.

getClasspath

public List getClasspath()

Returns:

the classpath

getDebug

public boolean getDebug()

Returns true if debugging operation has been requested.

getDefaultScriptExtension

public String getDefaultScriptExtension()

getJointCompilationOptions

public Map getJointCompilationOptions()

Gets the joint compilation options for this configuration.

Returns:

the options

getMinimumRecompilationInterval

public int getMinimumRecompilationInterval()

getOutput

public PrintWriter getOutput()

Gets the currently configured output writer.

getPluginFactory

public ParserPluginFactory getPluginFactory()

getRecompileGroovySource

public boolean getRecompileGroovySource()

getScriptBaseClass

public String getScriptBaseClass()

Gets the name of the base class for scripts. It must be a subclass of Script.

getScriptExtensions

public Set getScriptExtensions()

getSourceEncoding

public String getSourceEncoding()

Gets the currently configured source file encoding.

getTargetBytecode

public String getTargetBytecode()

Retrieves the compiler bytecode compatibility mode.

Returns:

bytecode compatibility mode. Can be either 1.5 or 1.4.

getTargetDirectory

public File getTargetDirectory()

Gets the target directory for writing classes.

getTolerance

public int getTolerance()

Returns the requested error tolerance.

getVerbose

public boolean getVerbose()

Returns true if verbose operation has been requested.

getWarningLevel

public int getWarningLevel()

Gets the currently configured warning level. See WarningMessage for level details.

setClasspath

public void setClasspath(String classpath)

Sets the classpath.

setClasspathList

public void setClasspathList(List l)

sets the classpath using a list of Strings

Parameters:

l - list of strings containg the classpathparts

setDebug

public void setDebug(boolean debug)

Turns debugging operation on or off.

setDefaultScriptExtension

public void setDefaultScriptExtension(String defaultScriptExtension)

setJointCompilationOptions

public void setJointCompilationOptions(Map options)

Sets the joint compilation options for this configuration. Using null will disable joint compilation.

Parameters:

options - the options

setMinimumRecompilationInterval

public void setMinimumRecompilationInterval(int time)

setOutput

public void setOutput(PrintWriter output)

Sets the output writer.

setPluginFactory

public void setPluginFactory(ParserPluginFactory pluginFactory)

setRecompileGroovySource

public void setRecompileGroovySource(boolean recompile)

setScriptBaseClass

public void setScriptBaseClass(String scriptBaseClass)

Sets the name of the base class for scripts. It must be a subclass of Script.

setScriptExtensions

public void setScriptExtensions(Set scriptExtensions)

setSourceEncoding

public void setSourceEncoding(String encoding)

Sets the encoding to be used when reading source files.

setTargetBytecode

public void setTargetBytecode(String version)

Allow setting the bytecode compatibility. The parameter can take one of the values 1.5 or 1.4. If wrong parameter then the value will default to VM determined version.

Parameters:

version - the bytecode compatibility mode

setTargetDirectory

public void setTargetDirectory(String directory)

Sets the target directory.

setTargetDirectory

public void setTargetDirectory(File directory)

Sets the target directory.

setTolerance

public void setTolerance(int tolerance)

Sets the error tolerance, which is the number of non-fatal errors (per unit) that should be tolerated before compilation is aborted.

setVerbose

public void setVerbose(boolean verbose)

Turns verbose operation on or off.

setWarningLevel

public void setWarningLevel(int level)

Sets the warning level. See WarningMessage for level details.

Copyright © 2003-2010 The Codehaus. All rights reserved.