AstUtils (GORM for Hibernate 5

org.grails.datastore.mapping.reflect.AstUtils

Utility methods for dealing with Groovy ASTs
Authors:
Graeme Rocher
Since:
5.0

Field Summary

Fields
Modifiers	Name	Description
`static java.util.regex.Pattern`	`DOMAIN_PATH_PATTERN`
`static java.lang.String`	`DOMAIN_TYPE`
`static java.lang.String`	`GRAILS_APP_DIR`	The name of the Grails application directory
`static org.codehaus.groovy.ast.ClassNode`	`OBJECT_CLASS_NODE`
`static java.lang.String`	`REGEX_FILE_SEPARATOR`
`static java.lang.Object`	`TRANSFORM_APPLIED_MARKER`
`static org.codehaus.groovy.ast.expr.ArgumentListExpression`	`ZERO_ARGUMENTS`
`static org.codehaus.groovy.ast.Parameter[]`	`ZERO_PARAMETERS`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`static void`	`addAnnotationIfNecessary(org.codehaus.groovy.ast.ClassNode classNode, java.lang.Class<? extends java.lang.annotation.Annotation> annotationClass)` Adds an annotation to the give nclass node if it doesn't already exist
	`static org.codehaus.groovy.ast.AnnotationNode`	`addAnnotationOrGetExisting(org.codehaus.groovy.ast.ClassNode classNode, java.lang.Class<? extends java.lang.annotation.Annotation> annotationClass)` Adds an annotation to the given class node or returns the existing annotation
	`static org.codehaus.groovy.ast.AnnotationNode`	`addAnnotationOrGetExisting(org.codehaus.groovy.ast.ClassNode classNode, java.lang.Class<? extends java.lang.annotation.Annotation> annotationClass, java.util.Map<java.lang.String, java.lang.Object> members)` Adds an annotation to the given class node or returns the existing annotation
	`static org.codehaus.groovy.ast.AnnotationNode`	`addAnnotationOrGetExisting(org.codehaus.groovy.ast.ClassNode classNode, org.codehaus.groovy.ast.ClassNode annotationClassNode)`
	`static org.codehaus.groovy.ast.AnnotationNode`	`addAnnotationOrGetExisting(org.codehaus.groovy.ast.ClassNode classNode, org.codehaus.groovy.ast.ClassNode annotationClassNode, java.util.Map<java.lang.String, java.lang.Object> members)`
	`static void`	`addTransformedEntityName(java.lang.String name)` @param name Adds the name of a transformed entity
	`static org.codehaus.groovy.ast.AnnotationNode`	`cloneAnnotation(org.codehaus.groovy.ast.AnnotationNode node)`
	`static void`	`copyAnnotations(org.codehaus.groovy.ast.AnnotatedNode from, org.codehaus.groovy.ast.AnnotatedNode to)`
	`static void`	`copyAnnotations(org.codehaus.groovy.ast.AnnotatedNode from, org.codehaus.groovy.ast.AnnotatedNode to, java.util.Set<java.lang.String> included, java.util.Set<java.lang.String> excluded)`
	`static org.codehaus.groovy.ast.Parameter[]`	`copyParameters(org.codehaus.groovy.ast.Parameter[] parameterTypes)`
	`static org.codehaus.groovy.ast.Parameter[]`	`copyParameters(org.codehaus.groovy.ast.Parameter[] parameterTypes, java.util.Map<java.lang.String, org.codehaus.groovy.ast.ClassNode> genericsPlaceholders)`
	`static org.codehaus.groovy.ast.Parameter[]`	`copyParameters(java.util.Map<java.lang.String, org.codehaus.groovy.ast.ClassNode> genericsSpec, org.codehaus.groovy.ast.Parameter[] parameterTypes, java.util.List<java.lang.String> currentMethodGenPlaceholders)`
	`static org.codehaus.groovy.ast.AnnotationNode`	`findAnnotation(org.codehaus.groovy.ast.ClassNode classNode, java.lang.Class<?> type)`
	`static org.codehaus.groovy.ast.AnnotationNode`	`findAnnotation(org.codehaus.groovy.ast.ClassNode annotationClassNode, java.util.List<org.codehaus.groovy.ast.AnnotationNode> annotations)`
	`static org.codehaus.groovy.ast.ClassNode`	`findInterface(org.codehaus.groovy.ast.ClassNode classNode, java.lang.String interfaceName)`
	`static org.codehaus.groovy.ast.ClassNode`	`getFurthestUnresolvedParent(org.codehaus.groovy.ast.ClassNode classNode)`
	`static java.util.Collection<java.lang.String>`	`getKnownEntityNames()` @return The names of the transformed entities for this context
	`static org.codehaus.groovy.ast.PropertyNode`	`getPropertyFromHierarchy(org.codehaus.groovy.ast.ClassNode cn, java.lang.String name)` Obtains a property from the class hierarchy
	`static boolean`	`hasOrInheritsProperty(org.codehaus.groovy.ast.ClassNode classNode, java.lang.String propertyName)`
	`static boolean`	`hasProperty(org.codehaus.groovy.ast.ClassNode classNode, java.lang.String propertyName)` Returns whether a classNode has the specified property or not
	`static boolean`	`implementsInterface(org.codehaus.groovy.ast.ClassNode classNode, java.lang.String interfaceName)`
	`static boolean`	`implementsOrInheritsZeroArgMethod(org.codehaus.groovy.ast.ClassNode classNode, java.lang.String methodName)`
	`static boolean`	`implementsZeroArgMethod(org.codehaus.groovy.ast.ClassNode classNode, java.lang.String methodName)` Tests whether the ClasNode implements the specified method name.
	`static void`	`injectTrait(org.codehaus.groovy.ast.ClassNode classNode, java.lang.Class traitClass)`
	`static boolean`	`isDomainClass(java.net.URL url)` Checks whether the file referenced by the given url is a domain class
	`static boolean`	`isDomainClass(org.codehaus.groovy.ast.ClassNode classNode)`
	`static boolean`	`isEnum(org.codehaus.groovy.ast.ClassNode classNode)`
	`static boolean`	`isGroovyType(org.codehaus.groovy.ast.ClassNode type)` Whether the given type is a Groovy object
	`static boolean`	`isSubclassOf(org.codehaus.groovy.ast.ClassNode classNode, java.lang.String parentClassName)` Returns true if the given class name is a parent class of the given class
	`static boolean`	`isSubclassOfOrImplementsInterface(org.codehaus.groovy.ast.ClassNode childClass, org.codehaus.groovy.ast.ClassNode superClass)`
	`static boolean`	`isSubclassOfOrImplementsInterface(org.codehaus.groovy.ast.ClassNode childClass, java.lang.String superClassName)`
	`static org.codehaus.groovy.ast.ClassNode`	`nonGeneric(org.codehaus.groovy.ast.ClassNode type)`
	`static org.codehaus.groovy.ast.ClassNode`	`nonGeneric(org.codehaus.groovy.ast.ClassNode type, org.codehaus.groovy.ast.ClassNode wildcardReplacement)`
	`static org.codehaus.groovy.ast.ClassNode`	`replaceGenericsPlaceholders(org.codehaus.groovy.ast.ClassNode type, java.util.Map<java.lang.String, org.codehaus.groovy.ast.ClassNode> genericsPlaceholders)`
	`static org.codehaus.groovy.ast.ClassNode`	`replaceGenericsPlaceholders(org.codehaus.groovy.ast.ClassNode type, java.util.Map<java.lang.String, org.codehaus.groovy.ast.ClassNode> genericsPlaceholders, org.codehaus.groovy.ast.ClassNode defaultPlaceholder)`
	`static void`	`warning(org.codehaus.groovy.control.SourceUnit sourceUnit, org.codehaus.groovy.ast.ASTNode node, java.lang.String warningMessage)`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Field Detail
  - public static java.util.regex.Pattern DOMAIN_PATH_PATTERN
  - public static final java.lang.String DOMAIN_TYPE
  - public static final java.lang.String GRAILS_APP_DIR
    
    The name of the Grails application directory
  - public static final org.codehaus.groovy.ast.ClassNode OBJECT_CLASS_NODE
  - public static final java.lang.String REGEX_FILE_SEPARATOR
  - public static final java.lang.Object TRANSFORM_APPLIED_MARKER
  - public static final org.codehaus.groovy.ast.expr.ArgumentListExpression ZERO_ARGUMENTS
  - public static final org.codehaus.groovy.ast.Parameter[] ZERO_PARAMETERS
- Method Detail
  - static void addAnnotationIfNecessary(org.codehaus.groovy.ast.ClassNode classNode, java.lang.Class<? extends java.lang.annotation.Annotation> annotationClass)
    
    Adds an annotation to the give nclass node if it doesn't already exist
    Parameters:
    classNode - The class node
    annotationClass - The annotation class
  - static org.codehaus.groovy.ast.AnnotationNode addAnnotationOrGetExisting(org.codehaus.groovy.ast.ClassNode classNode, java.lang.Class<? extends java.lang.annotation.Annotation> annotationClass)
    
    Adds an annotation to the given class node or returns the existing annotation
    Parameters:
    classNode - The class node
    annotationClass - The annotation class
  - static org.codehaus.groovy.ast.AnnotationNode addAnnotationOrGetExisting(org.codehaus.groovy.ast.ClassNode classNode, java.lang.Class<? extends java.lang.annotation.Annotation> annotationClass, java.util.Map<java.lang.String, java.lang.Object> members)
    
    Adds an annotation to the given class node or returns the existing annotation
    Parameters:
    classNode - The class node
    annotationClass - The annotation class
  - static org.codehaus.groovy.ast.AnnotationNode addAnnotationOrGetExisting(org.codehaus.groovy.ast.ClassNode classNode, org.codehaus.groovy.ast.ClassNode annotationClassNode)
  - static org.codehaus.groovy.ast.AnnotationNode addAnnotationOrGetExisting(org.codehaus.groovy.ast.ClassNode classNode, org.codehaus.groovy.ast.ClassNode annotationClassNode, java.util.Map<java.lang.String, java.lang.Object> members)
  - static void addTransformedEntityName(java.lang.String name)
    
    Parameters:
    name - Adds the name of a transformed entity
  - static org.codehaus.groovy.ast.AnnotationNode cloneAnnotation(org.codehaus.groovy.ast.AnnotationNode node)
  - static void copyAnnotations(org.codehaus.groovy.ast.AnnotatedNode from, org.codehaus.groovy.ast.AnnotatedNode to)
  - static void copyAnnotations(org.codehaus.groovy.ast.AnnotatedNode from, org.codehaus.groovy.ast.AnnotatedNode to, java.util.Set<java.lang.String> included, java.util.Set<java.lang.String> excluded)
  - static org.codehaus.groovy.ast.Parameter[] copyParameters(org.codehaus.groovy.ast.Parameter[] parameterTypes)
  - static org.codehaus.groovy.ast.Parameter[] copyParameters(org.codehaus.groovy.ast.Parameter[] parameterTypes, java.util.Map<java.lang.String, org.codehaus.groovy.ast.ClassNode> genericsPlaceholders)
  - static org.codehaus.groovy.ast.Parameter[] copyParameters(java.util.Map<java.lang.String, org.codehaus.groovy.ast.ClassNode> genericsSpec, org.codehaus.groovy.ast.Parameter[] parameterTypes, java.util.List<java.lang.String> currentMethodGenPlaceholders)
  - static org.codehaus.groovy.ast.AnnotationNode findAnnotation(org.codehaus.groovy.ast.ClassNode classNode, java.lang.Class<?> type)
  - static org.codehaus.groovy.ast.AnnotationNode findAnnotation(org.codehaus.groovy.ast.ClassNode annotationClassNode, java.util.List<org.codehaus.groovy.ast.AnnotationNode> annotations)
  - static org.codehaus.groovy.ast.ClassNode findInterface(org.codehaus.groovy.ast.ClassNode classNode, java.lang.String interfaceName)
  - static org.codehaus.groovy.ast.ClassNode getFurthestUnresolvedParent(org.codehaus.groovy.ast.ClassNode classNode)
  - static java.util.Collection<java.lang.String> getKnownEntityNames()
    
    Returns:
    The names of the transformed entities for this context
  - static org.codehaus.groovy.ast.PropertyNode getPropertyFromHierarchy(org.codehaus.groovy.ast.ClassNode cn, java.lang.String name)
    
    Obtains a property from the class hierarchy
    Parameters:
    cn - The class node
    name - The property name
    Returns:
    The property node or null
  - static boolean hasOrInheritsProperty(org.codehaus.groovy.ast.ClassNode classNode, java.lang.String propertyName)
  - static boolean hasProperty(org.codehaus.groovy.ast.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
  - static boolean implementsInterface(org.codehaus.groovy.ast.ClassNode classNode, java.lang.String interfaceName)
  - @java.lang.SuppressWarnings("rawtypes") static boolean implementsOrInheritsZeroArgMethod(org.codehaus.groovy.ast.ClassNode classNode, java.lang.String methodName)
  - static boolean implementsZeroArgMethod(org.codehaus.groovy.ast.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
  - static void injectTrait(org.codehaus.groovy.ast.ClassNode classNode, java.lang.Class traitClass)
  - static boolean isDomainClass(java.net.URL url)
    
    Checks whether the file referenced by the given url is a domain class
    Parameters:
    url - The URL instance
    Returns:
    true if it is a domain class
  - @groovy.transform.Memoized static boolean isDomainClass(org.codehaus.groovy.ast.ClassNode classNode)
  - static boolean isEnum(org.codehaus.groovy.ast.ClassNode classNode)
  - static boolean isGroovyType(org.codehaus.groovy.ast.ClassNode type)
    
    Whether the given type is a Groovy object
    Parameters:
    type - The type
    Returns:
    True if it is
  - static boolean isSubclassOf(org.codehaus.groovy.ast.ClassNode classNode, java.lang.String parentClassName)
    
    Returns true if the given class name is a parent class of the given class
    Parameters:
    classNode - The class node
    parentClassName - the parent class name
    Returns:
    True if it is a subclass
  - static boolean isSubclassOfOrImplementsInterface(org.codehaus.groovy.ast.ClassNode childClass, org.codehaus.groovy.ast.ClassNode superClass)
  - static boolean isSubclassOfOrImplementsInterface(org.codehaus.groovy.ast.ClassNode childClass, java.lang.String superClassName)
  - static org.codehaus.groovy.ast.ClassNode nonGeneric(org.codehaus.groovy.ast.ClassNode type)
  - @java.lang.SuppressWarnings("unchecked") static org.codehaus.groovy.ast.ClassNode nonGeneric(org.codehaus.groovy.ast.ClassNode type, org.codehaus.groovy.ast.ClassNode wildcardReplacement)
  - static org.codehaus.groovy.ast.ClassNode replaceGenericsPlaceholders(org.codehaus.groovy.ast.ClassNode type, java.util.Map<java.lang.String, org.codehaus.groovy.ast.ClassNode> genericsPlaceholders)
  - static org.codehaus.groovy.ast.ClassNode replaceGenericsPlaceholders(org.codehaus.groovy.ast.ClassNode type, java.util.Map<java.lang.String, org.codehaus.groovy.ast.ClassNode> genericsPlaceholders, org.codehaus.groovy.ast.ClassNode defaultPlaceholder)
  - static void warning(org.codehaus.groovy.control.SourceUnit sourceUnit, org.codehaus.groovy.ast.ASTNode node, java.lang.String warningMessage)

Summary:
Field
Method

| Detail:
Field
Method

[Groovy] Class AstUtils

Field Summary

Methods Summary

Inherited Methods Summary

Field Detail

public static java.util.regex.Pattern DOMAIN_PATH_PATTERN

public static final java.lang.String DOMAIN_TYPE

public static final java.lang.String GRAILS_APP_DIR

public static final org.codehaus.groovy.ast.ClassNode OBJECT_CLASS_NODE

public static final java.lang.String REGEX_FILE_SEPARATOR

public static final java.lang.Object TRANSFORM_APPLIED_MARKER

public static final org.codehaus.groovy.ast.expr.ArgumentListExpression ZERO_ARGUMENTS

public static final org.codehaus.groovy.ast.Parameter[] ZERO_PARAMETERS

Method Detail

static void addAnnotationIfNecessary(org.codehaus.groovy.ast.ClassNode classNode, java.lang.Class<? extends java.lang.annotation.Annotation> annotationClass)

static org.codehaus.groovy.ast.AnnotationNode addAnnotationOrGetExisting(org.codehaus.groovy.ast.ClassNode classNode, java.lang.Class<? extends java.lang.annotation.Annotation> annotationClass)

static org.codehaus.groovy.ast.AnnotationNode addAnnotationOrGetExisting(org.codehaus.groovy.ast.ClassNode classNode, java.lang.Class<? extends java.lang.annotation.Annotation> annotationClass, java.util.Map<java.lang.String, java.lang.Object> members)

static org.codehaus.groovy.ast.AnnotationNode addAnnotationOrGetExisting(org.codehaus.groovy.ast.ClassNode classNode, org.codehaus.groovy.ast.ClassNode annotationClassNode)

static org.codehaus.groovy.ast.AnnotationNode addAnnotationOrGetExisting(org.codehaus.groovy.ast.ClassNode classNode, org.codehaus.groovy.ast.ClassNode annotationClassNode, java.util.Map<java.lang.String, java.lang.Object> members)

static void addTransformedEntityName(java.lang.String name)

static org.codehaus.groovy.ast.AnnotationNode cloneAnnotation(org.codehaus.groovy.ast.AnnotationNode node)

static void copyAnnotations(org.codehaus.groovy.ast.AnnotatedNode from, org.codehaus.groovy.ast.AnnotatedNode to)

static void copyAnnotations(org.codehaus.groovy.ast.AnnotatedNode from, org.codehaus.groovy.ast.AnnotatedNode to, java.util.Set<java.lang.String> included, java.util.Set<java.lang.String> excluded)

static org.codehaus.groovy.ast.Parameter[] copyParameters(org.codehaus.groovy.ast.Parameter[] parameterTypes)

static org.codehaus.groovy.ast.Parameter[] copyParameters(org.codehaus.groovy.ast.Parameter[] parameterTypes, java.util.Map<java.lang.String, org.codehaus.groovy.ast.ClassNode> genericsPlaceholders)

static org.codehaus.groovy.ast.Parameter[] copyParameters(java.util.Map<java.lang.String, org.codehaus.groovy.ast.ClassNode> genericsSpec, org.codehaus.groovy.ast.Parameter[] parameterTypes, java.util.List<java.lang.String> currentMethodGenPlaceholders)

static org.codehaus.groovy.ast.AnnotationNode findAnnotation(org.codehaus.groovy.ast.ClassNode classNode, java.lang.Class<?> type)

static org.codehaus.groovy.ast.AnnotationNode findAnnotation(org.codehaus.groovy.ast.ClassNode annotationClassNode, java.util.List<org.codehaus.groovy.ast.AnnotationNode> annotations)

static org.codehaus.groovy.ast.ClassNode findInterface(org.codehaus.groovy.ast.ClassNode classNode, java.lang.String interfaceName)

static org.codehaus.groovy.ast.ClassNode getFurthestUnresolvedParent(org.codehaus.groovy.ast.ClassNode classNode)

static java.util.Collection<java.lang.String> getKnownEntityNames()

static org.codehaus.groovy.ast.PropertyNode getPropertyFromHierarchy(org.codehaus.groovy.ast.ClassNode cn, java.lang.String name)

static boolean hasOrInheritsProperty(org.codehaus.groovy.ast.ClassNode classNode, java.lang.String propertyName)

static boolean hasProperty(org.codehaus.groovy.ast.ClassNode classNode, java.lang.String propertyName)

static boolean implementsInterface(org.codehaus.groovy.ast.ClassNode classNode, java.lang.String interfaceName)

@java.lang.SuppressWarnings("rawtypes") static boolean implementsOrInheritsZeroArgMethod(org.codehaus.groovy.ast.ClassNode classNode, java.lang.String methodName)

static boolean implementsZeroArgMethod(org.codehaus.groovy.ast.ClassNode classNode, java.lang.String methodName)

static void injectTrait(org.codehaus.groovy.ast.ClassNode classNode, java.lang.Class traitClass)

static boolean isDomainClass(java.net.URL url)

@groovy.transform.Memoized static boolean isDomainClass(org.codehaus.groovy.ast.ClassNode classNode)

static boolean isEnum(org.codehaus.groovy.ast.ClassNode classNode)

static boolean isGroovyType(org.codehaus.groovy.ast.ClassNode type)

static boolean isSubclassOf(org.codehaus.groovy.ast.ClassNode classNode, java.lang.String parentClassName)

static boolean isSubclassOfOrImplementsInterface(org.codehaus.groovy.ast.ClassNode childClass, org.codehaus.groovy.ast.ClassNode superClass)

static boolean isSubclassOfOrImplementsInterface(org.codehaus.groovy.ast.ClassNode childClass, java.lang.String superClassName)

static org.codehaus.groovy.ast.ClassNode nonGeneric(org.codehaus.groovy.ast.ClassNode type)

@java.lang.SuppressWarnings("unchecked") static org.codehaus.groovy.ast.ClassNode nonGeneric(org.codehaus.groovy.ast.ClassNode type, org.codehaus.groovy.ast.ClassNode wildcardReplacement)

static org.codehaus.groovy.ast.ClassNode replaceGenericsPlaceholders(org.codehaus.groovy.ast.ClassNode type, java.util.Map<java.lang.String, org.codehaus.groovy.ast.ClassNode> genericsPlaceholders)

static org.codehaus.groovy.ast.ClassNode replaceGenericsPlaceholders(org.codehaus.groovy.ast.ClassNode type, java.util.Map<java.lang.String, org.codehaus.groovy.ast.ClassNode> genericsPlaceholders, org.codehaus.groovy.ast.ClassNode defaultPlaceholder)

static void warning(org.codehaus.groovy.control.SourceUnit sourceUnit, org.codehaus.groovy.ast.ASTNode node, java.lang.String warningMessage)