AbstractGrailsArtefactTransformer (Grace Framework

org.grails.compiler.injection.AbstractGrailsArtefactTransformer

All Implemented Interfaces and Traits:

AnnotatedClassInjector, GrailsArtefactClassInjector, Comparable
```
@SuppressWarnings("rawtypes")
public abstract class AbstractGrailsArtefactTransformer
extends Object
implements AnnotatedClassInjector, GrailsArtefactClassInjector, Comparable
```
Abstract transformer that takes an implementation class and creates methods in a target ClassNode that delegate to that implementation class. Subclasses should override to provide the implementation class details
Since:
2.0
Authors:
Graeme Rocher

Field Summary

Fields
Modifiers	Name	Description
`static String`	`CURRENT_PREFIX`
`static String`	`METHOD_MISSING_METHOD_NAME`
`protected static ClassNode`	`OBJECT_CLASS`
`static int`	`PUBLIC_STATIC_MODIFIER`
`static String`	`STATIC_METHOD_MISSING_METHOD_NAME`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`protected void`	`addApiLookupFieldAndSetter(ClassNode classNode, ClassNode implementationNode, String apiProperty, Expression initialValueExpression)`
	`protected void`	`addDelegateInstanceMethod(ClassNode classNode, Expression delegate, MethodNode declaredMethod, AnnotationNode markerAnnotation, Map<String, ClassNode> genericsPlaceholders)`
	`protected void`	`addDelegateStaticMethod(ClassNode classNode, MethodCallExpression apiLookupMethod, MethodNode declaredMethod, Map<String, ClassNode> genericsPlaceholders)`
	`protected void`	`addEnhancedAnnotation(ClassNode classNode)`
	`public static void`	`addToTransformedClasses(String name)`
	`public void`	`clearCachedState()`
	`public int`	`compareTo(Object o)` Used for ordering not equality.
	`protected String`	`getArtefactType()`
	`public String[]`	`getArtefactTypes()`
	`public abstract Class`	`getInstanceImplementation()` The class that provides the implementation of all instance methods and properties
	`protected AnnotationNode`	`getMarkerAnnotation()` A marker annotation to be applied to added methods, defaults to null
	`public abstract Class`	`getStaticImplementation()` The class that provides static methods
	`public static Collection<String>`	`getTransformedClassNames()`
	`protected boolean`	`hasArtefactAnnotation(ClassNode classNode)`
	`protected boolean`	`isCandidateInstanceMethod(ClassNode classNode, MethodNode declaredMethod)`
	`protected boolean`	`isStaticCandidateMethod(ClassNode classNode, MethodNode declaredMethod)`
	`protected boolean`	`isStaticMethodExcluded(ClassNode classNode, MethodNode declaredMethod)`
	`protected boolean`	`isStaticMethodIncluded(ClassNode classNode, MethodNode declaredMethod)`
	`protected boolean`	`isValidArtefactType()`
	`protected boolean`	`isValidTargetClassNode(ClassNode classNode)`
	`public void`	`performInjection(SourceUnit source, GeneratorContext context, ClassNode classNode)`
	`public void`	`performInjection(SourceUnit source, ClassNode classNode)`
	`protected void`	`performInjectionInternal(String apiInstanceProperty, SourceUnit source, ClassNode classNode)` Subclasses can override to provide additional transformation
	`public void`	`performInjectionOnAnnotatedClass(SourceUnit source, ClassNode classNode)`
	`public void`	`performInjectionOnAnnotatedClass(SourceUnit source, GeneratorContext context, ClassNode classNode)`
	`protected void`	`performInstanceImplementationInjection(SourceUnit source, ClassNode classNode, Map<String, ClassNode> genericsPlaceholders, Class instanceImplementation)`
	`protected void`	`performStaticImplementationInjection(ClassNode classNode, Map<String, ClassNode> genericsPlaceholders, Class staticImplementation)`
	`protected MethodNode`	`populateAutowiredApiLookupMethod(ClassNode classNode, ClassNode implementationNode, String apiProperty, String methodName, BlockStatement methodBody)`
	`protected MethodNode`	`populateDefaultApiLookupMethod(ClassNode implementationNode, String apiInstanceProperty, String methodName, BlockStatement methodBody)`
	`protected boolean`	`requiresAutowiring()` If the API requires autowiring then a Autowired: property will be added.
	`protected boolean`	`requiresStaticLookupMethod()` Subclasses should override in the instance API requires a static lookup method instead of autowiring.
	`protected Map<String, ClassNode>`	`resolveGenericsPlaceHolders(ClassNode classNode)`
	`protected boolean`	`shouldSkipInjection(ClassNode classNode)`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Object`	`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- Field Detail
  - public static final String CURRENT_PREFIX
  - public static final String METHOD_MISSING_METHOD_NAME
  - protected static final ClassNode OBJECT_CLASS
  - public static final int PUBLIC_STATIC_MODIFIER
  - public static final String STATIC_METHOD_MISSING_METHOD_NAME
- Method Detail
  - protected void addApiLookupFieldAndSetter(ClassNode classNode, ClassNode implementationNode, String apiProperty, Expression initialValueExpression)
  - protected void addDelegateInstanceMethod(ClassNode classNode, Expression delegate, MethodNode declaredMethod, AnnotationNode markerAnnotation, Map<String, ClassNode> genericsPlaceholders)
  - protected void addDelegateStaticMethod(ClassNode classNode, MethodCallExpression apiLookupMethod, MethodNode declaredMethod, Map<String, ClassNode> genericsPlaceholders)
  - protected void addEnhancedAnnotation(ClassNode classNode)
  - public static void addToTransformedClasses(String name)
  - public void clearCachedState()
  - public int compareTo(Object o)
    
    Used for ordering not equality. Note: this class has a natural ordering that is inconsistent with equals.
    See Also:
    Comparable.compareTo
  - protected String getArtefactType()
  - public String[] getArtefactTypes()
  - public abstract Class getInstanceImplementation()
    
    The class that provides the implementation of all instance methods and properties
    Returns:
    A class whose methods contain a first argument of type object that is the instance
  - protected AnnotationNode getMarkerAnnotation()
    
    A marker annotation to be applied to added methods, defaults to null
    Returns:
    The annotation node
  - public abstract Class getStaticImplementation()
    
    The class that provides static methods
    Returns:
    A class or null if non is provided
  - public static Collection<String> getTransformedClassNames()
  - protected boolean hasArtefactAnnotation(ClassNode classNode)
  - protected boolean isCandidateInstanceMethod(ClassNode classNode, MethodNode declaredMethod)
  - protected boolean isStaticCandidateMethod(ClassNode classNode, MethodNode declaredMethod)
  - protected boolean isStaticMethodExcluded(ClassNode classNode, MethodNode declaredMethod)
  - protected boolean isStaticMethodIncluded(ClassNode classNode, MethodNode declaredMethod)
  - protected boolean isValidArtefactType()
  - protected boolean isValidTargetClassNode(ClassNode classNode)
  - public void performInjection(SourceUnit source, GeneratorContext context, ClassNode classNode)
  - public void performInjection(SourceUnit source, ClassNode classNode)
  - protected void performInjectionInternal(String apiInstanceProperty, SourceUnit source, ClassNode classNode)
    
    Subclasses can override to provide additional transformation
    Parameters:
    apiInstanceProperty
    source - The source
    classNode - The class node
  - @Override
    public void performInjectionOnAnnotatedClass(SourceUnit source, ClassNode classNode)
  - public void performInjectionOnAnnotatedClass(SourceUnit source, GeneratorContext context, ClassNode classNode)
  - protected void performInstanceImplementationInjection(SourceUnit source, ClassNode classNode, Map<String, ClassNode> genericsPlaceholders, Class instanceImplementation)
  - protected void performStaticImplementationInjection(ClassNode classNode, Map<String, ClassNode> genericsPlaceholders, Class staticImplementation)
  - protected MethodNode populateAutowiredApiLookupMethod(ClassNode classNode, ClassNode implementationNode, String apiProperty, String methodName, BlockStatement methodBody)
  - protected MethodNode populateDefaultApiLookupMethod(ClassNode implementationNode, String apiInstanceProperty, String methodName, BlockStatement methodBody)
  - protected boolean requiresAutowiring()
    
    If the API requires autowiring then a
    Autowired:
    property will be added. If not a private field that instantiates the API will be crated. Defaults to true.
    
    Returns:
    Whether autowiring is required
  - protected boolean requiresStaticLookupMethod()
    
    Subclasses should override in the instance API requires a static lookup method instead of autowiring. Defaults to false.
    Returns:
    Whether a static lookup method is used for the instance API
  - protected Map<String, ClassNode> resolveGenericsPlaceHolders(ClassNode classNode)
  - protected boolean shouldSkipInjection(ClassNode classNode)

Summary:
Field
Method

| Detail:
Field
Method

[Java] Class AbstractGrailsArtefactTransformer

Field Summary

Methods Summary

Inherited Methods Summary

Field Detail

public static final String CURRENT_PREFIX

public static final String METHOD_MISSING_METHOD_NAME

protected static final ClassNode OBJECT_CLASS

public static final int PUBLIC_STATIC_MODIFIER

public static final String STATIC_METHOD_MISSING_METHOD_NAME

Method Detail

protected void addApiLookupFieldAndSetter(ClassNode classNode, ClassNode implementationNode, String apiProperty, Expression initialValueExpression)

protected void addDelegateInstanceMethod(ClassNode classNode, Expression delegate, MethodNode declaredMethod, AnnotationNode markerAnnotation, Map<String, ClassNode> genericsPlaceholders)

protected void addDelegateStaticMethod(ClassNode classNode, MethodCallExpression apiLookupMethod, MethodNode declaredMethod, Map<String, ClassNode> genericsPlaceholders)

protected void addEnhancedAnnotation(ClassNode classNode)

public static void addToTransformedClasses(String name)

public void clearCachedState()

public int compareTo(Object o)

protected String getArtefactType()

public String[] getArtefactTypes()

public abstract Class getInstanceImplementation()

protected AnnotationNode getMarkerAnnotation()

public abstract Class getStaticImplementation()

public static Collection<String> getTransformedClassNames()

protected boolean hasArtefactAnnotation(ClassNode classNode)

protected boolean isCandidateInstanceMethod(ClassNode classNode, MethodNode declaredMethod)

protected boolean isStaticCandidateMethod(ClassNode classNode, MethodNode declaredMethod)

protected boolean isStaticMethodExcluded(ClassNode classNode, MethodNode declaredMethod)

protected boolean isStaticMethodIncluded(ClassNode classNode, MethodNode declaredMethod)

protected boolean isValidArtefactType()

protected boolean isValidTargetClassNode(ClassNode classNode)

public void performInjection(SourceUnit source, GeneratorContext context, ClassNode classNode)

public void performInjection(SourceUnit source, ClassNode classNode)

protected void performInjectionInternal(String apiInstanceProperty, SourceUnit source, ClassNode classNode)

@Overridepublic void performInjectionOnAnnotatedClass(SourceUnit source, ClassNode classNode)

public void performInjectionOnAnnotatedClass(SourceUnit source, GeneratorContext context, ClassNode classNode)

protected void performInstanceImplementationInjection(SourceUnit source, ClassNode classNode, Map<String, ClassNode> genericsPlaceholders, Class instanceImplementation)

protected void performStaticImplementationInjection(ClassNode classNode, Map<String, ClassNode> genericsPlaceholders, Class staticImplementation)

protected MethodNode populateAutowiredApiLookupMethod(ClassNode classNode, ClassNode implementationNode, String apiProperty, String methodName, BlockStatement methodBody)

protected MethodNode populateDefaultApiLookupMethod(ClassNode implementationNode, String apiInstanceProperty, String methodName, BlockStatement methodBody)

protected boolean requiresAutowiring()

protected boolean requiresStaticLookupMethod()

protected Map<String, ClassNode> resolveGenericsPlaceHolders(ClassNode classNode)

protected boolean shouldSkipInjection(ClassNode classNode)

@Override
public void performInjectionOnAnnotatedClass(SourceUnit source, ClassNode classNode)