Package org.codehaus.groovy.control
Class CompilerConfiguration
- java.lang.Object
-
- org.codehaus.groovy.control.CompilerConfiguration
-
public class CompilerConfiguration extends java.lang.Object
Compilation control flags and coordination stuff.- Author:
- Chris Poirier, Jochen Theodorou, Jim White, Cedric Champeau
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
CURRENT_JVM_VERSION
Deprecated.static CompilerConfiguration
DEFAULT
A convenience for getting a default configuration.static java.lang.String
INVOKEDYNAMIC
This ("indy"
) is the Optimization Option value for enablinginvokedynamic
complilation.static java.lang.String
JDK4
This ("1.4"
) is the value for targetBytecode to compile for a JDK 1.4.static java.lang.String
JDK5
This ("1.5"
) is the value for targetBytecode to compile for a JDK 1.5.static java.lang.String
JDK6
This ("1.6"
) is the value for targetBytecode to compile for a JDK 1.6.static java.lang.String
JDK7
This ("1.7"
) is the value for targetBytecode to compile for a JDK 1.7.static java.lang.String
JDK8
This ("1.8"
) is the value for targetBytecode to compile for a JDK 1.8.static java.lang.String
POST_JDK5
This ("1.5"
) is the value for targetBytecode to compile for a JDK 1.5 or later JVM.static java.lang.String
PRE_JDK5
This ("1.4"
) is the value for targetBytecode to compile for a JDK 1.4 JVM.
-
Constructor Summary
Constructors Constructor Description CompilerConfiguration()
Sets the Flags to defaults.CompilerConfiguration(java.util.Properties configuration)
Sets the Flags to the specified configuration, with defaults for those not supplied.CompilerConfiguration(CompilerConfiguration configuration)
Copy constructor.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description CompilerConfiguration
addCompilationCustomizers(CompilationCustomizer... customizers)
Adds compilation customizers to the compilation process.void
configure(java.util.Properties configuration)
Method to configure a CompilerConfiguration by using Properties.BytecodeProcessor
getBytecodePostprocessor()
java.util.List<java.lang.String>
getClasspath()
java.util.List<CompilationCustomizer>
getCompilationCustomizers()
Returns the list of compilation customizers.boolean
getDebug()
Returns true if debugging operation has been requested.java.lang.String
getDefaultScriptExtension()
java.util.Set<java.lang.String>
getDisabledGlobalASTTransformations()
Returns the list of disabled global AST transformation class names.java.util.Map<java.lang.String,java.lang.Object>
getJointCompilationOptions()
Gets the joint compilation options for this configuration.int
getMinimumRecompilationInterval()
java.util.Map<java.lang.String,java.lang.Boolean>
getOptimizationOptions()
Gets the optimization options for this configuration.java.io.PrintWriter
getOutput()
Deprecated.not used anymoreParserPluginFactory
getPluginFactory()
boolean
getRecompileGroovySource()
java.lang.String
getScriptBaseClass()
Gets the name of the base class for scripts.java.util.Set<java.lang.String>
getScriptExtensions()
java.lang.String
getSourceEncoding()
Gets the currently configured source file encoding.java.lang.String
getTargetBytecode()
Retrieves the compiler bytecode compatibility mode.java.io.File
getTargetDirectory()
Gets the target directory for writing classes.int
getTolerance()
Returns the requested error tolerance.boolean
getVerbose()
Returns true if verbose operation has been requested.int
getWarningLevel()
Gets the currently configured warning level.static boolean
isPostJDK5(java.lang.String bytecodeVersion)
Checks if the specified bytecode version string represents a JDK 1.5+ compatible bytecode version.static boolean
isPostJDK7(java.lang.String bytecodeVersion)
Checks if the specified bytecode version string represents a JDK 1.7+ compatible bytecode version.void
setBytecodePostprocessor(BytecodeProcessor bytecodePostprocessor)
void
setClasspath(java.lang.String classpath)
Sets the classpath.void
setClasspathList(java.util.List<java.lang.String> parts)
sets the classpath using a list of Stringsvoid
setDebug(boolean debug)
Turns debugging operation on or off.void
setDefaultScriptExtension(java.lang.String defaultScriptExtension)
void
setDisabledGlobalASTTransformations(java.util.Set<java.lang.String> disabledGlobalASTTransformations)
Disables global AST transformations.void
setJointCompilationOptions(java.util.Map<java.lang.String,java.lang.Object> options)
Sets the joint compilation options for this configuration.void
setMinimumRecompilationInterval(int time)
void
setOptimizationOptions(java.util.Map<java.lang.String,java.lang.Boolean> options)
Sets the optimization options for this configuration.void
setOutput(java.io.PrintWriter output)
Deprecated.not used anymore, has no effectvoid
setPluginFactory(ParserPluginFactory pluginFactory)
void
setRecompileGroovySource(boolean recompile)
void
setScriptBaseClass(java.lang.String scriptBaseClass)
Sets the name of the base class for scripts.void
setScriptExtensions(java.util.Set<java.lang.String> scriptExtensions)
void
setSourceEncoding(java.lang.String encoding)
Sets the encoding to be used when reading source files.void
setTargetBytecode(java.lang.String version)
Allow setting the bytecode compatibility.void
setTargetDirectory(java.io.File directory)
Sets the target directory.void
setTargetDirectory(java.lang.String directory)
Sets the target directory.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.void
setVerbose(boolean verbose)
Turns verbose operation on or off.void
setWarningLevel(int level)
Sets the warning level.
-
-
-
Field Detail
-
INVOKEDYNAMIC
public static final java.lang.String INVOKEDYNAMIC
This ("indy"
) is the Optimization Option value for enablinginvokedynamic
complilation.- See Also:
- Constant Field Values
-
JDK4
public static final java.lang.String JDK4
This ("1.4"
) is the value for targetBytecode to compile for a JDK 1.4.- See Also:
- Constant Field Values
-
JDK5
public static final java.lang.String JDK5
This ("1.5"
) is the value for targetBytecode to compile for a JDK 1.5.- See Also:
- Constant Field Values
-
JDK6
public static final java.lang.String JDK6
This ("1.6"
) is the value for targetBytecode to compile for a JDK 1.6.- See Also:
- Constant Field Values
-
JDK7
public static final java.lang.String JDK7
This ("1.7"
) is the value for targetBytecode to compile for a JDK 1.7.- See Also:
- Constant Field Values
-
JDK8
public static final java.lang.String JDK8
This ("1.8"
) is the value for targetBytecode to compile for a JDK 1.8.- See Also:
- Constant Field Values
-
POST_JDK5
public static final java.lang.String POST_JDK5
This ("1.5"
) is the value for targetBytecode to compile for a JDK 1.5 or later JVM.- See Also:
- Constant Field Values
-
PRE_JDK5
public static final java.lang.String PRE_JDK5
This ("1.4"
) is the value for targetBytecode to compile for a JDK 1.4 JVM.- See Also:
- Constant Field Values
-
CURRENT_JVM_VERSION
@Deprecated public static final java.lang.String CURRENT_JVM_VERSION
Deprecated.
-
DEFAULT
public static final CompilerConfiguration DEFAULT
A convenience for getting a default configuration. Do not modify it! SeeCompilerConfiguration(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 wantnew CompilerConfiguration()
.
-
-
Constructor Detail
-
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 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(java.util.Properties configuration) throws ConfigurationException
Sets the Flags to the specified configuration, with defaults for those not supplied. Note that those "defaults" here do not include checking the settings inSystem.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 (SeeSystem.getProperties()
). A safer approach 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);
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.- Throws:
ConfigurationException
-
-
Method Detail
-
isPostJDK5
public static boolean isPostJDK5(java.lang.String bytecodeVersion)
Checks if the specified bytecode version string represents a JDK 1.5+ compatible bytecode version.- Parameters:
bytecodeVersion
- the bytecode version string (1.4, 1.5, 1.6, 1.7 or 1.8)- Returns:
- true if the bytecode version is JDK 1.5+
-
isPostJDK7
public static boolean isPostJDK7(java.lang.String bytecodeVersion)
Checks if the specified bytecode version string represents a JDK 1.7+ compatible bytecode version.- Parameters:
bytecodeVersion
- the bytecode version string (1.4, 1.5, 1.6, 1.7 or 1.8)- Returns:
- true if the bytecode version is JDK 1.7+
-
configure
public void configure(java.util.Properties configuration) throws ConfigurationException
Method to configure a CompilerConfiguration by using Properties. For a list of available properties look atCompilerConfiguration(Properties)
.- Parameters:
configuration
- The properties to get flag values from.- Throws:
ConfigurationException
-
getWarningLevel
public int getWarningLevel()
Gets the currently configured warning level. SeeWarningMessage
for level details.
-
setWarningLevel
public void setWarningLevel(int level)
Sets the warning level. SeeWarningMessage
for level details.
-
getSourceEncoding
public java.lang.String getSourceEncoding()
Gets the currently configured source file encoding.
-
setSourceEncoding
public void setSourceEncoding(java.lang.String encoding)
Sets the encoding to be used when reading source files.
-
getOutput
@Deprecated public java.io.PrintWriter getOutput()
Deprecated.not used anymoreGets the currently configured output writer.
-
setOutput
@Deprecated public void setOutput(java.io.PrintWriter output)
Deprecated.not used anymore, has no effectSets the output writer.
-
getTargetDirectory
public java.io.File getTargetDirectory()
Gets the target directory for writing classes.
-
setTargetDirectory
public void setTargetDirectory(java.lang.String directory)
Sets the target directory.
-
setTargetDirectory
public void setTargetDirectory(java.io.File directory)
Sets the target directory.
-
getClasspath
public java.util.List<java.lang.String> getClasspath()
- Returns:
- the classpath
-
setClasspath
public void setClasspath(java.lang.String classpath)
Sets the classpath.
-
setClasspathList
public void setClasspathList(java.util.List<java.lang.String> parts)
sets the classpath using a list of Strings- Parameters:
parts
- list of strings containing the classpath parts
-
getVerbose
public boolean getVerbose()
Returns true if verbose operation has been requested.
-
setVerbose
public void setVerbose(boolean verbose)
Turns verbose operation on or off.
-
getDebug
public boolean getDebug()
Returns true if debugging operation has been requested.
-
setDebug
public void setDebug(boolean debug)
Turns debugging operation on or off.
-
getTolerance
public int getTolerance()
Returns the requested error tolerance.
-
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.
-
getScriptBaseClass
public java.lang.String getScriptBaseClass()
Gets the name of the base class for scripts. It must be a subclass of Script.
-
setScriptBaseClass
public void setScriptBaseClass(java.lang.String scriptBaseClass)
Sets the name of the base class for scripts. It must be a subclass of Script.
-
getPluginFactory
public ParserPluginFactory getPluginFactory()
-
setPluginFactory
public void setPluginFactory(ParserPluginFactory pluginFactory)
-
setScriptExtensions
public void setScriptExtensions(java.util.Set<java.lang.String> scriptExtensions)
-
getScriptExtensions
public java.util.Set<java.lang.String> getScriptExtensions()
-
getDefaultScriptExtension
public java.lang.String getDefaultScriptExtension()
-
setDefaultScriptExtension
public void setDefaultScriptExtension(java.lang.String defaultScriptExtension)
-
setRecompileGroovySource
public void setRecompileGroovySource(boolean recompile)
-
getRecompileGroovySource
public boolean getRecompileGroovySource()
-
setMinimumRecompilationInterval
public void setMinimumRecompilationInterval(int time)
-
getMinimumRecompilationInterval
public int getMinimumRecompilationInterval()
-
setTargetBytecode
public void setTargetBytecode(java.lang.String version)
Allow setting the bytecode compatibility. The parameter can take one of the values 1.7, 1.6, 1.5 or 1.4. If wrong parameter then the value will default to VM determined version.- Parameters:
version
- the bytecode compatibility mode
-
getTargetBytecode
public java.lang.String getTargetBytecode()
Retrieves the compiler bytecode compatibility mode.- Returns:
- bytecode compatibility mode. Can be either 1.5 or 1.4.
-
getJointCompilationOptions
public java.util.Map<java.lang.String,java.lang.Object> getJointCompilationOptions()
Gets the joint compilation options for this configuration.- Returns:
- the options
-
setJointCompilationOptions
public void setJointCompilationOptions(java.util.Map<java.lang.String,java.lang.Object> options)
Sets the joint compilation options for this configuration. Using null will disable joint compilation.- Parameters:
options
- the options
-
getOptimizationOptions
public java.util.Map<java.lang.String,java.lang.Boolean> getOptimizationOptions()
Gets the optimization options for this configuration.- Returns:
- the options (always not null)
-
setOptimizationOptions
public void setOptimizationOptions(java.util.Map<java.lang.String,java.lang.Boolean> options)
Sets the optimization options for this configuration. No entry or a true for that entry means to enable that optimization, a false means the optimization is disabled. Valid keys are "all" and "int".- Parameters:
options
- the options.- Throws:
java.lang.IllegalArgumentException
- if the options are null
-
addCompilationCustomizers
public CompilerConfiguration addCompilationCustomizers(CompilationCustomizer... customizers)
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
-
getCompilationCustomizers
public java.util.List<CompilationCustomizer> getCompilationCustomizers()
Returns the list of compilation customizers.- Returns:
- the customizers (always not null)
-
getDisabledGlobalASTTransformations
public java.util.Set<java.lang.String> getDisabledGlobalASTTransformations()
Returns the list of disabled global AST transformation class names.- Returns:
- a list of global AST transformation fully qualified class names
-
setDisabledGlobalASTTransformations
public void setDisabledGlobalASTTransformations(java.util.Set<java.lang.String> disabledGlobalASTTransformations)
Disables global AST transformations. In order to avoid class loading side effects, it is not recommended to use MyASTTransformation.class.getName() by directly use the class name as a string. Disabled AST transformations only apply to automatically loaded global AST transformations, that is to say transformations defined in a META-INF/org.codehaus.groovy.transform.ASTTransformation file. If you explicitly add a global AST transformation in your compilation process, for example using theASTTransformationCustomizer
or using aCompilationUnit.PrimaryClassNodeOperation
, then nothing will prevent the transformation from being loaded.- Parameters:
disabledGlobalASTTransformations
- a set of fully qualified class names of global AST transformations which should not be loaded.
-
getBytecodePostprocessor
public BytecodeProcessor getBytecodePostprocessor()
-
setBytecodePostprocessor
public void setBytecodePostprocessor(BytecodeProcessor bytecodePostprocessor)
-
-