Overview  Package   Class  Deprecated  Index  Help 
Groovy 1.7.11
FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.codehaus.groovy.control
[Java] Class CompilerConfiguration

java.lang.Object
  org.codehaus.groovy.control.CompilerConfiguration

public class CompilerConfiguration
extends Object

Compilation control flags and coordination stuff.

Authors:
Chris Poirier
Jochen Theodorou
Jim White
Version:
\$Id\$

Field Summary
static CompilerConfiguration DEFAULT

A convenience for getting a default configuration.

static String POST_JDK5

This ("1.5") is the value for targetBytecode to compile for a JDK 1.5 or later JVM
static String PRE_JDK5

This ("1.4") is the value for targetBytecode to compile for a JDK 1.4 JVM
static String currentJVMVersion

 
Constructor Summary
CompilerConfiguration()

CompilerConfiguration(CompilerConfiguration configuration)

Copy constructor.

CompilerConfiguration(Properties configuration)

Sets the Flags to the specified configuration, with defaults for those not supplied.

 
Method Summary
void configure(Properties configuration)

List getClasspath()

Returns true if debugging operation has been requested.
boolean getDebug()

Sets the name of the base class for scripts.

String getDefaultScriptExtension()

Map getJointCompilationOptions()

int getMinimumRecompilationInterval()

Gets the joint compilation options for this configuration.
PrintWriter getOutput()

Sets the target directory.
ParserPluginFactory getPluginFactory()

boolean getRecompileGroovySource()

String getScriptBaseClass()

Set getScriptExtensions()

String getSourceEncoding()

Gets the target directory for writing classes.
String getTargetBytecode()

File getTargetDirectory()

Sets the classpath.
int getTolerance()

boolean getVerbose()

int getWarningLevel()

Gets the currently configured warning level.

void setClasspath(String classpath)

Turns debugging operation on or off.
void setClasspathList(List l)

Returns the requested error tolerance.
void setDebug(boolean debug)

void setDefaultScriptExtension(String defaultScriptExtension)

Retrieves the compiler bytecode compatibility mode.
void setJointCompilationOptions(Map options)

void setMinimumRecompilationInterval(int time)

void setOutput(PrintWriter output)

@return the classpath
void setPluginFactory(ParserPluginFactory pluginFactory)

void setRecompileGroovySource(boolean recompile)

void setScriptBaseClass(String scriptBaseClass)

void setScriptExtensions(Set scriptExtensions)

void setSourceEncoding(String encoding)

void setTargetBytecode(String version)

Sets the joint compilation options for this configuration.

void setTargetDirectory(String directory)

sets the classpath using a list of Strings
void setTargetDirectory(File directory)

Returns true if verbose operation has been requested.
void setTolerance(int tolerance)

void setVerbose(boolean verbose)

Gets the name of the base class for scripts.

void setWarningLevel(int level)

 
Methods inherited from class Object
wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll
 

Field Detail

DEFAULT

public static final CompilerConfiguration DEFAULT
A convenience for getting a default configuration. Do not modify it! See CompilerConfiguration(Properties) for an example on how to make a suitable copy to modify. But if you're really starting from a default context, then you probably just want new CompilerConfiguration().

POST_JDK5

public static final String POST_JDK5
This ("1.5") is the value for targetBytecode to compile for a JDK 1.5 or later JVM. *

PRE_JDK5

public static final String PRE_JDK5
This ("1.4") is the value for targetBytecode to compile for a JDK 1.4 JVM. *

currentJVMVersion

public static final String currentJVMVersion

 
Constructor Detail

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 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 KeyGet/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.

 
Method Detail

configure

public void configure(Properties configuration)

getClasspath

public List getClasspath()
Returns true if debugging operation has been requested.

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

getMinimumRecompilationInterval

public int getMinimumRecompilationInterval()
Gets the joint compilation options for this configuration.
Returns:
the options

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

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 l)
Returns the requested error tolerance.

setDebug

public void setDebug(boolean debug)

setDefaultScriptExtension

public void setDefaultScriptExtension(String defaultScriptExtension)
Retrieves the compiler bytecode compatibility mode.
Returns:
bytecode compatibility mode. Can be either 1.5 or 1.4.

setJointCompilationOptions

public void setJointCompilationOptions(Map options)

setMinimumRecompilationInterval

public void setMinimumRecompilationInterval(int time)

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:
l - list of strings containg the classpathparts

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-2010 The Codehaus. All rights reserved.