asteroid.transformer

Class AbstractClassNodeTransformer

java.lang.Object

org.codehaus.groovy.ast.CodeVisitorSupport

org.codehaus.groovy.ast.ClassCodeVisitorSupport

org.codehaus.groovy.ast.ClassCodeExpressionTransformer

asteroid.transformer.AbstractTransformer

asteroid.transformer.AbstractClassNodeTransformer

All Implemented Interfaces:

Transformer, ExpressionTransformer, GroovyClassVisitor, GroovyCodeVisitor

Direct Known Subclasses:

TranslateToGlobalTransform

public abstract class AbstractClassNodeTransformer
extends AbstractTransformer

This Transformer can be used to transform ClassNode nodes. To locate the classes you want to transform, a criteria in form of Closure can be passed in the constructor. The criteria must be a Closure receiving as unique parameter a ClassNode and returning a Boolean value. If the closure returns true, then the transformation will be applied.

There are some static methods creating some default criterias:

• Criterias.byClassNodeNameContains(String)
• Criterias.byClassNodeNameStartsWith(String)
• Criterias.byClassNodeNameEndsWith(String)

Since:

0.2.0

Constructor Summary

Constructors

Constructor and Description
AbstractClassNodeTransformer(SourceUnit sourceUnit, Closure<java.lang.Boolean> criteria) Every instance needs the source unit and the name of the class it's going to transform.

Method Summary

Modifier and Type	Method and Description
abstract void	transformClass(ClassNode classNode) Within this method developer could modify the ClassNode instance.
void	visitClass(ClassNode classNode) This function has to be implemented in order the transformation to traverse every ClassNode in the AST

Methods inherited from class asteroid.transformer.AbstractTransformer

getModule, getModulePackageName, getSourceUnit

Methods inherited from class org.codehaus.groovy.ast.ClassCodeExpressionTransformer

transform, visitAnnotations, visitAssertStatement, visitCaseStatement, visitConstructorOrMethod, visitDoWhileLoop, visitExpressionStatement, visitField, visitForLoop, visitIfElse, visitProperty, visitReturnStatement, visitSwitch, visitSynchronizedStatement, visitThrowStatement, visitWhileLoop

Methods inherited from class org.codehaus.groovy.ast.ClassCodeVisitorSupport

addError, visitBlockStatement, visitBreakStatement, visitCatchStatement, visitClassCodeContainer, visitConstructor, visitContinueStatement, visitDeclarationExpression, visitImports, visitMethod, visitObjectInitializerStatements, visitPackage, visitStatement, visitTryCatchFinally

Methods inherited from class org.codehaus.groovy.ast.CodeVisitorSupport

visitArgumentlistExpression, visitArrayExpression, visitAttributeExpression, visitBinaryExpression, visitBitwiseNegationExpression, visitBooleanExpression, visitBytecodeExpression, visitCastExpression, visitClassExpression, visitClosureExpression, visitClosureListExpression, visitConstantExpression, visitConstructorCallExpression, visitEmptyStatement, visitFieldExpression, visitGStringExpression, visitListExpression, visitListOfExpressions, visitMapEntryExpression, visitMapExpression, visitMethodCallExpression, visitMethodPointerExpression, visitNotExpression, visitPostfixExpression, visitPrefixExpression, visitPropertyExpression, visitRangeExpression, visitShortTernaryExpression, visitSpreadExpression, visitSpreadMapExpression, visitStaticMethodCallExpression, visitTernaryExpression, visitTupleExpression, visitUnaryMinusExpression, visitUnaryPlusExpression, visitVariableExpression

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractClassNodeTransformer

public AbstractClassNodeTransformer(SourceUnit sourceUnit,
                                    Closure<java.lang.Boolean> criteria)

Every instance needs the source unit and the name of the class it's going to transform. To find classes eligible to be transformed by this Transformer a Closure returning a boolean is used as a criteria. You can create your own criteria or use one of the static methods present in this class. These methods will create a pre-defined criteria. The Closure used as a criteria will receive a ClassNode and return a Boolean value. If the closure returns true then the transformation will be apply, if not the ClassNode will be discarded.

Parameters:

sourceUnit - Needed to apply scope

criteria - used to locate target classes look for the qualified class)

Since:

0.2.0

See Also:

Criterias.byClassNodeNameContains(String)

Method Detail

visitClass

public void visitClass(ClassNode classNode)

This function has to be implemented in order the transformation to traverse every ClassNode in the AST

Specified by:

visitClass in interface Transformer

Specified by:

visitClass in interface GroovyClassVisitor

Overrides:

visitClass in class ClassCodeVisitorSupport

Parameters:

classNode - The next ClassNode to traverse

transformClass

public abstract void transformClass(ClassNode classNode)

Within this method developer could modify the ClassNode instance.

Parameters:

classNode - the ClassNode you want to transform

Since:

0.2.0