org.codehaus.groovy.transform

public Interface ASTTransformation

Known Direct Implementers: org.codehaus.groovy.transform.CategoryASTTransformation, org.codehaus.groovy.transform.FieldASTTransformation, org.codehaus.groovy.transform.NewifyASTTransformation, org.codehaus.groovy.transform.StaticTypesTransformation, groovy.beans.BindableASTTransformation, groovy.grape.GrabAnnotationTransformation, org.codehaus.groovy.ast.MethodCallTransformation, org.codehaus.groovy.transform.AbstractASTTransformation, org.codehaus.groovy.transform.AbstractInterruptibleASTTransformation
Imports: org.codehaus.groovy.ast.ASTNode, org.codehaus.groovy.control.SourceUnit

This class is instantiated and invoked when an AST transformation is activated. For Global AST Transformations, this interface is called once per SourceUnit, which is usually a Groovy source file. For Local AST Transformations, this interface is invoked once every time the Local annotation marker is encountered.

You must annotate this class with GroovyASTTransformation so that Groovy knows which org.codehaus.groovy.control.CompilePhase to run in.

See Also: GroovyASTTransformation

Method Summary

Modifier and Type	Method and Description
public void	visit(ASTNode[] The ASTnodes when the call was triggered. Element 0 is the AnnotationNode that triggered this annotation to be activated. Element 1 is the AnnotatedNode decorated, such as a MethodNode or ClassNode. For global transformations it is usually safe to ignore this parameter. nodes, SourceUnit The source unit being compiled. The source unit may contain several classes. For global transformations, information about the AST can be retrieved from this object. source) The method is invoked when an AST Transformation is active.

Modifier and Type

Method and Description

public void

visit(ASTNode[]

The ASTnodes when the call was triggered. Element 0 is the AnnotationNode that triggered this annotation to be activated. Element 1 is the AnnotatedNode decorated, such as a MethodNode or ClassNode. For global transformations it is usually safe to ignore this parameter.

nodes, SourceUnit

The source unit being compiled. The source unit may contain several classes. For global transformations, information about the AST can be retrieved from this object.

source)

The method is invoked when an AST Transformation is active.

Method Detail

visit	back to summary
public void visit(ASTNode[] nodes, SourceUnit source) The method is invoked when an AST Transformation is active. For local transformations, it is invoked once each time the local annotation is encountered. For global transformations, it is invoked once for every source unit, which is typically a source file. Parameters nodes:ASTNode[] The ASTnodes when the call was triggered. Element 0 is the AnnotationNode that triggered this annotation to be activated. Element 1 is the AnnotatedNode decorated, such as a MethodNode or ClassNode. For global transformations it is usually safe to ignore this parameter. source:SourceUnit The source unit being compiled. The source unit may contain several classes. For global transformations, information about the AST can be retrieved from this object.

visit

back to summary

public void visit(ASTNode[] nodes, SourceUnit source)

The method is invoked when an AST Transformation is active. For local transformations, it is invoked once each time the local annotation is encountered. For global transformations, it is invoked once for every source unit, which is typically a source file.

Parameters

nodes:ASTNode[]: The ASTnodes when the call was triggered. Element 0 is the AnnotationNode that triggered this annotation to be activated. Element 1 is the AnnotatedNode decorated, such as a MethodNode or ClassNode. For global transformations it is usually safe to ignore this parameter.
source:SourceUnit: The source unit being compiled. The source unit may contain several classes. For global transformations, information about the AST can be retrieved from this object.