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.
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String[]ALLOWED_JDKSThe valid targetBytecode values.static intASM_API_VERSIONThe ASM API version used when loading/parsing classes and generating proxy adapter classes.static CompilerConfigurationDEFAULTA convenience for getting a default configuration.static java.lang.StringDEFAULT_SOURCE_ENCODINGstatic java.lang.StringGROOVYDOCOptimization Option for enabling attaching groovydoc as AST node metadata.static java.lang.StringINVOKEDYNAMICOptimization Option for enablinginvokedynamiccompilation.static java.util.Map<java.lang.String,java.lang.Integer>JDK_TO_BYTECODE_VERSION_MAPJDK version to bytecode version mapping.static java.lang.StringJDK10This ("10") is the value for targetBytecode to compile for a JDK 10.static java.lang.StringJDK11This ("11") is the value for targetBytecode to compile for a JDK 11.static java.lang.StringJDK12This ("12") is the value for targetBytecode to compile for a JDK 12.static java.lang.StringJDK13This ("13") is the value for targetBytecode to compile for a JDK 13.static java.lang.StringJDK14This ("14") is the value for targetBytecode to compile for a JDK 14.static java.lang.StringJDK15This ("15") is the value for targetBytecode to compile for a JDK 15.static java.lang.StringJDK16This ("16") is the value for targetBytecode to compile for a JDK 16.static java.lang.StringJDK17This ("17") is the value for targetBytecode to compile for a JDK 17.static java.lang.StringJDK4This ("1.4") is the value for targetBytecode to compile for a JDK 1.4.static java.lang.StringJDK5This ("1.5") is the value for targetBytecode to compile for a JDK 1.5.static java.lang.StringJDK6This ("1.6") is the value for targetBytecode to compile for a JDK 1.6.static java.lang.StringJDK7This ("1.7") is the value for targetBytecode to compile for a JDK 1.7.static java.lang.StringJDK8This ("1.8") is the value for targetBytecode to compile for a JDK 1.8.static java.lang.StringJDK9This ("9") is the value for targetBytecode to compile for a JDK 9.static java.lang.StringMEM_STUBJoint Compilation Option for enabling generating stubs in memory.static java.lang.StringPARALLEL_PARSEOptimization Option for enabling parallel parsing.static java.lang.StringPOST_JDK5Deprecated.static java.lang.StringPRE_JDK5Deprecated.static java.lang.StringRUNTIME_GROOVYDOCOptimization Option for enabling attachingGroovydocannotation. -
Constructor Summary
Constructors Constructor Description CompilerConfiguration()Sets the compiler flags/settings to default values.CompilerConfiguration(java.util.Properties configuration)Sets the configuration flags/settings according to values from the suppliedPropertiesinstance or if not found, supplying a default value.CompilerConfiguration(CompilerConfiguration configuration)Copy constructor. -
Method Summary
Modifier and Type Method Description CompilerConfigurationaddCompilationCustomizers(CompilationCustomizer... customizers)Adds compilation customizers to the compilation process.voidconfigure(java.util.Properties configuration)Method to configure a CompilerConfiguration by using Properties.BytecodeProcessorgetBytecodePostprocessor()java.util.List<java.lang.String>getClasspath()java.util.List<CompilationCustomizer>getCompilationCustomizers()Returns the list of compilation customizers.booleangetDebug()Returns true if debugging operation has been requested.java.lang.StringgetDefaultScriptExtension()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.intgetMinimumRecompilationInterval()java.util.Map<java.lang.String,java.lang.Boolean>getOptimizationOptions()Gets the optimization options for this configuration.java.io.PrintWritergetOutput()Deprecated.not used anymorebooleangetParameters()Returns true if parameter metadata generation has been enabled.ParserPluginFactorygetPluginFactory()booleangetRecompileGroovySource()java.lang.StringgetScriptBaseClass()Gets the name of the base class for scripts.java.util.Set<java.lang.String>getScriptExtensions()java.lang.StringgetSourceEncoding()Gets the currently configured source file encoding.java.lang.StringgetTargetBytecode()Returns the compiler bytecode compatibility level.java.io.FilegetTargetDirectory()Gets the target directory for writing classes.intgetTolerance()Returns the requested error tolerance.booleangetVerbose()Returns true if verbose operation has been requested.intgetWarningLevel()Gets the currently configured warning level.booleanisGroovydocEnabled()Checks if groovydoc is enabled.booleanisIndyEnabled()Checks if invoke dynamic is enabled.static booleanisPostJDK5(java.lang.String bytecodeVersion)Checks if the specified bytecode version string represents a JDK 1.5+ compatible bytecode version.static booleanisPostJDK7(java.lang.String bytecodeVersion)Checks if the specified bytecode version string represents a JDK 1.7+ compatible bytecode version.static booleanisPostJDK8(java.lang.String bytecodeVersion)Checks if the specified bytecode version string represents a JDK 1.8+ compatible bytecode version.static booleanisPostJDK9(java.lang.String bytecodeVersion)Checks if the specified bytecode version string represents a JDK 1.8+ compatible bytecode version.booleanisPreviewFeatures()Whether the bytecode version has preview features enabled (JEP 12)booleanisRuntimeGroovydocEnabled()Checks if runtime groovydoc is enabled.voidsetBytecodePostprocessor(BytecodeProcessor bytecodePostprocessor)voidsetClasspath(java.lang.String classpath)Sets the classpath.voidsetClasspathList(java.util.List<java.lang.String> parts)sets the classpath using a list of StringsvoidsetDebug(boolean debug)Turns debugging operation on or off.voidsetDefaultScriptExtension(java.lang.String defaultScriptExtension)voidsetDisabledGlobalASTTransformations(java.util.Set<java.lang.String> disabledGlobalASTTransformations)Disables the specified global AST transformations.voidsetJointCompilationOptions(java.util.Map<java.lang.String,java.lang.Object> options)Sets the joint compilation options for this configuration.voidsetMinimumRecompilationInterval(int time)voidsetOptimizationOptions(java.util.Map<java.lang.String,java.lang.Boolean> options)Sets the optimization options for this configuration.voidsetOutput(java.io.PrintWriter output)Deprecated.not used anymore, has no effectvoidsetParameters(boolean parameters)Turns parameter metadata generation on or off.voidsetPluginFactory(ParserPluginFactory pluginFactory)voidsetPreviewFeatures(boolean previewFeatures)Sets whether the bytecode version has preview features enabled (JEP 12).voidsetRecompileGroovySource(boolean recompile)voidsetScriptBaseClass(java.lang.String scriptBaseClass)Sets the name of the base class for scripts.voidsetScriptExtensions(java.util.Set<java.lang.String> scriptExtensions)voidsetSourceEncoding(java.lang.String encoding)Sets the encoding to be used when reading source files.voidsetTargetBytecode(java.lang.String version)Sets the bytecode compatibility level.voidsetTargetDirectory(java.io.File directory)Sets the target directory.voidsetTargetDirectory(java.lang.String directory)Sets the target directory.voidsetTolerance(int tolerance)Sets the error tolerance, which is the number of non-fatal errors (per unit) that should be tolerated before compilation is aborted.voidsetVerbose(boolean verbose)Turns verbose operation on or off.voidsetWarningLevel(int level)Sets the warning level.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Field Details
-
INVOKEDYNAMIC
public static final java.lang.String INVOKEDYNAMICOptimization Option for enablinginvokedynamiccompilation.- See Also:
- Constant Field Values
-
GROOVYDOC
public static final java.lang.String GROOVYDOCOptimization Option for enabling attaching groovydoc as AST node metadata.- See Also:
- Constant Field Values
-
RUNTIME_GROOVYDOC
public static final java.lang.String RUNTIME_GROOVYDOCOptimization Option for enabling attachingGroovydocannotation.- See Also:
- Constant Field Values
-
PARALLEL_PARSE
public static final java.lang.String PARALLEL_PARSEOptimization Option for enabling parallel parsing.- See Also:
- Constant Field Values
-
MEM_STUB
public static final java.lang.String MEM_STUBJoint Compilation Option for enabling generating stubs in memory.- See Also:
- Constant Field Values
-
JDK4
public static final java.lang.String JDK4This ("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 JDK5This ("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 JDK6This ("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 JDK7This ("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 JDK8This ("1.8") is the value for targetBytecode to compile for a JDK 1.8.- See Also:
- Constant Field Values
-
JDK9
public static final java.lang.String JDK9This ("9") is the value for targetBytecode to compile for a JDK 9.- See Also:
- Constant Field Values
-
JDK10
public static final java.lang.String JDK10This ("10") is the value for targetBytecode to compile for a JDK 10.- See Also:
- Constant Field Values
-
JDK11
public static final java.lang.String JDK11This ("11") is the value for targetBytecode to compile for a JDK 11.- See Also:
- Constant Field Values
-
JDK12
public static final java.lang.String JDK12This ("12") is the value for targetBytecode to compile for a JDK 12.- See Also:
- Constant Field Values
-
JDK13
public static final java.lang.String JDK13This ("13") is the value for targetBytecode to compile for a JDK 13.- See Also:
- Constant Field Values
-
JDK14
public static final java.lang.String JDK14This ("14") is the value for targetBytecode to compile for a JDK 14.- See Also:
- Constant Field Values
-
JDK15
public static final java.lang.String JDK15This ("15") is the value for targetBytecode to compile for a JDK 15.- See Also:
- Constant Field Values
-
JDK16
public static final java.lang.String JDK16This ("16") is the value for targetBytecode to compile for a JDK 16.- See Also:
- Constant Field Values
-
JDK17
public static final java.lang.String JDK17This ("17") is the value for targetBytecode to compile for a JDK 17.- See Also:
- Constant Field Values
-
POST_JDK5
@Deprecated public static final java.lang.String POST_JDK5Deprecated.This constant is for comparing targetBytecode to ensure it is set to JDK 1.5 or later.- See Also:
- Constant Field Values
-
PRE_JDK5
@Deprecated public static final java.lang.String PRE_JDK5Deprecated.This constant is for comparing targetBytecode to ensure it is set to an earlier value than JDK 1.5.- See Also:
- Constant Field Values
-
JDK_TO_BYTECODE_VERSION_MAP
public static final java.util.Map<java.lang.String,java.lang.Integer> JDK_TO_BYTECODE_VERSION_MAPJDK version to bytecode version mapping. -
ALLOWED_JDKS
public static final java.lang.String[] ALLOWED_JDKSThe valid targetBytecode values. -
ASM_API_VERSION
public static final int ASM_API_VERSIONThe ASM API version used when loading/parsing classes and generating proxy adapter classes.- See Also:
- Constant Field Values
-
DEFAULT_SOURCE_ENCODING
public static final java.lang.String DEFAULT_SOURCE_ENCODING- See Also:
- Constant Field Values
-
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 Details
-
CompilerConfiguration
public CompilerConfiguration()Sets the compiler flags/settings to default values. The following system properties are referenced when setting the configuration:
The following system properties are referenced when setting the configuration optimization options:Property Key Related Property Getter groovy.antlr4getPluginFactory()groovy.source.encoding(defaulting tofile.encoding)getSourceEncoding()groovy.target.bytecodegetTargetBytecode()groovy.target.directorygetTargetDirectory()groovy.parametersgetParameters()groovy.preview.featuresisPreviewFeatures()groovy.default.scriptExtensiongetDefaultScriptExtension()Property Key Related Property Getter groovy.target.indygetOptimizationOptions()groovy.attach.groovydocgetOptimizationOptions()groovy.attach.runtime.groovydocgetOptimizationOptions() -
CompilerConfiguration
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
Sets the configuration flags/settings according to values from the suppliedPropertiesinstance or if not found, supplying a default value. Note that unlikeCompilerConfiguration(), the "defaults" here do not in general include checking the settings inSystem.getProperties(). If you want to set a few flags but keep Groovy's default configuration behavior then be sure to make your settings in aPropertiesobject that is backed bySystem.getProperties()(which is done using this constructor). That might be done like this:
And you also have to contend with a possibleProperties myProperties = new Properties(System.getProperties()); myProperties.setProperty("groovy.output.debug", "true"); myConfiguration = new CompilerConfiguration(myProperties);SecurityExceptionwhen getting the system properties (SeeSystem.getProperties()). A safer approach would be to copy a defaultCompilerConfigurationand make your changes there using the setter:
The following properties are referenced when setting the configuration:// 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 Related Property Getter groovy.warningsgetWarningLevel()groovy.source.encoding(defaulting tofile.encoding)getSourceEncoding()groovy.target.directorygetTargetDirectory()groovy.target.bytecodegetTargetBytecode()groovy.parametersgetParameters()groovy.preview.featuresisPreviewFeatures()groovy.classpathgetClasspath()groovy.output.verbosegetVerbose()groovy.output.debuggetDebug()groovy.errors.tolerancegetTolerance()groovy.default.scriptExtensiongetDefaultScriptExtension()groovy.script.basegetScriptBaseClass()groovy.recompilegetRecompileGroovySource()groovy.recompile.minimumIntervalgetMinimumRecompilationInterval()groovy.disabled.global.ast.transformationsgetDisabledGlobalASTTransformations()- Parameters:
configuration- The properties to get flag values from.- Throws:
ConfigurationException
-
-
Method Details
-
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 parameter can take one of the values inALLOWED_JDKS.- 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 parameter can take one of the values inALLOWED_JDKS.- Returns:
- true if the bytecode version is JDK 1.7+
-
isPostJDK8
public static boolean isPostJDK8(java.lang.String bytecodeVersion)Checks if the specified bytecode version string represents a JDK 1.8+ compatible bytecode version.- Parameters:
bytecodeVersion- The parameter can take one of the values inALLOWED_JDKS.- Returns:
- true if the bytecode version is JDK 1.8+
-
isPostJDK9
public static boolean isPostJDK9(java.lang.String bytecodeVersion)Checks if the specified bytecode version string represents a JDK 1.8+ compatible bytecode version.- Parameters:
bytecodeVersion- The parameter can take one of the values inALLOWED_JDKS.- Returns:
- true if the bytecode version is JDK 9.0+
-
configure
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. SeeWarningMessagefor level details. -
setWarningLevel
public void setWarningLevel(int level)Sets the warning level. SeeWarningMessagefor 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.io.File directory)Sets the target directory. -
setTargetDirectory
public void setTargetDirectory(java.lang.String 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. -
getParameters
public boolean getParameters()Returns true if parameter metadata generation has been enabled. -
setParameters
public void setParameters(boolean parameters)Turns parameter metadata generation 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
-
setPluginFactory
-
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) -
getRecompileGroovySource
public boolean getRecompileGroovySource() -
setRecompileGroovySource
public void setRecompileGroovySource(boolean recompile) -
getMinimumRecompilationInterval
public int getMinimumRecompilationInterval() -
setMinimumRecompilationInterval
public void setMinimumRecompilationInterval(int time) -
getTargetBytecode
public java.lang.String getTargetBytecode()Returns the compiler bytecode compatibility level. Defaults to the minimum officially supported bytecode version for any particular Groovy version.- Returns:
- bytecode compatibility level
-
setTargetBytecode
public void setTargetBytecode(java.lang.String version)Sets the bytecode compatibility level. The parameter can take one of the values inALLOWED_JDKS.- Parameters:
version- the bytecode compatibility level
-
isPreviewFeatures
public boolean isPreviewFeatures()Whether the bytecode version has preview features enabled (JEP 12)- Returns:
- preview features
-
setPreviewFeatures
public void setPreviewFeatures(boolean previewFeatures)Sets whether the bytecode version has preview features enabled (JEP 12).- Parameters:
previewFeatures- whether to support preview features
-
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
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
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 the specified global AST transformations. In order to avoid class loading side effects, it is not recommended to use MyASTTransformation.class.getName() but instead 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/services/org.codehaus.groovy.transform.ASTTransformation file. If you explicitly add a global AST transformation in your compilation process, for example using theASTTransformationCustomizeror using aCompilationUnit.IPrimaryClassNodeOperation, 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
-
setBytecodePostprocessor
-
isIndyEnabled
public boolean isIndyEnabled()Checks if invoke dynamic is enabled. -
isGroovydocEnabled
public boolean isGroovydocEnabled()Checks if groovydoc is enabled. -
isRuntimeGroovydocEnabled
public boolean isRuntimeGroovydocEnabled()Checks if runtime groovydoc is enabled.
-