AbstractMethodDecoratingTransformation (GORM for Neo4j

org.grails.datastore.gorm.transform.AbstractMethodDecoratingTransformation

```
@groovy.transform.CompileStatic
abstract class AbstractMethodDecoratingTransformation
extends AbstractGormASTTransformation
```
An abstract implementation for transformations that decorate a method invocation such that the method invocation is wrapped in the execution of a closure that delegates to the original logic. Examples of such transformations are Transactional and CurrentTenant
Authors:
Graeme Rocher
Since:
6.1

Field Summary

Fields
Modifiers	Name	Description
`private static java.util.Set<java.lang.String>`	`ANNOTATION_NAME_EXCLUDES`
`static java.lang.String`	`DECORATED_METHODS`	Key used to store within the original method node metadata, all previous decorated methods
`private static java.util.Set<java.lang.String>`	`METHOD_NAME_EXCLUDES`

Inherited fields
Fields inherited from class	Fields
`class AbstractGormASTTransformation`	`compilationUnit`

Constructor Summary

Constructors
Constructor and description
`AbstractMethodDecoratingTransformation ()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`protected org.codehaus.groovy.ast.expr.MethodCallExpression`	`buildCallToOriginalMethod(org.codehaus.groovy.ast.ClassNode classNode, org.codehaus.groovy.ast.MethodNode renamedMethodNode)`
	`protected abstract org.codehaus.groovy.ast.expr.Expression`	`buildDelegatingMethodCall(org.codehaus.groovy.control.SourceUnit sourceUnit, org.codehaus.groovy.ast.AnnotationNode annotationNode, org.codehaus.groovy.ast.ClassNode classNode, org.codehaus.groovy.ast.MethodNode methodNode, org.codehaus.groovy.ast.expr.MethodCallExpression originalMethodCallExpr, org.codehaus.groovy.ast.stmt.BlockStatement newMethodBody)` Builds the delegating method call for the given class node
	`protected void`	`compileMethodStatically(org.codehaus.groovy.control.SourceUnit sourceUnit, org.codehaus.groovy.ast.MethodNode methodNode)`
	`protected org.codehaus.groovy.ast.stmt.Statement`	`createDelegingMethodBody(org.codehaus.groovy.ast.Parameter[] parameters, org.codehaus.groovy.ast.expr.MethodCallExpression originalMethodCall)`
	`protected void`	`enhanceClassNode(org.codehaus.groovy.control.SourceUnit sourceUnit, org.codehaus.groovy.ast.AnnotationNode annotationNode, org.codehaus.groovy.ast.ClassNode classNode)` Add any additional logic to enhance the class node
	`protected abstract java.lang.String`	`getRenamedMethodPrefix()`
	`protected boolean`	`hasExcludedAnnotation(org.codehaus.groovy.ast.MethodNode md)`
	`protected boolean`	`hasExcludedAnnotation(org.codehaus.groovy.ast.MethodNode md, java.util.Set<java.lang.String> excludes)`
	`protected boolean`	`isTestSetupOrCleanup(org.codehaus.groovy.ast.ClassNode classNode, org.codehaus.groovy.ast.MethodNode md)`
	`protected org.codehaus.groovy.ast.expr.MethodCallExpression`	`makeDelegatingClosureCall(org.codehaus.groovy.ast.expr.Expression targetObject, java.lang.String executeMethodName, org.codehaus.groovy.ast.Parameter[] closureParameters, org.codehaus.groovy.ast.expr.MethodCallExpression originalMethodCall, org.codehaus.groovy.ast.VariableScope variableScope)` Construct a method call that wraps an original call with a closure invocation
	`protected org.codehaus.groovy.ast.expr.MethodCallExpression`	`makeDelegatingClosureCall(org.codehaus.groovy.ast.expr.Expression targetObject, java.lang.String executeMethodName, org.codehaus.groovy.ast.expr.ArgumentListExpression arguments, org.codehaus.groovy.ast.Parameter[] closureParameters, org.codehaus.groovy.ast.expr.MethodCallExpression originalMethodCall, org.codehaus.groovy.ast.VariableScope variableScope)` Construct a method call that wraps an original call with a closure invocation
	`protected org.codehaus.groovy.ast.MethodNode`	`moveOriginalCodeToNewMethod(org.codehaus.groovy.ast.MethodNode methodNode, java.lang.String renamedMethodName, org.codehaus.groovy.ast.Parameter[] newParameters, org.codehaus.groovy.ast.ClassNode classNode, org.codehaus.groovy.control.SourceUnit source, java.util.Map<java.lang.String, org.codehaus.groovy.ast.ClassNode> genericsSpec)`
	`protected org.codehaus.groovy.ast.Parameter[]`	`prepareNewMethodParameters(org.codehaus.groovy.ast.MethodNode methodNode, java.util.Map<java.lang.String, org.codehaus.groovy.ast.ClassNode> genericsSpec, org.codehaus.groovy.ast.ClassNode classNode)`
	`protected org.codehaus.groovy.ast.ClassNode`	`resolveReturnTypeForNewMethod(org.codehaus.groovy.ast.MethodNode methodNode)`
	`void`	`visit(org.codehaus.groovy.control.SourceUnit source, org.codehaus.groovy.ast.AnnotationNode annotationNode, org.codehaus.groovy.ast.AnnotatedNode annotatedNode)`
	`protected void`	`weaveClassNode(org.codehaus.groovy.control.SourceUnit source, org.codehaus.groovy.ast.AnnotationNode annotationNode, org.codehaus.groovy.ast.ClassNode classNode)`
	`protected org.codehaus.groovy.ast.MethodNode`	`weaveNewMethod(org.codehaus.groovy.control.SourceUnit sourceUnit, org.codehaus.groovy.ast.AnnotationNode annotationNode, org.codehaus.groovy.ast.ClassNode classNode, org.codehaus.groovy.ast.MethodNode methodNode, java.util.Map<java.lang.String, org.codehaus.groovy.ast.ClassNode> genericsSpec)` Weaves a new method
	`protected void`	`weaveTestSetupMethod(org.codehaus.groovy.control.SourceUnit sourceUnit, org.codehaus.groovy.ast.AnnotationNode annotationNode, org.codehaus.groovy.ast.ClassNode classNode, org.codehaus.groovy.ast.MethodNode methodNode, java.util.Map<java.lang.String, org.codehaus.groovy.ast.ClassNode> genericsSpec)`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class AbstractGormASTTransformation`	`getAnnotationType, getAppliedMarker, isValidAnnotation, visit, visit`

- Field Detail
  - private static final java.util.Set<java.lang.String> ANNOTATION_NAME_EXCLUDES
  - public static final java.lang.String DECORATED_METHODS
    
    Key used to store within the original method node metadata, all previous decorated methods
  - private static final java.util.Set<java.lang.String> METHOD_NAME_EXCLUDES
- Constructor Detail
  - AbstractMethodDecoratingTransformation()
- Method Detail
  - protected org.codehaus.groovy.ast.expr.MethodCallExpression buildCallToOriginalMethod(org.codehaus.groovy.ast.ClassNode classNode, org.codehaus.groovy.ast.MethodNode renamedMethodNode)
  - protected abstract org.codehaus.groovy.ast.expr.Expression buildDelegatingMethodCall(org.codehaus.groovy.control.SourceUnit sourceUnit, org.codehaus.groovy.ast.AnnotationNode annotationNode, org.codehaus.groovy.ast.ClassNode classNode, org.codehaus.groovy.ast.MethodNode methodNode, org.codehaus.groovy.ast.expr.MethodCallExpression originalMethodCallExpr, org.codehaus.groovy.ast.stmt.BlockStatement newMethodBody)
    
    Builds the delegating method call for the given class node
    Parameters:
    sourceUnit - The source unit
    annotationNode - The annotation node
    classNode - The class node
    methodNode - The original method node
    originalMethodCallExpr - The method call expression that invokes the original logic
    newMethodBody - The new method body
    Returns:
    The expression that will make up the body of the new method
  - protected void compileMethodStatically(org.codehaus.groovy.control.SourceUnit sourceUnit, org.codehaus.groovy.ast.MethodNode methodNode)
  - protected org.codehaus.groovy.ast.stmt.Statement createDelegingMethodBody(org.codehaus.groovy.ast.Parameter[] parameters, org.codehaus.groovy.ast.expr.MethodCallExpression originalMethodCall)
  - protected void enhanceClassNode(org.codehaus.groovy.control.SourceUnit sourceUnit, org.codehaus.groovy.ast.AnnotationNode annotationNode, org.codehaus.groovy.ast.ClassNode classNode)
    
    Add any additional logic to enhance the class node
    Parameters:
    sourceUnit - The source unit
    annotationNode - The annotation node
    classNode - The class node
  - protected abstract java.lang.String getRenamedMethodPrefix()
  - protected boolean hasExcludedAnnotation(org.codehaus.groovy.ast.MethodNode md)
  - protected boolean hasExcludedAnnotation(org.codehaus.groovy.ast.MethodNode md, java.util.Set<java.lang.String> excludes)
  - protected boolean isTestSetupOrCleanup(org.codehaus.groovy.ast.ClassNode classNode, org.codehaus.groovy.ast.MethodNode md)
  - protected org.codehaus.groovy.ast.expr.MethodCallExpression makeDelegatingClosureCall(org.codehaus.groovy.ast.expr.Expression targetObject, java.lang.String executeMethodName, org.codehaus.groovy.ast.Parameter[] closureParameters, org.codehaus.groovy.ast.expr.MethodCallExpression originalMethodCall, org.codehaus.groovy.ast.VariableScope variableScope)
    
    Construct a method call that wraps an original call with a closure invocation
    Parameters:
    targetObject - The target object
    executeMethodName - The method that accepts a closure
    closureParameters - The parameters for the closure
    originalMethodCall - The original method call to delegate to
    Returns:
    The MethodCallExpression
  - protected org.codehaus.groovy.ast.expr.MethodCallExpression makeDelegatingClosureCall(org.codehaus.groovy.ast.expr.Expression targetObject, java.lang.String executeMethodName, org.codehaus.groovy.ast.expr.ArgumentListExpression arguments, org.codehaus.groovy.ast.Parameter[] closureParameters, org.codehaus.groovy.ast.expr.MethodCallExpression originalMethodCall, org.codehaus.groovy.ast.VariableScope variableScope)
    
    Construct a method call that wraps an original call with a closure invocation
    Parameters:
    targetObject - The target object
    executeMethodName - The method that accepts a closure
    closureParameters - The parameters for the closure
    originalMethodCall - The original method call to delegate to
    Returns:
    The MethodCallExpression
  - protected org.codehaus.groovy.ast.MethodNode moveOriginalCodeToNewMethod(org.codehaus.groovy.ast.MethodNode methodNode, java.lang.String renamedMethodName, org.codehaus.groovy.ast.Parameter[] newParameters, org.codehaus.groovy.ast.ClassNode classNode, org.codehaus.groovy.control.SourceUnit source, java.util.Map<java.lang.String, org.codehaus.groovy.ast.ClassNode> genericsSpec)
  - protected org.codehaus.groovy.ast.Parameter[] prepareNewMethodParameters(org.codehaus.groovy.ast.MethodNode methodNode, java.util.Map<java.lang.String, org.codehaus.groovy.ast.ClassNode> genericsSpec, org.codehaus.groovy.ast.ClassNode classNode)
  - protected org.codehaus.groovy.ast.ClassNode resolveReturnTypeForNewMethod(org.codehaus.groovy.ast.MethodNode methodNode)
  - @java.lang.Override void visit(org.codehaus.groovy.control.SourceUnit source, org.codehaus.groovy.ast.AnnotationNode annotationNode, org.codehaus.groovy.ast.AnnotatedNode annotatedNode)
  - protected void weaveClassNode(org.codehaus.groovy.control.SourceUnit source, org.codehaus.groovy.ast.AnnotationNode annotationNode, org.codehaus.groovy.ast.ClassNode classNode)
  - protected org.codehaus.groovy.ast.MethodNode weaveNewMethod(org.codehaus.groovy.control.SourceUnit sourceUnit, org.codehaus.groovy.ast.AnnotationNode annotationNode, org.codehaus.groovy.ast.ClassNode classNode, org.codehaus.groovy.ast.MethodNode methodNode, java.util.Map<java.lang.String, org.codehaus.groovy.ast.ClassNode> genericsSpec)
    
    Weaves a new method
    Parameters:
    sourceUnit - The source unit
    annotationNode - The annotation node
    classNode - The class node
    methodNode - The original method that will delete to the new method
    Returns:
    The new method's body
  - protected void weaveTestSetupMethod(org.codehaus.groovy.control.SourceUnit sourceUnit, org.codehaus.groovy.ast.AnnotationNode annotationNode, org.codehaus.groovy.ast.ClassNode classNode, org.codehaus.groovy.ast.MethodNode methodNode, java.util.Map<java.lang.String, org.codehaus.groovy.ast.ClassNode> genericsSpec)

Summary:
Field
Constructor
Method

| Detail:
Field
Constructor
Method

Groovy Documentation

[Groovy] Class AbstractMethodDecoratingTransformation

Field Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

private static final java.util.Set<java.lang.String> ANNOTATION_NAME_EXCLUDES

public static final java.lang.String DECORATED_METHODS

private static final java.util.Set<java.lang.String> METHOD_NAME_EXCLUDES

Constructor Detail

AbstractMethodDecoratingTransformation()

Method Detail

protected org.codehaus.groovy.ast.expr.MethodCallExpression buildCallToOriginalMethod(org.codehaus.groovy.ast.ClassNode classNode, org.codehaus.groovy.ast.MethodNode renamedMethodNode)

protected void compileMethodStatically(org.codehaus.groovy.control.SourceUnit sourceUnit, org.codehaus.groovy.ast.MethodNode methodNode)

protected org.codehaus.groovy.ast.stmt.Statement createDelegingMethodBody(org.codehaus.groovy.ast.Parameter[] parameters, org.codehaus.groovy.ast.expr.MethodCallExpression originalMethodCall)

protected void enhanceClassNode(org.codehaus.groovy.control.SourceUnit sourceUnit, org.codehaus.groovy.ast.AnnotationNode annotationNode, org.codehaus.groovy.ast.ClassNode classNode)

protected abstract java.lang.String getRenamedMethodPrefix()

protected boolean hasExcludedAnnotation(org.codehaus.groovy.ast.MethodNode md)

protected boolean hasExcludedAnnotation(org.codehaus.groovy.ast.MethodNode md, java.util.Set<java.lang.String> excludes)

protected boolean isTestSetupOrCleanup(org.codehaus.groovy.ast.ClassNode classNode, org.codehaus.groovy.ast.MethodNode md)

protected org.codehaus.groovy.ast.Parameter[] prepareNewMethodParameters(org.codehaus.groovy.ast.MethodNode methodNode, java.util.Map<java.lang.String, org.codehaus.groovy.ast.ClassNode> genericsSpec, org.codehaus.groovy.ast.ClassNode classNode)

protected org.codehaus.groovy.ast.ClassNode resolveReturnTypeForNewMethod(org.codehaus.groovy.ast.MethodNode methodNode)

@java.lang.Override void visit(org.codehaus.groovy.control.SourceUnit source, org.codehaus.groovy.ast.AnnotationNode annotationNode, org.codehaus.groovy.ast.AnnotatedNode annotatedNode)

protected void weaveClassNode(org.codehaus.groovy.control.SourceUnit source, org.codehaus.groovy.ast.AnnotationNode annotationNode, org.codehaus.groovy.ast.ClassNode classNode)