currentJVMVersion

public static final String currentJVMVersion

CompilerConfiguration

public CompilerConfiguration()

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 programatically. 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.

addCompilationCustomizers

public CompilerConfiguration addCompilationCustomizers(CompilationCustomizer... customizers)

configure

public void configure(Properties configuration)

getClasspath

public List getClasspath()

Returns true if debugging operation has been requested.

getCompilationCustomizers

public List getCompilationCustomizers()

getDebug

public boolean getDebug()

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

getDefaultScriptExtension

public String getDefaultScriptExtension()

getJointCompilationOptions

public Map getJointCompilationOptions()

Adds compilation customizers to the compilation process. A compilation customizer is a class node operation which performs various operations going from adding imports to access control.

Parameters:

customizers - the list of customizers to be added

Returns:

this configuration instance

getMinimumRecompilationInterval

public int getMinimumRecompilationInterval()

Gets the joint compilation options for this configuration.

Returns:

the options

getOptimizationOptions

public Map getOptimizationOptions()

getOutput

public PrintWriter getOutput()

Sets the target directory.

getPluginFactory

public ParserPluginFactory getPluginFactory()

getRecompileGroovySource

public boolean getRecompileGroovySource()

getScriptBaseClass

public String getScriptBaseClass()

getScriptExtensions

public Set getScriptExtensions()

getSourceEncoding

public String getSourceEncoding()

Gets the target directory for writing classes.

getTargetBytecode

public String getTargetBytecode()

Gets the optimization options for this configuration.

Returns:

the options (always not null)

getTargetDirectory

public File getTargetDirectory()

Sets the classpath.

getTolerance

public int getTolerance()

getVerbose

public boolean getVerbose()

getWarningLevel

public int getWarningLevel()

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

setClasspath

public void setClasspath(String classpath)

Turns debugging operation on or off.

setClasspathList

public void setClasspathList(List parts)

Returns the requested error tolerance.

setDebug

public void setDebug(boolean debug)

setDefaultScriptExtension

public void setDefaultScriptExtension(String defaultScriptExtension)

setJointCompilationOptions

public void setJointCompilationOptions(Map options)

Returns the list of compilation customizers.

Returns:

the customizers (always not null)

setMinimumRecompilationInterval

public void setMinimumRecompilationInterval(int time)

setOptimizationOptions

public void setOptimizationOptions(Map options)

setOutput

public void setOutput(PrintWriter output)

Returns:

the classpath

setPluginFactory

public void setPluginFactory(ParserPluginFactory pluginFactory)

setRecompileGroovySource

public void setRecompileGroovySource(boolean recompile)

setScriptBaseClass

public void setScriptBaseClass(String scriptBaseClass)

setScriptExtensions

public void setScriptExtensions(Set scriptExtensions)

setSourceEncoding

public void setSourceEncoding(String encoding)

setTargetBytecode

public void setTargetBytecode(String version)

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

Parameters:

options - the options

setTargetDirectory

public void setTargetDirectory(String directory)

sets the classpath using a list of Strings

Parameters:

parts - list of strings containing the classpath parts

setTargetDirectory

public void setTargetDirectory(File directory)

Returns true if verbose operation has been requested.

setTolerance

public void setTolerance(int tolerance)

setVerbose

public void setVerbose(boolean verbose)

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

setWarningLevel

public void setWarningLevel(int level)

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