Package org.codehaus.groovy.control

Class CompilerConfiguration

java.lang.Object
org.codehaus.groovy.control.CompilerConfiguration
public class CompilerConfiguration extends Object
Compilation control flags and coordination stuff.

  • Field Details

    • INVOKEDYNAMIC

      public static final String INVOKEDYNAMIC
      Optimization Option for enabling invokedynamic compilation.
      See Also:

    • GROOVYDOC

      public static final String GROOVYDOC
      Optimization Option for enabling attaching groovydoc as AST node metadata.
      See Also:

    • RUNTIME_GROOVYDOC

      public static final String RUNTIME_GROOVYDOC
      Optimization Option for enabling attaching Groovydoc annotation.
      See Also:

    • PARALLEL_PARSE

      public static final String PARALLEL_PARSE
      Optimization Option for enabling parallel parsing.
      See Also:

    • MEM_STUB

      public static final String MEM_STUB
      Joint Compilation Option for enabling generating stubs in memory.
      See Also:

    • JDK4

      @Deprecated public static final String JDK4
      Deprecated.
      This ("1.4") is the value for targetBytecode to compile for a JDK 1.4.
      See Also:

    • JDK5

      @Deprecated public static final String JDK5
      Deprecated.
      This ("1.5") is the value for targetBytecode to compile for a JDK 1.5.
      See Also:

    • JDK6

      @Deprecated public static final String JDK6
      Deprecated.
      This ("1.6") is the value for targetBytecode to compile for a JDK 1.6.
      See Also:

    • JDK7

      @Deprecated public static final String JDK7
      Deprecated.
      This ("1.7") is the value for targetBytecode to compile for a JDK 1.7.
      See Also:

    • JDK8

      @Deprecated public static final String JDK8
      Deprecated.
      This ("1.8") is the value for targetBytecode to compile for a JDK 1.8.
      See Also:

    • JDK9

      @Deprecated public static final String JDK9
      Deprecated.
      This ("9") is the value for targetBytecode to compile for a JDK 9.
      See Also:

    • JDK10

      @Deprecated public static final String JDK10
      Deprecated.
      This ("10") is the value for targetBytecode to compile for a JDK 10.
      See Also:

    • JDK11

      public static final String JDK11
      This ("11") is the value for targetBytecode to compile for a JDK 11.
      See Also:

    • JDK12

      public static final String JDK12
      This ("12") is the value for targetBytecode to compile for a JDK 12.
      See Also:

    • JDK13

      public static final String JDK13
      This ("13") is the value for targetBytecode to compile for a JDK 13.
      See Also:

    • JDK14

      public static final String JDK14
      This ("14") is the value for targetBytecode to compile for a JDK 14.
      See Also:

    • JDK15

      public static final String JDK15
      This ("15") is the value for targetBytecode to compile for a JDK 15.
      See Also:

    • JDK16

      public static final String JDK16
      This ("16") is the value for targetBytecode to compile for a JDK 16.
      See Also:

    • JDK17

      public static final String JDK17
      This ("17") is the value for targetBytecode to compile for a JDK 17.
      See Also:

    • JDK18

      public static final String JDK18
      This ("18") is the value for targetBytecode to compile for a JDK 18.
      See Also:

    • JDK19

      public static final String JDK19
      This ("19") is the value for targetBytecode to compile for a JDK 19.
      See Also:

    • JDK20

      public static final String JDK20
      This ("20") is the value for targetBytecode to compile for a JDK 20.
      See Also:

    • JDK21

      public static final String JDK21
      This ("21") is the value for targetBytecode to compile for a JDK 21.
      See Also:

    • JDK_TO_BYTECODE_VERSION_MAP

      public static final Map<String,Integer> JDK_TO_BYTECODE_VERSION_MAP
      JDK version to bytecode version mapping.

    • DEFAULT_TARGET_BYTECODE

      public static final String DEFAULT_TARGET_BYTECODE

    • ALLOWED_JDKS

      public static final String[] ALLOWED_JDKS
      The valid targetBytecode values.

    • ASM_API_VERSION

      public static final int ASM_API_VERSION
      The ASM API version used when loading/parsing classes and generating proxy adapter classes.
      See Also:

    • DEFAULT_SOURCE_ENCODING

      public static final String DEFAULT_SOURCE_ENCODING
      The default source encoding.
      See Also:

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

  • Constructor Details

    • CompilerConfiguration

      public CompilerConfiguration()
      Sets the compiler flags/settings to default values. The following system properties are referenced when setting the configuration:
      Property KeyRelated Property Getter
      groovy.source.encoding (defaulting to file.encoding)getSourceEncoding()
      groovy.target.bytecodegetTargetBytecode()
      groovy.target.directorygetTargetDirectory()
      groovy.parametersgetParameters()
      groovy.preview.featuresisPreviewFeatures()
      groovy.default.scriptExtensiongetDefaultScriptExtension()
      The following system properties are referenced when setting the configuration optimization options:
      Property KeyRelated Property Getter
      groovy.target.indygetOptimizationOptions()
      groovy.parallel.parsegetOptimizationOptions()
      groovy.attach.groovydocgetOptimizationOptions()
      groovy.attach.runtime.groovydocgetOptimizationOptions()

    • 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) throws ConfigurationException
      Sets the configuration flags/settings according to values from the supplied Properties instance or if not found, supplying a default value. Note that unlike CompilerConfiguration(), the "defaults" here do not in general include checking the settings in System.getProperties(). 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 object 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()). 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);
      The following properties are referenced when setting the configuration:
      Property KeyRelated Property Getter
      groovy.warningsgetWarningLevel()
      groovy.source.encoding (defaulting to file.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

      @Deprecated public static boolean isPostJDK5(String bytecodeVersion)
      Deprecated.
      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 in ALLOWED_JDKS.
      Returns:
      true if the bytecode version is JDK 1.5+

    • isPostJDK7

      @Deprecated public static boolean isPostJDK7(String bytecodeVersion)
      Deprecated.
      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 in ALLOWED_JDKS.
      Returns:
      true if the bytecode version is JDK 1.7+

    • isPostJDK8

      @Deprecated public static boolean isPostJDK8(String bytecodeVersion)
      Deprecated.
      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 in ALLOWED_JDKS.
      Returns:
      true if the bytecode version is JDK 1.8+

    • isPostJDK9

      @Deprecated public static boolean isPostJDK9(String bytecodeVersion)
      Deprecated.
      Checks if the specified bytecode version string represents a JDK 9+ compatible bytecode version.
      Parameters:
      bytecodeVersion - The parameter can take one of the values in ALLOWED_JDKS.
      Returns:
      true if the bytecode version is JDK 9+

    • isPostJDK10

      @Deprecated public static boolean isPostJDK10(String bytecodeVersion)
      Deprecated.
      Checks if the specified bytecode version string represents a JDK 10+ compatible bytecode version.
      Parameters:
      bytecodeVersion - The parameter can take one of the values in ALLOWED_JDKS.
      Returns:
      true if the bytecode version is JDK 10+

    • isPostJDK11

      public static boolean isPostJDK11(String bytecodeVersion)
      Checks if the specified bytecode version string represents a JDK 11+ compatible bytecode version.
      Parameters:
      bytecodeVersion - The parameter can take one of the values in ALLOWED_JDKS.
      Returns:
      true if the bytecode version is JDK 11+

    • isPostJDK12

      public static boolean isPostJDK12(String bytecodeVersion)
      Checks if the specified bytecode version string represents a JDK 12+ compatible bytecode version.
      Parameters:
      bytecodeVersion - The parameter can take one of the values in ALLOWED_JDKS.
      Returns:
      true if the bytecode version is JDK 12+

    • isPostJDK13

      public static boolean isPostJDK13(String bytecodeVersion)
      Checks if the specified bytecode version string represents a JDK 13+ compatible bytecode version.
      Parameters:
      bytecodeVersion - The parameter can take one of the values in ALLOWED_JDKS.
      Returns:
      true if the bytecode version is JDK 13+

    • isPostJDK14

      public static boolean isPostJDK14(String bytecodeVersion)
      Checks if the specified bytecode version string represents a JDK 14+ compatible bytecode version.
      Parameters:
      bytecodeVersion - The parameter can take one of the values in ALLOWED_JDKS.
      Returns:
      true if the bytecode version is JDK 14+

    • isPostJDK15

      public static boolean isPostJDK15(String bytecodeVersion)
      Checks if the specified bytecode version string represents a JDK 15+ compatible bytecode version.
      Parameters:
      bytecodeVersion - The parameter can take one of the values in ALLOWED_JDKS.
      Returns:
      true if the bytecode version is JDK 15+

    • isPostJDK16

      public static boolean isPostJDK16(String bytecodeVersion)
      Checks if the specified bytecode version string represents a JDK 16+ compatible bytecode version.
      Parameters:
      bytecodeVersion - The parameter can take one of the values in ALLOWED_JDKS.
      Returns:
      true if the bytecode version is JDK 16+

    • isPostJDK17

      public static boolean isPostJDK17(String bytecodeVersion)
      Checks if the specified bytecode version string represents a JDK 17+ compatible bytecode version.
      Parameters:
      bytecodeVersion - The parameter can take one of the values in ALLOWED_JDKS.
      Returns:
      true if the bytecode version is JDK 17+

    • isPostJDK18

      public static boolean isPostJDK18(String bytecodeVersion)
      Checks if the specified bytecode version string represents a JDK 18+ compatible bytecode version.
      Parameters:
      bytecodeVersion - The parameter can take one of the values in ALLOWED_JDKS.
      Returns:
      true if the bytecode version is JDK 18+

    • configure

      public void configure(Properties configuration) throws ConfigurationException
      Method to configure a CompilerConfiguration by using Properties. For a list of available properties look at CompilerConfiguration(Properties).
      Parameters:
      configuration - The properties to get flag values from.
      Throws:
      ConfigurationException

    • getWarningLevel

      public int getWarningLevel()
      Gets the currently configured warning level. See WarningMessage for level details.

    • setWarningLevel

      public void setWarningLevel(int level)
      Sets the warning level. See WarningMessage for level details.

    • getSourceEncoding

      public String getSourceEncoding()
      Gets the currently configured source file encoding.

    • setSourceEncoding

      public void setSourceEncoding(String encoding)
      Sets the encoding to be used when reading source files.

    • getOutput

      @Deprecated public PrintWriter getOutput()
      Deprecated.
      not used anymore
      Gets the currently configured output writer.

    • setOutput

      @Deprecated public void setOutput(PrintWriter output)
      Deprecated.
      not used anymore, has no effect
      Sets the output writer.

    • getTargetDirectory

      public File getTargetDirectory()
      Gets the target directory for writing classes.

    • setTargetDirectory

      public void setTargetDirectory(String directory)
      Sets the target directory.

    • setTargetDirectory

      public void setTargetDirectory(File directory)
      Sets the target directory.

    • getClasspath

      public List<String> getClasspath()
      Returns:
      the classpath

    • setClasspath

      public void setClasspath(String classpath)
      Sets the classpath.

    • setClasspathList

      public void setClasspathList(List<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 String getScriptBaseClass()
      Gets the name of the base class for scripts. It must be a subclass of Script.

    • setScriptBaseClass

      public void setScriptBaseClass(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(Set<String> scriptExtensions)

    • getScriptExtensions

      public Set<String> getScriptExtensions()

    • getDefaultScriptExtension

      public String getDefaultScriptExtension()

    • setDefaultScriptExtension

      public void setDefaultScriptExtension(String defaultScriptExtension)

    • getRecompileGroovySource

      public boolean getRecompileGroovySource()

    • setRecompileGroovySource

      public void setRecompileGroovySource(boolean recompile)

    • getMinimumRecompilationInterval

      public int getMinimumRecompilationInterval()

    • setMinimumRecompilationInterval

      public void setMinimumRecompilationInterval(int time)

    • setTargetBytecode

      public void setTargetBytecode(String version)
      Sets the bytecode compatibility level. The parameter can take one of the values in ALLOWED_JDKS.
      Parameters:
      version - the bytecode compatibility level

    • getTargetBytecode

      public String getTargetBytecode()
      Retrieves the compiler bytecode compatibility level. Defaults to the minimum officially supported bytecode version for any particular Groovy version.
      Returns:
      bytecode compatibility level

    • getBytecodeVersion

      public final int getBytecodeVersion()
      Returns the targeted bytecode (aka Java class file) version number.
      Since:
      4.0.0

    • 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

    • isLogClassgen

      public boolean isLogClassgen()
      Returns whether logging class generation is enabled
      Returns:
      whether logging class generation is enabled
      Since:
      4.0.0

    • setLogClassgen

      public void setLogClassgen(boolean logClassgen)
      Sets whether logging class generation is enabled
      Parameters:
      logClassgen - whether to enable logging class generation
      Since:
      4.0.0

    • getLogClassgenStackTraceMaxDepth

      public int getLogClassgenStackTraceMaxDepth()
      Returns stack trace max depth of logging class generation
      Returns:
      stack trace max depth of logging class generation
      Since:
      4.0.0

    • setLogClassgenStackTraceMaxDepth

      public void setLogClassgenStackTraceMaxDepth(int logClassgenStackTraceMaxDepth)
      Sets stack trace max depth of logging class generation
      Parameters:
      logClassgenStackTraceMaxDepth - stack trace max depth of logging class generation
      Since:
      4.0.0

    • getJointCompilationOptions

      public Map<String,Object> getJointCompilationOptions()
      Gets the joint compilation options for this configuration.
      Returns:
      the options

    • setJointCompilationOptions

      public void setJointCompilationOptions(Map<String,Object> options)
      Sets the joint compilation options for this configuration. Using null will disable joint compilation.
      Parameters:
      options - the options

    • getOptimizationOptions

      public Map<String,Boolean> getOptimizationOptions()
      Gets the optimization options for this configuration.
      Returns:
      the options (always not null)

    • setOptimizationOptions

      public void setOptimizationOptions(Map<String,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:
      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 List<CompilationCustomizer> getCompilationCustomizers()
      Returns the list of compilation customizers.
      Returns:
      the customizers (always not null)

    • getDisabledGlobalASTTransformations

      public Set<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(Set<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 the ASTTransformationCustomizer or using a CompilationUnit.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

      public BytecodeProcessor getBytecodePostprocessor()

    • setBytecodePostprocessor

      public void setBytecodePostprocessor(BytecodeProcessor bytecodePostprocessor)

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