Constructor Detail

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

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

  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.

Method Detail

• public CompilerConfiguration addCompilationCustomizers(CompilationCustomizer... customizers)

• public void configure(Properties configuration)

• public List getClasspath()

  Returns true if debugging operation has been requested.

• public List getCompilationCustomizers()

• public boolean getDebug()

• public String getDefaultScriptExtension()

• public Set getDisabledGlobalASTTransformations()

• 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

• public int getMinimumRecompilationInterval()

• public Map getOptimizationOptions()

  Returns the list of disabled global AST transformation class names.

  Returns:

  a list of global AST transformation fully qualified class names

• public PrintWriter getOutput()

• public ParserPluginFactory getPluginFactory()

• public boolean getRecompileGroovySource()

• public String getScriptBaseClass()

• public Set getScriptExtensions()

• public String getSourceEncoding()

  Gets the target directory for writing classes.

• public String getTargetBytecode()

  Gets the optimization options for this configuration.

  Returns:

  the options (always not null)

• public File getTargetDirectory()

• public int getTolerance()

• public boolean getVerbose()

• public int getWarningLevel()

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

• public static boolean isPostJDK5(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+

• public static boolean isPostJDK7(String bytecodeVersion)

  Method to configure a this CompilerConfiguration by using Properties. For a list of available properties look at {link CompilerConfiguration(Properties).

  Parameters:

  configuration - The properties to get flag values from.

• public void setClasspath(String classpath)

  Turns debugging operation on or off.

• public void setClasspathList(List parts)

  Returns the requested error tolerance.

• public void setDebug(boolean debug)

• public void setDefaultScriptExtension(String defaultScriptExtension)

• public void setDisabledGlobalASTTransformations(Set disabledGlobalASTTransformations)

• public void setJointCompilationOptions(Map options)

  Returns the list of compilation customizers.

  Returns:

  the customizers (always not null)

• public void setMinimumRecompilationInterval(int time)

• public void setOptimizationOptions(Map options)

  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 the ASTTransformationCustomizer or using a org.codehaus.groovy.control.CompilationUnit.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.

• public void setOutput(PrintWriter output)

• public void setPluginFactory(ParserPluginFactory pluginFactory)

• public void setRecompileGroovySource(boolean recompile)

• public void setScriptBaseClass(String scriptBaseClass)

• public void setScriptExtensions(Set scriptExtensions)

• public void setSourceEncoding(String encoding)

• public void setTargetBytecode(String version)

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

  Parameters:

  options - the options

• public void setTargetDirectory(String directory)

• public void setTargetDirectory(File directory)

  Turns verbose operation on or off.

• public void setTolerance(int tolerance)

• public void setVerbose(boolean verbose)

• public void setWarningLevel(int level)