ClassNode (groovy 2.3.0-rc-1 API)

org.codehaus.groovy.ast.ClassNode

All Implemented Interfaces:

org.objectweb.asm.Opcodes
```
public class ClassNode
extends AnnotatedNode
```
Represents a class in the AST.
A ClassNode should be created using the methods in ClassHelper. This ClassNode may be used to represent a class declaration or any other type. This class uses a proxy mechanism allowing to create a class for a plain name at AST creation time. In another phase of the compiler the real ClassNode for the plain name may be found. To avoid the need of exchanging this ClassNode with an instance of the correct ClassNode the correct ClassNode is set as redirect. Most method calls are then redirected to that ClassNode.
There are three types of ClassNodes:
1. Primary ClassNodes:
  A primary ClassNode is one where we have a source representation which is to be compiled by Groovy and which we have an AST for. The groovy compiler will output one class for each such ClassNode that passes through AsmBytecodeGenerator... not more, not less. That means for example Closures become such ClassNodes too at some point.
2. ClassNodes create through different sources (typically created from a java.lang.reflect.Class object):
  The compiler will not output classes from these, the methods usually do not contain bodies. These kind of ClassNodes will be used in different checks, but not checks that work on the method bodies. For example if such a ClassNode is a super class to a primary ClassNode, then the abstract method test and others will be done with data based on these. Theoretically it is also possible to mix both (1 and 2) kind of classes in a hierarchy, but this probably works only in the newest Groovy versions. Such ClassNodes normally have to isResolved() returning true without having a redirect.In the Groovy compiler the only version of this, that exists, is a ClassNode created through a Class instance
3. Labels:
  ClassNodes created through ClassHelper.makeWithoutCaching. They are place holders, its redirect points to the real structure, which can be a label too, but following all redirects it should end with a ClassNode from one of the other two categories. If ResolveVisitor finds such a node, it tries to set the redirects. Any such label created after ResolveVisitor has done its work needs to have a redirect pointing to case 1 or 2. If not the compiler may react strange... this can be considered as a kind of dangling pointer.
Note: the redirect mechanism is only allowed for classes that are not primary ClassNodes. Typically this is done for classes created by name only. The redirect itself can be any type of ClassNode.
To describe generic type signature see getGenericsTypes() and setGenericsTypes(GenericsType[]). These methods are not proxied, they describe the type signature used at the point of declaration or the type signatures provided by the class. If the type signatures provided by the class are needed, then a call to redirect() will help.
Authors:
James Strachan
Jochen Theodorou
See Also:
ClassHelper

Field Summary

Fields
Modifiers	Name	Description
`static ClassNode[]`	`EMPTY_ARRAY`
`static ClassNode`	`SUPER`
`static ClassNode`	`THIS`
`protected Class`	`clazz`
`protected List`	`innerClasses`
`protected boolean`	`isPrimaryNode`
`protected Object`	`lazyInitLock`

Methods Summary

Methods
Type	Name and description
`def`	`ClassNode(Class c)`
`def`	`ClassNode(String name, int modifiers, ClassNode superClass)`
`def`	`ClassNode(String name, int modifiers, ClassNode superClass, ClassNode[] interfaces, MixinNode[] mixins)`
`void`	`addConstructor(ConstructorNode node)`
`ConstructorNode`	`addConstructor(int modifiers, Parameter[] parameters, ClassNode[] exceptions, Statement code)`
`void`	`addField(FieldNode node)`
`FieldNode`	`addField(String name, int modifiers, ClassNode type, Expression initialValue)`
`void`	`addFieldFirst(FieldNode node)`
`FieldNode`	`addFieldFirst(String name, int modifiers, ClassNode type, Expression initialValue)`
`void`	`addInterface(ClassNode type)`
`void`	`addMethod(MethodNode node)`
`MethodNode`	`addMethod(String name, int modifiers, ClassNode returnType, Parameter[] parameters, ClassNode[] exceptions, Statement code)`
`void`	`addMixin(MixinNode mixin)`
`void`	`addObjectInitializerStatements(Statement statements)`
`void`	`addProperty(PropertyNode node)`
`PropertyNode`	`addProperty(String name, int modifiers, ClassNode type, Expression initialValueExpression, Statement getterBlock, Statement setterBlock)`
`void`	`addStaticInitializerStatements(List staticStatements, boolean fieldInit)`
`MethodNode`	`addSyntheticMethod(String name, int modifiers, ClassNode returnType, Parameter[] parameters, ClassNode[] exceptions, Statement code)`
`void`	`addTransform(Class transform, ASTNode node)`
`boolean`	`declaresInterface(ClassNode classNode)` @return the ClassNode of the super class of this type
`boolean`	`equals(Object o)`
`List`	`getAbstractMethods()`
`List`	`getAllDeclaredMethods()`
`Set`	`getAllInterfaces()`
`List`	`getAnnotations()`
`List`	`getAnnotations(ClassNode type)`
`CompileUnit`	`getCompileUnit()`
`ClassNode`	`getComponentType()`
`List`	`getDeclaredConstructors()`
`FieldNode`	`getDeclaredField(String name)` Finds a field matching the given name in this class.
`MethodNode`	`getDeclaredMethod(String name, Parameter[] parameters)` Finds a method matching the given name and parameters in this class or any parent class.
`List`	`getDeclaredMethods(String name)` This methods returns a list of all methods of the given name defined in the current class
`Map`	`getDeclaredMethodsMap()`
`MethodNode`	`getEnclosingMethod()`
`FieldNode`	`getField(String name)` @return the field node on the outer class or null if this is not an inner class
`List`	`getFields()` @return the array of interfaces which this ClassNode implements
`GenericsType[]`	`getGenericsTypes()`
`MethodNode`	`getGetterMethod(String getterName)`
`Iterator`	`getInnerClasses()`
`ClassNode[]`	`getInterfaces()`
`MethodNode`	`getMethod(String name, Parameter[] parameters)` @param type the ClassNode of interest
`List`	`getMethods()` @return the list of abstract methods associated with this ClassNode or null if there are no such methods
`List`	`getMethods(String name)`
`MixinNode[]`	`getMixins()` @return the list of methods associated with this ClassNode
`int`	`getModifiers()`
`ModuleNode`	`getModule()`
`String`	`getName()`
`String`	`getNameWithoutPackage()`
`List`	`getObjectInitializerStatements()`
`ClassNode`	`getOuterClass()`
`FieldNode`	`getOuterField(String name)` Helper method to avoid casting to inner class
`PackageNode`	`getPackage()`
`String`	`getPackageName()`
`ClassNode`	`getPlainNodeReference()`
`List`	`getProperties()`
`PropertyNode`	`getProperty(String name)`
`MethodNode`	`getSetterMethod(String setterName)` Is this class declared in a static method (such as a closure / inner class declared in a static method)
`MethodNode`	`getSetterMethod(String setterName, boolean voidOnly)`
`ClassNode`	`getSuperClass()`
`String`	`getText()`
`Map`	`getTransforms(CompilePhase phase)` @return iterator of inner classes defined inside this one
`Class`	`getTypeClass()`
`ClassNode[]`	`getUnresolvedInterfaces()`
`ClassNode[]`	`getUnresolvedInterfaces(boolean useRedirect)`
`String`	`getUnresolvedName()`
`ClassNode`	`getUnresolvedSuperClass()`
`ClassNode`	`getUnresolvedSuperClass(boolean useRedirect)`
`boolean`	`hasDeclaredMethod(String name, Parameter[] parameters)` @see #getDeclaredMethod(String, Parameter[])
`boolean`	`hasMethod(String name, Parameter[] parameters)`
`boolean`	`hasPackageName()`
`boolean`	`hasPossibleMethod(String name, Expression arguments)`
`boolean`	`hasPossibleStaticMethod(String name, Expression arguments)` Returns true if the given method has a possibly matching static method with the given name and arguments.
`boolean`	`hasProperty(String name)`
`int`	`hashCode()`
`boolean`	`implementsInterface(ClassNode classNode)`
`boolean`	`isAnnotated()`
`boolean`	`isAnnotationDefinition()`
`boolean`	`isArray()`
`boolean`	`isDerivedFrom(ClassNode type)` @return true if this class is derived from a groovy object i.e. it implements GroovyObject
`boolean`	`isDerivedFromGroovyObject()`
`boolean`	`isEnum()`
`boolean`	`isGenericsPlaceHolder()`
`boolean`	`isInterface()` Returns the concrete class this classnode relates to.
`boolean`	`isPrimaryClassNode()` @return true if this instance is a primary ClassNode
`boolean`	`isRedirectNode()`
`boolean`	`isResolved()`
`boolean`	`isScript()`
`boolean`	`isScriptBody()`
`boolean`	`isStaticClass()`
`boolean`	`isSyntheticPublic()`
`boolean`	`isUsingGenerics()`
`ClassNode`	`makeArray()`
`protected boolean`	`parametersEqual(Parameter[] a, Parameter[] b)`
`void`	`positionStmtsAfterEnumInitStmts(List staticFieldStatements)`
`ClassNode`	`redirect()` Sets this instance as proxy for the given ClassNode.
`void`	`removeField(String oldName)`
`void`	`removeMethod(MethodNode node)`
`void`	`renameField(String oldName, String newName)`
`void`	`setAnnotated(boolean flag)`
`protected void`	`setCompileUnit(CompileUnit cu)`
`void`	`setEnclosingMethod(MethodNode enclosingMethod)`
`void`	`setGenericsPlaceHolder(boolean b)`
`void`	`setGenericsTypes(GenericsType[] genericsTypes)`
`void`	`setInterfaces(ClassNode[] interfaces)` @return the array of mixins associated with this ClassNode
`void`	`setModifiers(int modifiers)`
`void`	`setModule(ModuleNode module)`
`String`	`setName(String name)`
`void`	`setRedirect(ClassNode cn)`
`void`	`setScript(boolean script)`
`void`	`setScriptBody(boolean scriptBody)`
`void`	`setStaticClass(boolean staticClass)`
`void`	`setSuperClass(ClassNode superClass)` Sets the superclass of this ClassNode
`void`	`setSyntheticPublic(boolean syntheticPublic)`
`void`	`setUnresolvedSuperClass(ClassNode sn)`
`void`	`setUsingGenerics(boolean b)`
`String`	`toString()`
`String`	`toString(boolean showRedirect)`
`MethodNode`	`tryFindPossibleMethod(String name, Expression arguments)`
`void`	`visitContents(GroovyClassVisitor visitor)`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class AnnotatedNode`	`addAnnotation, addAnnotations, getAnnotations, getAnnotations, getDeclaringClass, hasNoRealSourcePosition, isSynthetic, setDeclaringClass, setHasNoRealSourcePosition, setSynthetic`
`class ASTNode`	`copyNodeMetaData, getColumnNumber, getLastColumnNumber, getLastLineNumber, getLineNumber, getNodeMetaData, getText, putNodeMetaData, removeNodeMetaData, setColumnNumber, setLastColumnNumber, setLastLineNumber, setLineNumber, setNodeMetaData, setSourcePosition, visit`
`class Object`	`wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll`

- Field Detail
  - public static final ClassNode[] EMPTY_ARRAY
  - public static final ClassNode SUPER
  - public static final ClassNode THIS
  - protected Class clazz
  - protected List innerClasses
  - protected boolean isPrimaryNode
  - protected Object lazyInitLock
- Method Detail
  - public def ClassNode(Class c)
  - public def ClassNode(String name, int modifiers, ClassNode superClass)
  - public def ClassNode(String name, int modifiers, ClassNode superClass, ClassNode[] interfaces, MixinNode[] mixins)
  - public void addConstructor(ConstructorNode node)
  - public ConstructorNode addConstructor(int modifiers, Parameter[] parameters, ClassNode[] exceptions, Statement code)
  - public void addField(FieldNode node)
  - public FieldNode addField(String name, int modifiers, ClassNode type, Expression initialValue)
  - public void addFieldFirst(FieldNode node)
  - public FieldNode addFieldFirst(String name, int modifiers, ClassNode type, Expression initialValue)
  - public void addInterface(ClassNode type)
  - public void addMethod(MethodNode node)
  - public MethodNode addMethod(String name, int modifiers, ClassNode returnType, Parameter[] parameters, ClassNode[] exceptions, Statement code)
  - public void addMixin(MixinNode mixin)
  - public void addObjectInitializerStatements(Statement statements)
  - public void addProperty(PropertyNode node)
  - public PropertyNode addProperty(String name, int modifiers, ClassNode type, Expression initialValueExpression, Statement getterBlock, Statement setterBlock)
  - public void addStaticInitializerStatements(List staticStatements, boolean fieldInit)
  - public MethodNode addSyntheticMethod(String name, int modifiers, ClassNode returnType, Parameter[] parameters, ClassNode[] exceptions, Statement code)
  - public void addTransform(Class transform, ASTNode node)
  - public boolean declaresInterface(ClassNode classNode)
    
    Returns:
    the ClassNode of the super class of this type
  - public boolean equals(Object o)
  - public List getAbstractMethods()
  - public List getAllDeclaredMethods()
  - public Set getAllInterfaces()
  - public List getAnnotations()
  - public List getAnnotations(ClassNode type)
  - public CompileUnit getCompileUnit()
  - public ClassNode getComponentType()
  - public List getDeclaredConstructors()
  - public FieldNode getDeclaredField(String name)
    
    Finds a field matching the given name in this class.
    Parameters:
    name - the name of the field of interest
    Returns:
    the method matching the given name and parameters or null
  - public MethodNode getDeclaredMethod(String name, Parameter[] parameters)
    
    Finds a method matching the given name and parameters in this class or any parent class.
    Returns:
    the method matching the given name and parameters or null
  - public List getDeclaredMethods(String name)
    
    This methods returns a list of all methods of the given name defined in the current class
    Returns:
    the method list
    See Also:
    getMethods(String)
  - public Map getDeclaredMethodsMap()
  - public MethodNode getEnclosingMethod()
  - public FieldNode getField(String name)
    
    Returns:
    the field node on the outer class or null if this is not an inner class
  - public List getFields()
    
    Returns:
    the array of interfaces which this ClassNode implements
  - public GenericsType[] getGenericsTypes()
  - public MethodNode getGetterMethod(String getterName)
  - public Iterator getInnerClasses()
  - public ClassNode[] getInterfaces()
  - public MethodNode getMethod(String name, Parameter[] parameters)
    
    Parameters:
    type - the ClassNode of interest
    Returns:
    true if this node is derived from the given ClassNode
  - public List getMethods()
    
    Returns:
    the list of abstract methods associated with this ClassNode or null if there are no such methods
  - public List getMethods(String name)
  - public MixinNode[] getMixins()
    
    Returns:
    the list of methods associated with this ClassNode
  - public int getModifiers()
  - public ModuleNode getModule()
  - public String getName()
  - public String getNameWithoutPackage()
  - public List getObjectInitializerStatements()
  - public ClassNode getOuterClass()
  - public FieldNode getOuterField(String name)
    
    Helper method to avoid casting to inner class
  - public PackageNode getPackage()
  - public String getPackageName()
  - public ClassNode getPlainNodeReference()
  - public List getProperties()
  - public PropertyNode getProperty(String name)
  - public MethodNode getSetterMethod(String setterName)
    
    Is this class declared in a static method (such as a closure / inner class declared in a static method)
  - public MethodNode getSetterMethod(String setterName, boolean voidOnly)
  - public ClassNode getSuperClass()
  - @Override public String getText()
  - public Map getTransforms(CompilePhase phase)
    
    Returns:
    iterator of inner classes defined inside this one
  - public Class getTypeClass()
  - public ClassNode[] getUnresolvedInterfaces()
  - public ClassNode[] getUnresolvedInterfaces(boolean useRedirect)
  - public String getUnresolvedName()
  - public ClassNode getUnresolvedSuperClass()
  - public ClassNode getUnresolvedSuperClass(boolean useRedirect)
  - public boolean hasDeclaredMethod(String name, Parameter[] parameters)
    
    See Also:
    getDeclaredMethod(String, Parameter[])
  - public boolean hasMethod(String name, Parameter[] parameters)
  - public boolean hasPackageName()
  - public boolean hasPossibleMethod(String name, Expression arguments)
  - public boolean hasPossibleStaticMethod(String name, Expression arguments)
    
    Returns true if the given method has a possibly matching static method with the given name and arguments.
    Parameters:
    name - the name of the method of interest
    arguments - the arguments to match against
    Returns:
    true if a matching method was found
  - public boolean hasProperty(String name)
  - public int hashCode()
  - public boolean implementsInterface(ClassNode classNode)
  - public boolean isAnnotated()
  - public boolean isAnnotationDefinition()
  - public boolean isArray()
  - public boolean isDerivedFrom(ClassNode type)
    
    Returns:
    true if this class is derived from a groovy object i.e. it implements GroovyObject
  - public boolean isDerivedFromGroovyObject()
  - public boolean isEnum()
  - public boolean isGenericsPlaceHolder()
  - public boolean isInterface()
    
    Returns the concrete class this classnode relates to. However, this method is inherently unsafe as it may return null depending on the compile phase you are using. AST transformations should never use this method directly, but rather obtain a new class node using getPlainNodeReference().
    Returns:
    the class this classnode relates to. May return null.
  - public boolean isPrimaryClassNode()
    
    Returns:
    true if this instance is a primary ClassNode
  - public boolean isRedirectNode()
  - public boolean isResolved()
  - public boolean isScript()
  - public boolean isScriptBody()
  - public boolean isStaticClass()
  - public boolean isSyntheticPublic()
  - public boolean isUsingGenerics()
  - public ClassNode makeArray()
  - protected boolean parametersEqual(Parameter[] a, Parameter[] b)
  - public void positionStmtsAfterEnumInitStmts(List staticFieldStatements)
  - public ClassNode redirect()
    
    Sets this instance as proxy for the given ClassNode.
    Parameters:
    cn - the class to redirect to. If set to null the redirect will be removed
  - public void removeField(String oldName)
  - public void removeMethod(MethodNode node)
  - public void renameField(String oldName, String newName)
  - public void setAnnotated(boolean flag)
  - protected void setCompileUnit(CompileUnit cu)
  - public void setEnclosingMethod(MethodNode enclosingMethod)
  - public void setGenericsPlaceHolder(boolean b)
  - public void setGenericsTypes(GenericsType[] genericsTypes)
  - public void setInterfaces(ClassNode[] interfaces)
    
    Returns:
    the array of mixins associated with this ClassNode
  - public void setModifiers(int modifiers)
  - public void setModule(ModuleNode module)
  - public String setName(String name)
  - public void setRedirect(ClassNode cn)
  - public void setScript(boolean script)
  - public void setScriptBody(boolean scriptBody)
  - public void setStaticClass(boolean staticClass)
  - public void setSuperClass(ClassNode superClass)
    
    Sets the superclass of this ClassNode
  - public void setSyntheticPublic(boolean syntheticPublic)
  - public void setUnresolvedSuperClass(ClassNode sn)
  - public void setUsingGenerics(boolean b)
  - public String toString()
  - public String toString(boolean showRedirect)
  - public MethodNode tryFindPossibleMethod(String name, Expression arguments)
  - public void visitContents(GroovyClassVisitor visitor)

Summary:
Field
Method

| Detail:
Field
Method

[Java] Class ClassNode

Field Summary

Methods Summary

Inherited Methods Summary

Field Detail

public static final ClassNode[] EMPTY_ARRAY

public static final ClassNode SUPER

public static final ClassNode THIS

protected Class clazz

protected List innerClasses

protected boolean isPrimaryNode

protected Object lazyInitLock

Method Detail

public def ClassNode(Class c)

public def ClassNode(String name, int modifiers, ClassNode superClass)

public def ClassNode(String name, int modifiers, ClassNode superClass, ClassNode[] interfaces, MixinNode[] mixins)

public void addConstructor(ConstructorNode node)

public ConstructorNode addConstructor(int modifiers, Parameter[] parameters, ClassNode[] exceptions, Statement code)

public void addField(FieldNode node)

public FieldNode addField(String name, int modifiers, ClassNode type, Expression initialValue)

public void addFieldFirst(FieldNode node)

public FieldNode addFieldFirst(String name, int modifiers, ClassNode type, Expression initialValue)

public void addInterface(ClassNode type)

public void addMethod(MethodNode node)

public MethodNode addMethod(String name, int modifiers, ClassNode returnType, Parameter[] parameters, ClassNode[] exceptions, Statement code)

public void addMixin(MixinNode mixin)

public void addObjectInitializerStatements(Statement statements)

public void addProperty(PropertyNode node)

public PropertyNode addProperty(String name, int modifiers, ClassNode type, Expression initialValueExpression, Statement getterBlock, Statement setterBlock)

public void addStaticInitializerStatements(List staticStatements, boolean fieldInit)

public MethodNode addSyntheticMethod(String name, int modifiers, ClassNode returnType, Parameter[] parameters, ClassNode[] exceptions, Statement code)

public void addTransform(Class transform, ASTNode node)

public boolean declaresInterface(ClassNode classNode)

public boolean equals(Object o)

public List getAbstractMethods()

public List getAllDeclaredMethods()

public Set getAllInterfaces()

public List getAnnotations()

public List getAnnotations(ClassNode type)

public CompileUnit getCompileUnit()

public ClassNode getComponentType()

public List getDeclaredConstructors()

public FieldNode getDeclaredField(String name)

public MethodNode getDeclaredMethod(String name, Parameter[] parameters)

public List getDeclaredMethods(String name)

public Map getDeclaredMethodsMap()

public MethodNode getEnclosingMethod()

public FieldNode getField(String name)

public List getFields()

public GenericsType[] getGenericsTypes()

public MethodNode getGetterMethod(String getterName)

public Iterator getInnerClasses()

public ClassNode[] getInterfaces()

public MethodNode getMethod(String name, Parameter[] parameters)

public List getMethods()

public List getMethods(String name)

public MixinNode[] getMixins()

public int getModifiers()

public ModuleNode getModule()

public String getName()

public String getNameWithoutPackage()

public List getObjectInitializerStatements()

public ClassNode getOuterClass()

public FieldNode getOuterField(String name)

public PackageNode getPackage()

public String getPackageName()

public ClassNode getPlainNodeReference()

public List getProperties()

public PropertyNode getProperty(String name)

public MethodNode getSetterMethod(String setterName)

public MethodNode getSetterMethod(String setterName, boolean voidOnly)

public ClassNode getSuperClass()

@Override public String getText()

public Map getTransforms(CompilePhase phase)

public Class getTypeClass()

public ClassNode[] getUnresolvedInterfaces()

public ClassNode[] getUnresolvedInterfaces(boolean useRedirect)

public String getUnresolvedName()

public ClassNode getUnresolvedSuperClass()

public ClassNode getUnresolvedSuperClass(boolean useRedirect)