NodeUtils (Asteroid API Documentation)

java.lang.Object
- asteroid.utils.NodeUtils

```
public class NodeUtils
extends java.lang.Object
```
General utility methods to deal with ASTNode instances

Since:

0.1.4

See Also:

Utils

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String ANNOTATION_VALUE

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ANNOTATION_VALUE`

Constructor Summary

Constructors
Constructor and Description

NodeUtils()

Constructors
Constructor and Description
`NodeUtils()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAfterCodeBlock(MethodNode methodNode, Statement statement)` Adds the statement passed as argument after the current method code
`void`	`addAroundCodeBlock(MethodNode methodNode, Statement before, Statement after)` Adds two different statements to be executed before and after the current method code
`void`	`addBeforeCodeBlock(MethodNode methodNode, Statement statement)` Adds the statement passed as argument before the current method code
`void`	`addCheckTo(MethodNode methodNode)` Adds checks to the method node passed as parameter
`void`	`addImport(ClassNode classNode, java.lang.Class clazz)` Adds an import to the `ModuleNode` containing the `ClassNode` passed as first argument.
`void`	`addImport(ClassNode classNode, java.lang.Class clazz, java.lang.String alias)` Adds an import to the `ModuleNode` containing the `ClassNode` passed as first argument.
`void`	`addImport(ClassNode classNode, java.lang.String clazz)` Adds an import to the `ModuleNode` containing the `ClassNode` passed as first argument.
`void`	`addImport(ClassNode classNode, java.lang.String clazz, java.lang.String alias)` Adds an import to the `ModuleNode` containing the `ClassNode` passed as first argument.
`void`	`addInterfaces(ClassNode classNode, java.lang.Class... interfaces)` Makes the `ClassNode` to implement the interfaces passed as arguments IMPORTANT: Dont use this method at any `CompilePhase` before SEMANTIC_ANALYSIS.
`void`	`addInterfaces(ClassNode classNode, ClassNode... interfaces)` Makes the `ClassNode` to implement the interfaces passed as arguments.
`void`	`addMethod(ClassNode classNode, MethodNode methodNode)` Adds the method to the class node passed as first argument
`void`	`addMethodIfNotPresent(ClassNode classNode, MethodNode methodNode)` Adds a method to the class node passed as first argument only if it wasn't present in the first place
`void`	`addProperty(ClassNode classNode, PropertyNode propertyNode)` Adds the property to the class node passed as first argument
`void`	`addPropertyIfNotPresent(ClassNode classNode, PropertyNode propertyNode)` Adds a property to the class node passed as first argument only if it wasn't present in the first place
`java.util.List<MethodNode>`	`findAllMethodByName(ClassNode classNode, java.lang.String methodName)` Returns all `MethodNode` found with a given name in a specific `ClassNode`
`MethodNode`	`findMethodByName(ClassNode classNode, java.lang.String methodName)` Returns the first `MethodNode` found with a given name in a specific `ClassNode`
`<T> T`	`get(AnnotationNode annotationNode, java.lang.Class<T> clazz)` Returns the value of a given annotation member.
`<T> T`	`get(AnnotationNode annotationNode, java.lang.String name, java.lang.Class<T> clazz)` Returns the value of a member of the `AnnotationNode` passed as first parameter with the name passed as second parameter.
`AnnotationNode`	`getAnnotationFrom(ClassNode classNode, ClassNode annotationType)` Gets a given annotation node from the `ClassNode` passed as first argument.
`AnnotationNode`	`getAnnotationFrom(ClassNode classNode, java.lang.String simpleName)` Retrieves an annotation with a specific simple name.
`BlockStatement`	`getCodeBlock(MethodNode methodNode)` Utility method to make your transformation code more compile static compliant when getting a method node code block.
`<T> T`	`getFirstNodeAs(ASTNode[] nodes, java.lang.Class<T> clazz)` Returns the first node of the list passed as parameter with the expected type T
`java.util.List<FieldNode>`	`getInstancePropertyFields(ClassNode classNode)` Returns all properties from a given `ClassNode` passed as argument
`<T> T`	`getLastNodeAs(ASTNode[] nodes, java.lang.Class<T> clazz)` Returns the last node of the list passed as parameter with the expected type T
`java.lang.String`	`getStringValue(AnnotationNode annotationNode)` Returns the `String` representation of the member "value" of the annotation passed as parameter
`java.lang.Boolean`	`hasFieldOfType(ClassNode node, java.lang.String qualifiedName)` Returns whether if the `ClassNode` passed as first parameter has any field with the type matching the qualified name passed as second parameter.
`java.lang.Boolean`	`isOrExtends(ClassNode child, java.lang.Class parent)` Returns true if the classNode passed as first argument is of type `clazz` or that class extends the other class, false otherwise
`java.lang.Boolean`	`isOrExtends(ClassNode child, ClassNode parent)` Returns true if the classNode passed as first argument is of type `clazz` or that class extends the other class, false otherwise
`java.lang.Boolean`	`isOrExtends(ClassNode child, java.lang.String parent)` Returns true if the classNode passed as first argument is of type `clazz` or that class extends the other class, false otherwise
`java.lang.Boolean`	`isOrExtendsUnsafe(ClassNode child, ClassNode parent)` Returns true if the classNode passed as first argument is of type `clazz` or that class extends the other class, false otherwise.
`java.lang.Boolean`	`isOrImplements(java.lang.Class child, java.lang.Class parent)` Returns true if the classNode passed as first argument is of type `clazz` or that class implements `parent`, false otherwise
`java.lang.Boolean`	`isOrImplements(ClassNode child, java.lang.Class parent)` Returns true if the classNode passed as first argument is of type `clazz` or that class implements `parent`, false otherwise
`java.lang.Boolean`	`isOrImplements(ClassNode child, java.lang.String parent)` Returns true if the classNode passed as first argument is of type `clazz` or that class implements `parent`, false otherwise
`void`	`removeAnnotation(AnnotatedNode annotated, AnnotationNode annotation)` It removes the `AnnotationNode` from a given `AnnotatedNode`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - ANNOTATION_VALUE
```
public static final java.lang.String ANNOTATION_VALUE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - NodeUtils
```
public NodeUtils()
```
- Method Detail
  - addCheckTo
```
public void addCheckTo(MethodNode methodNode)
```
    Adds checks to the method node passed as parameter
    
    Parameters:
    
    methodNode - the node we want to add the checks to
    
    Since:
    
    0.3.0
  - getFirstNodeAs
```
public <T> T getFirstNodeAs(ASTNode[] nodes,
                            java.lang.Class<T> clazz)
```
    Returns the first node of the list passed as parameter with the expected type T
    
    Type Parameters:
    
    T - the expected type
    
    Parameters:
    
    nodes - a list of nodes
    
    clazz - the type of the expected value
    
    Returns:
    
    a node with type T
    
    Since:
    
    0.3.0
  - getLastNodeAs
```
public <T> T getLastNodeAs(ASTNode[] nodes,
                           java.lang.Class<T> clazz)
```
    Returns the last node of the list passed as parameter with the expected type T
    
    Type Parameters:
    
    T - the expected type
    
    Parameters:
    
    nodes - a list of nodes
    
    clazz - the type of the expected value
    
    Returns:
    
    a node with type T
    
    Since:
    
    0.3.0
  - getStringValue
```
public java.lang.String getStringValue(AnnotationNode annotationNode)
```
    Returns the String representation of the member "value" of the annotation passed as parameter
    
    Parameters:
    
    annotationNode - The node we want the value from
    
    Returns:
    
    the value of the member "value" as a String
    
    Since:
    
    0.3.0
  - get
```
public <T> T get(AnnotationNode annotationNode,
                 java.lang.Class<T> clazz)
```
    Returns the value of a given annotation member. The value is casted to the type passed as second argument.
    
    Type Parameters:
    
    T - The expected return type
    
    Parameters:
    
    annotationNode - The node we want the member value from
    
    clazz - the type of value expected
    
    Returns:
    
    an instance of type T
    
    Since:
    
    0.3.0
  - get
```
public <T> T get(AnnotationNode annotationNode,
                 java.lang.String name,
                 java.lang.Class<T> clazz)
```
    Returns the value of a member of the AnnotationNode passed as first parameter with the name passed as second parameter. The third parameter is the expected type for the member. There are a set of rules before trying to convert values to the Class passed as third parameter:
    - If instance of ClassExpression a String with the qualified name will be returned
    - If instance of ConstantExpression the raw value will be returned
    - If isntance of PropertyExpression the value will be converted to String
    Then there will be a cast to the specific Class
    Parameters:
    
    annotationNode - the annotation we want a member value from
    
    name - the name of the member we want the value from
    
    clazz - the clazz of the expected value
    
    Since:
    
    0.3.0
  - addProperty
```
public void addProperty(ClassNode classNode,
                        PropertyNode propertyNode)
```
    Adds the property to the class node passed as first argument
    
    Parameters:
    
    classNode - the class we want to add the property to
    
    propertyNode - the property we want to add
    
    Since:
    
    0.3.0
  - addPropertyIfNotPresent
```
public void addPropertyIfNotPresent(ClassNode classNode,
                                    PropertyNode propertyNode)
```
    Adds a property to the class node passed as first argument only if it wasn't present in the first place
    
    Parameters:
    
    classNode - the class we want to add the property to
    
    propertyNode - the property we want to add
    
    Since:
    
    0.3.0
  - addMethod
```
public void addMethod(ClassNode classNode,
                      MethodNode methodNode)
```
    Adds the method to the class node passed as first argument
    
    Parameters:
    
    classNode - the class we want to add the method to
    
    methodNode - the method we want to add
    
    Since:
    
    0.3.0
  - addMethodIfNotPresent
```
public void addMethodIfNotPresent(ClassNode classNode,
                                  MethodNode methodNode)
```
    Adds a method to the class node passed as first argument only if it wasn't present in the first place
    
    Parameters:
    
    classNode - the class we want to add the method to
    
    methodNode - the method we want to add
    
    Since:
    
    0.3.0
  - addInterfaces
```
public void addInterfaces(ClassNode classNode,
                          java.lang.Class... interfaces)
```
    Makes the ClassNode to implement the interfaces passed as arguments
    
    IMPORTANT: Dont use this method at any CompilePhase before SEMANTIC_ANALYSIS. Classes may have not been set at this point.
    
    Parameters:
    
    classNode - The class we want to add the interfaces to
    
    interfaces - the interfaces we want the class node to be implementing
    
    Since:
    
    0.3.0
  - addInterfaces
```
public void addInterfaces(ClassNode classNode,
                          ClassNode... interfaces)
```
    Makes the ClassNode to implement the interfaces passed as arguments.
    
    Parameters:
    
    classNode - the ClassNode we want to implement certain interfaces
    
    interfaces - the interfaces we want our ClassNode to implement
    
    Since:
    
    0.3.0
  - getInstancePropertyFields
```
public java.util.List<FieldNode> getInstancePropertyFields(ClassNode classNode)
```
    Returns all properties from a given ClassNode passed as argument
    
    Parameters:
    
    classNode - the ClassNode we want its properties from
    
    Returns:
    
    a list of the properties (FieldNode) of a given ClassNode
    
    Since:
    
    0.3.0
  - getAnnotationFrom
```
public AnnotationNode getAnnotationFrom(ClassNode classNode,
                                        ClassNode annotationType)
```
    Gets a given annotation node from the ClassNode passed as first argument.
    
    Parameters:
    
    classNode - the class node annotated with the annotation we're looking for
    
    annotationType - the annotation class node
    
    Returns:
    
    the annotation type if found, null otherwise
    
    Since:
    
    0.3.0
  - getAnnotationFrom
```
public AnnotationNode getAnnotationFrom(ClassNode classNode,
                                        java.lang.String simpleName)
```
    Retrieves an annotation with a specific simple name. A simple name stands for the qualified name of the type minus the package name, e.g if we had a type "groovy.transform.ToString" the simple name would be "ToString".
    
    Parameters:
    
    classNode - the class node annotated with the annotation we're looking for
    
    simpleName - the annotation type simple name
    
    Returns:
    
    the annotation node if found, null otherwise
    
    Since:
    
    0.3.0
  - removeAnnotation
```
public void removeAnnotation(AnnotatedNode annotated,
                             AnnotationNode annotation)
```
    It removes the AnnotationNode from a given AnnotatedNode
    
    Parameters:
    
    annotated - the AnnotatedNode to remove the annotation from
    
    annotation - the AnnotationNode you want to remove
    
    Since:
    
    0.3.0
  - hasFieldOfType
```
public java.lang.Boolean hasFieldOfType(ClassNode node,
                                        java.lang.String qualifiedName)
```
    Returns whether if the ClassNode passed as first parameter has any field with the type matching the qualified name passed as second parameter.
    
    Parameters:
    
    node - The node under test
    
    qualifiedName - The qualified name of the type
    
    Returns:
    
    true if there is any field with the given type, false otherwise
    
    Since:
    
    0.3.0
  - isOrImplements
```
public java.lang.Boolean isOrImplements(java.lang.Class child,
                                        java.lang.Class parent)
```
    Returns true if the classNode passed as first argument is of type `clazz` or that class implements `parent`, false otherwise
    
    Parameters:
    
    child - the Class we are checking
    
    parent - the Class we are testing against
    
    Returns:
    
    true if the classNode is of type `clazz`
    
    Since:
    
    0.3.0
  - isOrImplements
```
public java.lang.Boolean isOrImplements(ClassNode child,
                                        java.lang.Class parent)
```
    Returns true if the classNode passed as first argument is of type `clazz` or that class implements `parent`, false otherwise
    
    Parameters:
    
    child - the ClassNode we are checking
    
    parent - the Class we are testing against
    
    Returns:
    
    true if the classNode is of type `parent`
    
    Since:
    
    0.3.0
  - isOrImplements
```
public java.lang.Boolean isOrImplements(ClassNode child,
                                        java.lang.String parent)
```
    Returns true if the classNode passed as first argument is of type `clazz` or that class implements `parent`, false otherwise
    
    Parameters:
    
    child - the ClassNode we are checking
    
    parent - the qualified name of the Class we are testing against
    
    Returns:
    
    true if the classNode is of type `clazz`
    
    Since:
    
    0.3.0
  - isOrExtends
```
public java.lang.Boolean isOrExtends(ClassNode child,
                                     java.lang.Class parent)
```
    Returns true if the classNode passed as first argument is of type `clazz` or that class extends the other class, false otherwise
    
    Parameters:
    
    child - the ClassNode we are checking
    
    parent - the Class we are testing against
    
    Returns:
    
    true if the classNode is of type `parent`
    
    Since:
    
    0.3.0
  - isOrExtends
```
public java.lang.Boolean isOrExtends(ClassNode child,
                                     ClassNode parent)
```
    Returns true if the classNode passed as first argument is of type `clazz` or that class extends the other class, false otherwise
    
    Parameters:
    
    child - the ClassNode we are checking
    
    parent - the ClassNode we are testing against
    
    Returns:
    
    true if the classNode is of type `parent`
    
    Since:
    
    0.3.0
  - isOrExtends
```
public java.lang.Boolean isOrExtends(ClassNode child,
                                     java.lang.String parent)
```
    Returns true if the classNode passed as first argument is of type `clazz` or that class extends the other class, false otherwise
    
    Parameters:
    
    child - the ClassNode we are checking
    
    parent - the qualified name of the class we are testing against
    
    Returns:
    
    true if the classNode is of type `parent`
    
    Since:
    
    0.3.0
  - isOrExtendsUnsafe
```
public java.lang.Boolean isOrExtendsUnsafe(ClassNode child,
                                           ClassNode parent)
```
    Returns true if the classNode passed as first argument is of type `clazz` or that class extends the other class, false otherwise. It's unsafe because it tries to compare also the super class simple name. So two classes having the same name even in different packages will return true.
    
    Parameters:
    
    child - the ClassNode we are checking
    
    parent - the ClassNode we are testing against
    
    Returns:
    
    true if the classNode is of type `parent`
    
    Since:
    
    0.3.0
  - findMethodByName
```
public MethodNode findMethodByName(ClassNode classNode,
                                   java.lang.String methodName)
```
    Returns the first MethodNode found with a given name in a specific ClassNode
    
    Parameters:
    
    classNode - the ClassNode the method should be found
    
    methodName - the method name
    
    Returns:
    
    an instance of MethodNode if found
    
    Since:
    
    0.3.0
  - findAllMethodByName
```
public java.util.List<MethodNode> findAllMethodByName(ClassNode classNode,
                                                      java.lang.String methodName)
```
    Returns all MethodNode found with a given name in a specific ClassNode
    
    Parameters:
    
    classNode - the ClassNode the method should be found
    
    methodName - the method name
    
    Returns:
    
    an instance of MethodNode if found
    
    Since:
    
    0.3.0
  - addImport
```
public void addImport(ClassNode classNode,
                      java.lang.Class clazz)
```
    Adds an import to the ModuleNode containing the ClassNode passed as first argument.
    
    Parameters:
    
    classNode - the ClassNode where the import will be added
    
    clazz - the type Class of the import
    
    Since:
    
    0.3.0
  - addImport
```
public void addImport(ClassNode classNode,
                      java.lang.String clazz)
```
    Adds an import to the ModuleNode containing the ClassNode passed as first argument.
    
    Parameters:
    
    classNode - the ClassNode where the import will be added
    
    clazz - the string representing the qualified class of the import
    
    Since:
    
    0.3.0
  - addImport
```
public void addImport(ClassNode classNode,
                      java.lang.Class clazz,
                      java.lang.String alias)
```
    Adds an import to the ModuleNode containing the ClassNode passed as first argument.
    
    Parameters:
    
    classNode - the ClassNode where the import will be added
    
    clazz - the type Class of the import
    
    alias - an alias to avoid class collisions
    
    Since:
    
    0.3.0
  - addImport
```
public void addImport(ClassNode classNode,
                      java.lang.String clazz,
                      java.lang.String alias)
```
    Adds an import to the ModuleNode containing the ClassNode passed as first argument.
    
    Parameters:
    
    classNode - the ClassNode where the import will be added
    
    clazz - the string representing the qualified class of the import
    
    alias - an alias to avoid class collisions
    
    Since:
    
    0.3.0
  - getCodeBlock
```
public BlockStatement getCodeBlock(MethodNode methodNode)
```
    Utility method to make your transformation code more compile static compliant when getting a method node code block. Many times you may want to deal with it as if it were a BlockStatement.
    
    Parameters:
    
    methodNode - the method we want the code from
    
    Returns:
    
    the method code as a BlockStatement
  - addBeforeCodeBlock
```
public void addBeforeCodeBlock(MethodNode methodNode,
                               Statement statement)
```
    Adds the statement passed as argument before the current method code
    
    Parameters:
    
    statement - the statement to be executed before current code
    
    Since:
    
    0.3.0
  - addAfterCodeBlock
```
public void addAfterCodeBlock(MethodNode methodNode,
                              Statement statement)
```
    Adds the statement passed as argument after the current method code
    
    Parameters:
    
    statement - the statement to be executed after current code
    
    Since:
    
    0.3.0
  - addAroundCodeBlock
```
public void addAroundCodeBlock(MethodNode methodNode,
                               Statement before,
                               Statement after)
```
    Adds two different statements to be executed before and after the current method code
    
    Parameters:
    
    before - to be executed before
    
    after - to be executed after
    
    Since:
    
    0.3.0

Class NodeUtils

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ANNOTATION_VALUE

Constructor Detail

NodeUtils

Method Detail

addCheckTo

getFirstNodeAs

getLastNodeAs

getStringValue

get

get

addProperty

addPropertyIfNotPresent

addMethod

addMethodIfNotPresent

addInterfaces

addInterfaces

getInstancePropertyFields

getAnnotationFrom

getAnnotationFrom

removeAnnotation

hasFieldOfType

isOrImplements

isOrImplements

isOrImplements

isOrExtends

isOrExtends

isOrExtends

isOrExtendsUnsafe

findMethodByName

findAllMethodByName

addImport

addImport

addImport

addImport

getCodeBlock

addBeforeCodeBlock

addAfterCodeBlock

addAroundCodeBlock