Field Detail

• protected CompilationUnit compilationUnit

  Compilation unit currently being customized.

Property Detail

• final ASTTransformation transformation

  Transformation instance applied by this customizer.

Constructor Detail

• ASTTransformationCustomizer(Class<? extends Annotation> transformationAnnotation, String astTransformationClassName, ClassLoader transformationClassLoader)

  Creates an AST transformation customizer using the specified annotation. The transformation classloader can be used if the transformation class cannot be loaded from the same class loader as the annotation class. It's assumed that the annotation is not annotated with GroovyASTTransformationClass and so the second argument supplies the link to the ASTTransformation class that should be used.

  Parameters:

  transformationAnnotation

  astTransformationClassName

  transformationClassLoader

• ASTTransformationCustomizer(Class<? extends Annotation> transformationAnnotation, String astTransformationClassName)

  Creates an AST transformation customizer using the specified annotation. It's assumed that the annotation is not annotated with GroovyASTTransformationClass and so the second argument supplies the link to the ASTTransformation class that should be used.

  Parameters:

  transformationAnnotation

  astTransformationClassName

• ASTTransformationCustomizer(Map annotationParams, Class<? extends Annotation> transformationAnnotation, String astTransformationClassName, ClassLoader transformationClassLoader)

  Creates an AST transformation customizer using the specified annotation. The transformation classloader can be used if the transformation class cannot be loaded from the same class loader as the annotation class. Additionally, you can pass a map of parameters that will be used to parameterize the annotation. It's assumed that the annotation is not annotated with GroovyASTTransformationClass and so the second argument supplies the link to the ASTTransformation class that should be used.

  Parameters:

  transformationAnnotation

  astTransformationClassName

  transformationClassLoader

• ASTTransformationCustomizer(Map annotationParams, Class<? extends Annotation> transformationAnnotation, String astTransformationClassName)

  Creates an AST transformation customizer using the specified annotation, annotation parameters, and transformation class name.

  Parameters:

  annotationParams - the annotation member values to apply

  transformationAnnotation - the transformation annotation type

  astTransformationClassName - the implementation class name for the transformation

• ASTTransformationCustomizer(Class<? extends Annotation> transformationAnnotation, ClassLoader transformationClassLoader)

  Creates an AST transformation customizer using the specified annotation. The transformation classloader can be used if the transformation class cannot be loaded from the same class loader as the annotation class.

  Parameters:

  transformationAnnotation

  transformationClassLoader

• ASTTransformationCustomizer(Class<? extends Annotation> transformationAnnotation)

  Creates an AST transformation customizer using the specified annotation.

  Parameters:

  transformationAnnotation

• ASTTransformationCustomizer(ASTTransformation transformation)

  Creates an AST transformation customizer using the specified transformation.

• ASTTransformationCustomizer(Map annotationParams, Class<? extends Annotation> transformationAnnotation, ClassLoader transformationClassLoader)

  Creates an AST transformation customizer using the specified annotation. The transformation classloader can be used if the transformation class cannot be loaded from the same class loader as the annotation class. Additionally, you can pass a map of parameters that will be used to parameterize the annotation.

  Parameters:

  transformationAnnotation

  transformationClassLoader

• ASTTransformationCustomizer(Map annotationParams, Class<? extends Annotation> transformationAnnotation)

  Creates an AST transformation customizer using the specified annotation and annotation parameters.

  Parameters:

  annotationParams - the annotation member values to apply

  transformationAnnotation - the transformation annotation type

• ASTTransformationCustomizer(Map annotationParams, ASTTransformation transformation)

  Creates an AST transformation customizer using the specified transformation and annotation parameters.

  Parameters:

  annotationParams - the annotation member values to apply

  transformation - the transformation to invoke

Method Detail

• @Override
  void call(SourceUnit sourceUnit, GeneratorContext context, ClassNode classNode)

  Applies the configured transformation to the supplied class or source unit.

  Parameters:

  sourceUnit - the current source unit

  context - the current generator context

  classNode - the class node being customized

• static List<ASTTransformationCustomizer> forAnnotation(Class<? extends Annotation> transformationAnnotation)

  Creates one ASTTransformationCustomizer per AST transformation class declared by the given annotation's GroovyASTTransformationClass list. This is the way to use the customizer with annotations whose implementation is split across multiple transforms running at different compile phases (e.g. Sealed, RecordBase).

  Spread the result into CompilerConfiguration.addCompilationCustomizers:

  
       configuration.addCompilationCustomizers(*ASTTransformationCustomizer.forAnnotation(Sealed))
   

  Since:

  6.0.0

• static List<ASTTransformationCustomizer> forAnnotation(Class<? extends Annotation> transformationAnnotation, ClassLoader transformationClassLoader)

  See Also:

  forAnnotation(Class)

  Since:

  6.0.0

• static List<ASTTransformationCustomizer> forAnnotation(Map annotationParams, Class<? extends Annotation> transformationAnnotation)

  See Also:

  forAnnotation(Class)

  Since:

  6.0.0

• static List<ASTTransformationCustomizer> forAnnotation(Map annotationParams, Class<? extends Annotation> transformationAnnotation, ClassLoader transformationClassLoader)

  See Also:

  forAnnotation(Class)

  Since:

  6.0.0

• void setAnnotationParameters(Map<String, Object> parameters)

  Specify annotation parameters. For example, if the annotation is:

  @Log(value='logger')

  You could create an AST transformation customizer and specify the "value" parameter thanks to this method:

  annotationParameters = [value: 'logger']

  Note that you cannot specify annotation closure values directly. If the annotation you want to add takes a closure as an argument, you will have to set a ClosureExpression instead. This can be done by either creating a custom ClosureExpression from code, or using the AstBuilder.

  Here is an example:

  
   // add @Contract({distance >= 0 })
   def customizer = new ASTTransformationCustomizer(Contract)
   def expression = new AstBuilder().buildFromCode(CompilePhase.CONVERSION) { ->
      distance >= 0
   }.expression[0]
   customizer.annotationParameters = [value: expression]

  Since:

  1.8.1

• @Override
  void setCompilationUnit(CompilationUnit compilationUnit)

  Records the compilation unit that will receive the configured transformation.

  Parameters:

  compilationUnit - the owning compilation unit