org.codehaus.groovy.grails.compiler.injection

Class GrailsASTUtils

java.lang.Object

org.codehaus.groovy.grails.compiler.injection.GrailsASTUtils

public class GrailsASTUtils
extends java.lang.Object

Helper methods for working with Groovy AST trees.

Since:

0.3

Author:

Graeme Rocher

Field Summary

Fields

Modifier and Type	Field and Description
static Token	ASSIGNMENT_OPERATOR
static Token	EQUALS_OPERATOR
static java.lang.String	METHOD_MISSING_METHOD_NAME
static ClassNode	MISSING_METHOD_EXCEPTION
static Token	NOT_EQUALS_OPERATOR
static ConstantExpression	NULL_EXPRESSION
static java.lang.String	STATIC_METHOD_MISSING_METHOD_NAME

Constructor Summary

Constructors

Constructor and Description
GrailsASTUtils()

Method Summary

Modifier and Type	Method and Description
static void	addAnnotationIfNecessary(ClassNode classNode, java.lang.Class<Entity> entityClass)
static void	addDelegateConstructor(ClassNode classNode, MethodNode constructorMethod) Adds or modifies an existing constructor to delegate to the given static constructor method for initialization logic.
static MethodNode	addDelegateInstanceMethod(ClassNode classNode, Expression delegate, MethodNode declaredMethod) Adds a delegate method to the target class node where the first argument is to the delegate method is 'this'.
static MethodNode	addDelegateInstanceMethod(ClassNode classNode, Expression delegate, MethodNode declaredMethod, boolean thisAsFirstArgument) Adds a delegate method to the target class node where the first argument is to the delegate method is 'this'.
static void	addDelegateInstanceMethods(ClassNode supportedSuperType, ClassNode classNode, ClassNode delegateNode, Expression delegateInstance)
static void	addDelegateInstanceMethods(ClassNode classNode, ClassNode delegateNode, Expression delegateInstance)
static MethodNode	addDelegateStaticMethod(ClassNode classNode, MethodNode delegateMethod) Adds a static method call to given class node that delegates to the given method
static MethodNode	addDelegateStaticMethod(Expression expression, ClassNode classNode, MethodNode delegateMethod) Adds a static method to the given class node that delegates to the given method and resolves the object to invoke the method on from the given expression.
static void	addFieldIfNonExistent(ClassNode classNode, ClassNode fieldType, java.lang.String fieldName)
static void	addMethodIfNotPresent(ClassNode controllerClassNode, MethodNode methodNode)
static ArgumentListExpression	createArgumentListFromParameters(Parameter[] parameterTypes, boolean thisAsFirstArgument) Creates an argument list from the given parameter types.
static ExpressionStatement	createPrintlnStatement(java.lang.String message)
static ExpressionStatement	createPrintlnStatement(java.lang.String message, java.lang.String variable)
static void	error(SourceUnit sourceUnit, ASTNode astNode, java.lang.String message) Generates a fatal compilation error
static void	error(SourceUnit sourceUnit, ASTNode astNode, java.lang.String message, boolean fatal) Generates a fatal compilation error
static AnnotationNode	findAnnotation(ClassNode classNode, java.lang.Class type)
static AnnotationNode	findAnnotation(ClassNode annotationClassNode, java.util.List<AnnotationNode> annotations)
static ConstructorNode	findConstructor(ClassNode classNode, Parameter[] constructorParams) Finds a constructor for the given class node and parameter types
static java.util.Map<java.lang.String,ClassNode>	getAllAssociationMap(ClassNode classNode)
static java.util.Map<java.lang.String,ClassNode>	getAssocationMap(ClassNode classNode, java.lang.String associationType) Returns a map containing the names and types of the given association type.
static java.util.Map<java.lang.String,java.util.Map<java.lang.String,Expression>>	getConstraintMetadata(ClosureExpression closureExpression) Evaluates a constraints closure and returns metadata about the constraints configured in the closure.
static ConstructorNode	getDefaultConstructor(ClassNode classNode) Obtains the default constructor for the given class node.
static java.lang.String	getFullName(ClassNode classNode) Gets the full name of a ClassNode.
static ClassNode	getFurthestParent(ClassNode classNode)
static ClassNode	getFurthestUnresolvedParent(ClassNode classNode)
static Parameter[]	getRemainingParameterTypes(Parameter[] parameters) Gets the remaining parameters excluding the first parameter in the given list
static boolean	hasAnnotation(ClassNode classNode, java.lang.Class<? extends java.lang.annotation.Annotation> annotationClass) Returns true if classNode is marked with annotationClass
static boolean	hasAnyAnnotations(ClassNode classNode, java.lang.Class<? extends java.lang.annotation.Annotation>... annotationsToLookFor)
static boolean	hasOrInheritsProperty(ClassNode classNode, java.lang.String propertyName)
static boolean	hasProperty(ClassNode classNode, java.lang.String propertyName) Returns whether a classNode has the specified property or not
static boolean	implementsOrInheritsZeroArgMethod(ClassNode classNode, java.lang.String methodName, java.util.List ignoreClasses)
static boolean	implementsZeroArgMethod(ClassNode classNode, java.lang.String methodName) Tests whether the ClasNode implements the specified method name.
static boolean	isCandidateInstanceMethod(ClassNode classNode, MethodNode declaredMethod)
static boolean	isCandidateMethod(MethodNode declaredMethod)
static boolean	isConstructorMethod(MethodNode declaredMethod)
static ClassNode	nonGeneric(ClassNode type)
static boolean	parametersEqual(Parameter[] a, Parameter[] b)
static void	warning(SourceUnit sourceUnit, ASTNode node, java.lang.String warningMessage)
static void	wrapMethodBodyInTryCatchDebugStatements(MethodNode methodNode) Wraps a method body in try / catch logic that catches any errors and logs an error, but does not rethrow!

Methods inherited from class java.lang.Object

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

Field Detail

METHOD_MISSING_METHOD_NAME

public static final java.lang.String METHOD_MISSING_METHOD_NAME

See Also:

Constant Field Values

STATIC_METHOD_MISSING_METHOD_NAME

public static final java.lang.String STATIC_METHOD_MISSING_METHOD_NAME

See Also:

Constant Field Values

EQUALS_OPERATOR

public static final Token EQUALS_OPERATOR

NOT_EQUALS_OPERATOR

public static final Token NOT_EQUALS_OPERATOR

MISSING_METHOD_EXCEPTION

public static final ClassNode MISSING_METHOD_EXCEPTION

NULL_EXPRESSION

public static final ConstantExpression NULL_EXPRESSION

ASSIGNMENT_OPERATOR

public static final Token ASSIGNMENT_OPERATOR

Constructor Detail

GrailsASTUtils

public GrailsASTUtils()

Method Detail

warning

public static void warning(SourceUnit sourceUnit,
                           ASTNode node,
                           java.lang.String warningMessage)

error

public static void error(SourceUnit sourceUnit,
                         ASTNode astNode,
                         java.lang.String message)

Generates a fatal compilation error

Parameters:

sourceUnit - the SourceUnit

astNode - the ASTNode which caused the error

message - The error message

error

public static void error(SourceUnit sourceUnit,
                         ASTNode astNode,
                         java.lang.String message,
                         boolean fatal)

Generates a fatal compilation error

Parameters:

sourceUnit - the SourceUnit

astNode - the ASTNode which caused the error

message - The error message

fatal - indicates if this is a fatal error

hasProperty

public static boolean hasProperty(ClassNode classNode,
                                  java.lang.String propertyName)

Returns whether a classNode has the specified property or not

Parameters:

classNode - The ClassNode

propertyName - The name of the property

Returns:

True if the property exists in the ClassNode

hasOrInheritsProperty

public static boolean hasOrInheritsProperty(ClassNode classNode,
                                            java.lang.String propertyName)

implementsZeroArgMethod

public static boolean implementsZeroArgMethod(ClassNode classNode,
                                              java.lang.String methodName)

Tests whether the ClasNode implements the specified method name.

Parameters:

classNode - The ClassNode

methodName - The method name

Returns:

True if it does implement the method

implementsOrInheritsZeroArgMethod

public static boolean implementsOrInheritsZeroArgMethod(ClassNode classNode,
                                                        java.lang.String methodName,
                                                        java.util.List ignoreClasses)

getFullName

public static java.lang.String getFullName(ClassNode classNode)

Gets the full name of a ClassNode.

Parameters:

classNode - The class node

Returns:

The full name

getFurthestParent

public static ClassNode getFurthestParent(ClassNode classNode)

getFurthestUnresolvedParent

public static ClassNode getFurthestUnresolvedParent(ClassNode classNode)

addDelegateInstanceMethod

public static MethodNode addDelegateInstanceMethod(ClassNode classNode,
                                                   Expression delegate,
                                                   MethodNode declaredMethod)

Adds a delegate method to the target class node where the first argument is to the delegate method is 'this'. In other words a method such as foo(Object instance, String bar) would be added with a signature of foo(String) and 'this' is passed to the delegate instance

Parameters:

classNode - The class node

delegate - The expression that looks up the delegate

declaredMethod - The declared method

Returns:

The added method node or null if it couldn't be added

addDelegateInstanceMethod

public static MethodNode addDelegateInstanceMethod(ClassNode classNode,
                                                   Expression delegate,
                                                   MethodNode declaredMethod,
                                                   boolean thisAsFirstArgument)

Adds a delegate method to the target class node where the first argument is to the delegate method is 'this'. In other words a method such as foo(Object instance, String bar) would be added with a signature of foo(String) and 'this' is passed to the delegate instance

Parameters:

classNode - The class node

delegate - The expression that looks up the delegate

declaredMethod - The declared method

thisAsFirstArgument - Whether 'this' should be passed as the first argument to the method

Returns:

The added method node or null if it couldn't be added

createArgumentListFromParameters

public static ArgumentListExpression createArgumentListFromParameters(Parameter[] parameterTypes,
                                                                      boolean thisAsFirstArgument)

Creates an argument list from the given parameter types.

Parameters:

parameterTypes - The parameter types

thisAsFirstArgument - Whether to include a reference to 'this' as the first argument

Returns:

the arguments

getRemainingParameterTypes

public static Parameter[] getRemainingParameterTypes(Parameter[] parameters)

Gets the remaining parameters excluding the first parameter in the given list

Parameters:

parameters - The parameters

Returns:

A new array with the first parameter removed

addDelegateStaticMethod

public static MethodNode addDelegateStaticMethod(ClassNode classNode,
                                                 MethodNode delegateMethod)

Adds a static method call to given class node that delegates to the given method

Parameters:

classNode - The class node

delegateMethod - The delegate method

Returns:

The added method node or null if it couldn't be added

addDelegateStaticMethod

public static MethodNode addDelegateStaticMethod(Expression expression,
                                                 ClassNode classNode,
                                                 MethodNode delegateMethod)

Adds a static method to the given class node that delegates to the given method and resolves the object to invoke the method on from the given expression.

Parameters:

expression - The expression

classNode - The class node

delegateMethod - The delegate method

Returns:

The added method node or null if it couldn't be added

addDelegateConstructor

public static void addDelegateConstructor(ClassNode classNode,
                                          MethodNode constructorMethod)

Adds or modifies an existing constructor to delegate to the given static constructor method for initialization logic.

Parameters:

classNode - The class node

constructorMethod - The constructor static method

findConstructor

public static ConstructorNode findConstructor(ClassNode classNode,
                                              Parameter[] constructorParams)

Finds a constructor for the given class node and parameter types

Parameters:

classNode - The class node

constructorParams - The parameter types

Returns:

The located constructor or null

parametersEqual

public static boolean parametersEqual(Parameter[] a,
                                      Parameter[] b)

Returns:

true if the two arrays are of the same size and have the same contents

getDefaultConstructor

public static ConstructorNode getDefaultConstructor(ClassNode classNode)

Obtains the default constructor for the given class node.

Parameters:

classNode - The class node

Returns:

The default constructor or null if there isn't one

nonGeneric

public static ClassNode nonGeneric(ClassNode type)

isCandidateInstanceMethod

public static boolean isCandidateInstanceMethod(ClassNode classNode,
                                                MethodNode declaredMethod)

isCandidateMethod

public static boolean isCandidateMethod(MethodNode declaredMethod)

isConstructorMethod

public static boolean isConstructorMethod(MethodNode declaredMethod)

addDelegateInstanceMethods

public static void addDelegateInstanceMethods(ClassNode classNode,
                                              ClassNode delegateNode,
                                              Expression delegateInstance)

addDelegateInstanceMethods

public static void addDelegateInstanceMethods(ClassNode supportedSuperType,
                                              ClassNode classNode,
                                              ClassNode delegateNode,
                                              Expression delegateInstance)

addFieldIfNonExistent

public static void addFieldIfNonExistent(ClassNode classNode,
                                         ClassNode fieldType,
                                         java.lang.String fieldName)

addAnnotationIfNecessary

public static void addAnnotationIfNecessary(ClassNode classNode,
                                            java.lang.Class<Entity> entityClass)

findAnnotation

public static AnnotationNode findAnnotation(ClassNode annotationClassNode,
                                            java.util.List<AnnotationNode> annotations)

findAnnotation

public static AnnotationNode findAnnotation(ClassNode classNode,
                                            java.lang.Class type)

hasAnnotation

public static boolean hasAnnotation(ClassNode classNode,
                                    java.lang.Class<? extends java.lang.annotation.Annotation> annotationClass)

Returns true if classNode is marked with annotationClass

Parameters:

classNode - A ClassNode to inspect

annotationClass - an annotation to look for

Returns:

true if classNode is marked with annotationClass, otherwise false

hasAnyAnnotations

public static boolean hasAnyAnnotations(ClassNode classNode,
                                        java.lang.Class<? extends java.lang.annotation.Annotation>... annotationsToLookFor)

Parameters:

classNode - a ClassNode to search

annotationsToLookFor - Annotations to look for

Returns:

true if classNode is marked with any of the annotations in annotationsToLookFor

addMethodIfNotPresent

public static void addMethodIfNotPresent(ClassNode controllerClassNode,
                                         MethodNode methodNode)

createPrintlnStatement

public static ExpressionStatement createPrintlnStatement(java.lang.String message)

createPrintlnStatement

public static ExpressionStatement createPrintlnStatement(java.lang.String message,
                                                         java.lang.String variable)

wrapMethodBodyInTryCatchDebugStatements

public static void wrapMethodBodyInTryCatchDebugStatements(MethodNode methodNode)

Wraps a method body in try / catch logic that catches any errors and logs an error, but does not rethrow!

Parameters:

methodNode - The method node

getConstraintMetadata

public static java.util.Map<java.lang.String,java.util.Map<java.lang.String,Expression>> getConstraintMetadata(ClosureExpression closureExpression)

Evaluates a constraints closure and returns metadata about the constraints configured in the closure. The Map returned has property names as keys and the value associated with each of those property names is a Map which has constraint names as keys and the Expression associated with that constraint as values

Parameters:

closureExpression - the closure expression to evaluate

Returns:

the Map as described above

getAssocationMap

public static java.util.Map<java.lang.String,ClassNode> getAssocationMap(ClassNode classNode,
                                                                         java.lang.String associationType)

Returns a map containing the names and types of the given association type. eg. GrailsDomainClassProperty.HAS_MANY

Parameters:

classNode - The target class ndoe

associationType - The associationType

Returns:

A map

getAllAssociationMap

public static java.util.Map<java.lang.String,ClassNode> getAllAssociationMap(ClassNode classNode)