AbstractCacheTransformation (Grace Framework

org.grails.cache.compiler.AbstractCacheTransformation

All Implemented Interfaces and Traits:

Ordered
```
@CompileStatic
abstract class AbstractCacheTransformation
extends AbstractMethodDecoratingTransformation
implements Ordered
```
Abstract implementation for implementers of cache annotations
Authors:
Graeme Rocher
Jeff Brown
Michael Yan
Since:
2024.0.0

Nested Class Summary

Nested classes
Modifiers	Name	Description
`class`	`AbstractCacheTransformation.1`

Field Summary

Fields
Modifiers	Name	Description
`static String`	`CACHE_KEY_LOCAL_VARIABLE_NAME`
`static String`	`CACHE_ORIGINAL_METHOD_RETURN_VALUE_LOCAL_VARIABLE_NAME`
`static String`	`CACHE_VARIABLE_LOCAL_VARIABLE_NAME`
`static String`	`GRAILS_CACHE_KEY_GENERATOR_PROPERTY_NAME`
`static String`	`GRAILS_CACHE_MANAGER_PROPERTY_NAME`
`static String`	`METHOD_PARAMETER_MAP_LOCAL_VARIABLE_NAME`
`static String`	`METHOD_PREFIX`
`static int`	`POSITION`	The position of the transform.

Constructor Summary

Constructors
Constructor and description
`AbstractCacheTransformation()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`protected VariableExpression`	`declareAndInitializeParameterValueMap(AnnotationNode annotationNode, MethodNode methodToCache, BlockStatement codeBlock)`
	`protected VariableExpression`	`declareCache(AnnotationNode annotationNode, VariableExpression cacheManagerVariableExpression, BlockStatement cacheBlock)`
	`protected VariableExpression`	`declareCacheKey(SourceUnit sourceUnit, AnnotationNode annotationNode, ClassNode classNode, MethodNode methodNode, BlockStatement cacheBlock)`
	`protected void`	`enhanceClassNode(SourceUnit sourceUnit, AnnotationNode annotationNode, ClassNode classNode)`
	`protected Object`	`getAppliedMarker()`
	`int`	`getOrder()`
	`protected String`	`getRenamedMethodPrefix()`
	`protected void`	`handleCacheCondition(SourceUnit sourceUnit, AnnotationNode annotationNode, MethodNode methodNode, MethodCallExpression originalMethodCallExpr, BlockStatement newMethodBody)`
	`protected void`	`makeClosureParameterAware(SourceUnit sourceUnit, MethodNode method, ClosureExpression closureExpression)`

- Field Detail
  - public static final String CACHE_KEY_LOCAL_VARIABLE_NAME
  - public static final String CACHE_ORIGINAL_METHOD_RETURN_VALUE_LOCAL_VARIABLE_NAME
  - public static final String CACHE_VARIABLE_LOCAL_VARIABLE_NAME
  - public static final String GRAILS_CACHE_KEY_GENERATOR_PROPERTY_NAME
  - public static final String GRAILS_CACHE_MANAGER_PROPERTY_NAME
  - public static final String METHOD_PARAMETER_MAP_LOCAL_VARIABLE_NAME
  - public static final String METHOD_PREFIX
  - public static final int POSITION
    
    The position of the transform. Before the transactional transform
- Constructor Detail
  - AbstractCacheTransformation()
- Method Detail
  - protected VariableExpression declareAndInitializeParameterValueMap(AnnotationNode annotationNode, MethodNode methodToCache, BlockStatement codeBlock)
  - protected VariableExpression declareCache(AnnotationNode annotationNode, VariableExpression cacheManagerVariableExpression, BlockStatement cacheBlock)
  - protected VariableExpression declareCacheKey(SourceUnit sourceUnit, AnnotationNode annotationNode, ClassNode classNode, MethodNode methodNode, BlockStatement cacheBlock)
  - @Override
    protected void enhanceClassNode(SourceUnit sourceUnit, AnnotationNode annotationNode, ClassNode classNode)
  - @Override
    protected Object getAppliedMarker()
  - @Override
    int getOrder()
  - @Override
    protected String getRenamedMethodPrefix()
  - protected void handleCacheCondition(SourceUnit sourceUnit, AnnotationNode annotationNode, MethodNode methodNode, MethodCallExpression originalMethodCallExpr, BlockStatement newMethodBody)
  - protected void makeClosureParameterAware(SourceUnit sourceUnit, MethodNode method, ClosureExpression closureExpression)

| Detail:
Field
Constructor
Method

[Groovy] Class AbstractCacheTransformation

Nested Class Summary

Field Summary

Constructor Summary

Methods Summary

Field Detail

public static final String CACHE_KEY_LOCAL_VARIABLE_NAME

public static final String CACHE_ORIGINAL_METHOD_RETURN_VALUE_LOCAL_VARIABLE_NAME

public static final String CACHE_VARIABLE_LOCAL_VARIABLE_NAME

public static final String GRAILS_CACHE_KEY_GENERATOR_PROPERTY_NAME

public static final String GRAILS_CACHE_MANAGER_PROPERTY_NAME

public static final String METHOD_PARAMETER_MAP_LOCAL_VARIABLE_NAME

public static final String METHOD_PREFIX

public static final int POSITION

Constructor Detail

AbstractCacheTransformation()

Method Detail

protected VariableExpression declareAndInitializeParameterValueMap(AnnotationNode annotationNode, MethodNode methodToCache, BlockStatement codeBlock)

protected VariableExpression declareCache(AnnotationNode annotationNode, VariableExpression cacheManagerVariableExpression, BlockStatement cacheBlock)

protected VariableExpression declareCacheKey(SourceUnit sourceUnit, AnnotationNode annotationNode, ClassNode classNode, MethodNode methodNode, BlockStatement cacheBlock)

@Override
protected void enhanceClassNode(SourceUnit sourceUnit, AnnotationNode annotationNode, ClassNode classNode)

@Override
protected Object getAppliedMarker()

@Override
int getOrder()

@Override
protected String getRenamedMethodPrefix()

protected void handleCacheCondition(SourceUnit sourceUnit, AnnotationNode annotationNode, MethodNode methodNode, MethodCallExpression originalMethodCallExpr, BlockStatement newMethodBody)

protected void makeClosureParameterAware(SourceUnit sourceUnit, MethodNode method, ClosureExpression closureExpression)

[Groovy] Class AbstractCacheTransformation

Nested Class Summary

Field Summary

Constructor Summary

Methods Summary

Field Detail

public static final String CACHE_KEY_LOCAL_VARIABLE_NAME

public static final String CACHE_ORIGINAL_METHOD_RETURN_VALUE_LOCAL_VARIABLE_NAME

public static final String CACHE_VARIABLE_LOCAL_VARIABLE_NAME

public static final String GRAILS_CACHE_KEY_GENERATOR_PROPERTY_NAME

public static final String GRAILS_CACHE_MANAGER_PROPERTY_NAME

public static final String METHOD_PARAMETER_MAP_LOCAL_VARIABLE_NAME

public static final String METHOD_PREFIX

public static final int POSITION

Constructor Detail

AbstractCacheTransformation()

Method Detail

protected VariableExpression declareAndInitializeParameterValueMap(AnnotationNode annotationNode, MethodNode methodToCache, BlockStatement codeBlock)

protected VariableExpression declareCache(AnnotationNode annotationNode, VariableExpression cacheManagerVariableExpression, BlockStatement cacheBlock)

protected VariableExpression declareCacheKey(SourceUnit sourceUnit, AnnotationNode annotationNode, ClassNode classNode, MethodNode methodNode, BlockStatement cacheBlock)

@Overrideprotected void enhanceClassNode(SourceUnit sourceUnit, AnnotationNode annotationNode, ClassNode classNode)

@Overrideprotected Object getAppliedMarker()

@Overrideint getOrder()

@Overrideprotected String getRenamedMethodPrefix()

protected void handleCacheCondition(SourceUnit sourceUnit, AnnotationNode annotationNode, MethodNode methodNode, MethodCallExpression originalMethodCallExpr, BlockStatement newMethodBody)

protected void makeClosureParameterAware(SourceUnit sourceUnit, MethodNode method, ClosureExpression closureExpression)

@Override
protected void enhanceClassNode(SourceUnit sourceUnit, AnnotationNode annotationNode, ClassNode classNode)

@Override
protected Object getAppliedMarker()

@Override
int getOrder()

@Override
protected String getRenamedMethodPrefix()