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:
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.
Modifiers | Name | Description |
---|---|---|
static ClassNode[] |
EMPTY_ARRAY |
|
static ClassNode |
SUPER |
|
static ClassNode |
THIS |
|
protected Class |
clazz |
|
protected List<InnerClassNode> |
innerClasses |
|
protected boolean |
isPrimaryNode |
|
protected Object |
lazyInitLock |
Type Params | Return Type | Name and description |
---|---|---|
|
def |
ClassNode(Class c) Creates a ClassNode from a real class. |
|
def |
ClassNode(String name, int modifiers, ClassNode superClass) @param name is the full name of the class |
|
def |
ClassNode(String name, int modifiers, ClassNode superClass, ClassNode[] interfaces, MixinNode[] mixins) @param name is the full name of the class |
|
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) If a method with the given name and parameters is already defined then it is returned otherwise the given method is added to this node. |
|
void |
addMixin(MixinNode mixin) |
|
void |
addObjectInitializerStatements(Statement statements) Adds a statement to the object initializer. |
|
void |
addProperty(PropertyNode node) |
|
PropertyNode |
addProperty(String name, int modifiers, ClassNode type, Expression initialValueExpression, Statement getterBlock, Statement setterBlock) |
|
void |
addStaticInitializerStatements(List<Statement> staticStatements, boolean fieldInit) |
|
MethodNode |
addSyntheticMethod(String name, int modifiers, ClassNode returnType, Parameter[] parameters, ClassNode[] exceptions, Statement code) Adds a synthetic method as part of the compilation process |
|
void |
addTransform(Class<? extends ASTTransformation> transform, ASTNode node) |
|
boolean |
declaresInterface(ClassNode classNode) @param classNode the class node for the interface |
|
boolean |
equals(Object o) |
|
List<MethodNode> |
getAbstractMethods() @return the list of abstract methods associated with this ClassNode or null if there are no such methods |
|
List<MethodNode> |
getAllDeclaredMethods() |
|
Set<ClassNode> |
getAllInterfaces() |
|
List<AnnotationNode> |
getAnnotations() |
|
List<AnnotationNode> |
getAnnotations(ClassNode type) |
|
CompileUnit |
getCompileUnit() |
|
ClassNode |
getComponentType() |
|
ConstructorNode |
getDeclaredConstructor(Parameter[] parameters) Finds a constructor matching the given parameters in this class. |
|
List<ConstructorNode> |
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. |
|
List<MethodNode> |
getDeclaredMethods(String name) This methods returns a list of all methods of the given name defined in the current class |
|
Map<String, MethodNode> |
getDeclaredMethodsMap() |
|
MethodNode |
getEnclosingMethod() |
|
FieldNode |
getField(String name) Finds a field matching the given name in this class or a parent class. |
|
List<FieldNode> |
getFields() @return the list of FieldNode's associated with this ClassNode |
|
GenericsType[] |
getGenericsTypes() |
|
MethodNode |
getGetterMethod(String getterName) |
|
MethodNode |
getGetterMethod(String getterName, boolean searchSuperClasses) |
|
Iterator<InnerClassNode> |
getInnerClasses() @return iterator of inner classes defined inside this one |
|
ClassNode[] |
getInterfaces() @return the array of interfaces which this ClassNode implements |
|
MethodNode |
getMethod(String name, Parameter[] parameters) Finds a method matching the given name and parameters in this class or any parent class. |
|
List<MethodNode> |
getMethods() @return the list of methods associated with this ClassNode |
|
List<MethodNode> |
getMethods(String name) This methods creates a list of all methods with this name of the current class and of all super classes |
|
MixinNode[] |
getMixins() @return the array of mixins associated with this ClassNode |
|
int |
getModifiers() |
|
ModuleNode |
getModule() |
|
String |
getName() |
|
String |
getNameWithoutPackage() |
|
List<Statement> |
getObjectInitializerStatements() |
|
ClassNode |
getOuterClass() Helper method to avoid casting to inner class |
|
FieldNode |
getOuterField(String name) @return the field node on the outer class or null if this is not an inner class |
|
PackageNode |
getPackage() |
|
String |
getPackageName() @return the package name of this class |
|
ClassNode |
getPlainNodeReference() |
|
List<PropertyNode> |
getProperties() |
|
PropertyNode |
getProperty(String name) |
|
MethodNode |
getSetterMethod(String setterName) |
|
MethodNode |
getSetterMethod(String setterName, boolean voidOnly) |
|
ClassNode |
getSuperClass() @return the ClassNode of the super class of this type |
|
String |
getText() |
|
Map<Class<? extends ASTTransformation>, Set<ASTNode>> |
getTransforms(CompilePhase phase) |
|
Class |
getTypeClass() Returns the concrete class this classnode relates to. |
|
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) @see #getMethod(String, Parameter[]) |
|
boolean |
hasPackageName() |
|
boolean |
hasPossibleMethod(String name, Expression arguments) Returns true if the given method has a possibly matching instance method with the given name and 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) @param classNode the class node for the interface |
|
boolean |
isAnnotated() |
|
boolean |
isAnnotationDefinition() |
|
boolean |
isArray() |
|
boolean |
isDerivedFrom(ClassNode type) @param type the ClassNode of interest |
|
boolean |
isDerivedFromGroovyObject() @return true if this class is derived from a groovy object i.e. it implements GroovyObject |
|
boolean |
isEnum() |
|
boolean |
isGenericsPlaceHolder() |
|
boolean |
isInterface() |
|
boolean |
isPrimaryClassNode() @return true if this instance is a primary ClassNode |
|
boolean |
isRedirectNode() |
|
boolean |
isResolved() |
|
boolean |
isScript() |
|
boolean |
isScriptBody() @return Returns true if this inner class or closure was declared inside a script body |
|
boolean |
isStaticClass() Is this class declared in a static method (such as a closure / inner class declared in a static method) |
|
boolean |
isSyntheticPublic() Indicates that this class has been "promoted" to public by Groovy when in fact there was no public modifier explicitly in the source code. |
|
boolean |
isUsingGenerics() |
|
ClassNode |
makeArray() Returns a ClassNode representing an array of the class represented by this ClassNode |
|
protected boolean |
parametersEqual(Parameter[] a, Parameter[] b) @return true if the two arrays are of the same size and have the same contents |
|
void |
positionStmtsAfterEnumInitStmts(List<Statement> staticFieldStatements) |
|
ClassNode |
redirect() Returns the ClassNode this ClassNode is redirecting to. |
|
void |
removeConstructor(ConstructorNode node) |
|
void |
removeField(String oldName) |
|
void |
removeMethod(MethodNode node) |
|
void |
renameField(String oldName, String newName) |
|
void |
setAnnotated(boolean flag) Marks if the current class uses annotations or not |
|
protected void |
setCompileUnit(CompileUnit cu) |
|
void |
setEnclosingMethod(MethodNode enclosingMethod) |
|
void |
setGenericsPlaceHolder(boolean b) |
|
void |
setGenericsTypes(GenericsType[] genericsTypes) |
|
void |
setInterfaces(ClassNode[] interfaces) |
|
void |
setModifiers(int modifiers) |
|
void |
setModule(ModuleNode module) |
|
String |
setName(String name) |
|
void |
setRedirect(ClassNode cn) Sets this instance as proxy for the given ClassNode. |
|
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) |
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, getNodeMetaData, getText, putNodeMetaData, removeNodeMetaData, setColumnNumber, setLastColumnNumber, setLastLineNumber, setLineNumber, setNodeMetaData, setSourcePosition, visit |
class Object |
wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll |
Creates a ClassNode from a real class. The resulting ClassNode will not be a primary ClassNode.
name
- is the full name of the classmodifiers
- the modifiers,superClass
- the base class name - use "java.lang.Object" if no direct
base class
name
- is the full name of the classmodifiers
- the modifiers,superClass
- the base class name - use "java.lang.Object" if no direct
base classinterfaces
- the interfaces for this classmixins
- the mixins for this classIf a method with the given name and parameters is already defined then it is returned otherwise the given method is added to this node. This method is useful for default method adding like getProperty() or invokeMethod() where there may already be a method defined in a class and so the default implementations should not be added if already present.
Adds a statement to the object initializer.
statements
- the statement to be addedAdds a synthetic method as part of the compilation process
classNode
- the class node for the interface
Finds a constructor matching the given parameters in this class.
Finds a field matching the given name in this class.
name
- the name of the field of interestFinds a method matching the given name and parameters in this class.
This methods returns a list of all methods of the given name defined in the current class
Finds a field matching the given name in this class or a parent class.
name
- the name of the field of interest
Finds a method matching the given name and parameters in this class or any parent class.
This methods creates a list of all methods with this name of the current class and of all super classes
Helper method to avoid casting to inner class
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 true if the given method has a possibly matching instance method with the given name and arguments.
name
- the name of the method of interestarguments
- the arguments to match againstReturns true if the given method has a possibly matching static method with the given name and arguments.
name
- the name of the method of interestarguments
- the arguments to match against
classNode
- the class node for the interface
type
- the ClassNode of interest
Is this class declared in a static method (such as a closure / inner class declared in a static method)
Indicates that this class has been "promoted" to public by Groovy when in fact there was no public modifier explicitly in the source code. I.e. it remembers that it has applied Groovy's "public classes by default" rule.This property is typically only of interest to AST transform writers.
Returns a ClassNode representing an array of the class represented by this ClassNode
Returns the ClassNode this ClassNode is redirecting to.
Marks if the current class uses annotations or not
Sets this instance as proxy for the given ClassNode.
cn
- the class to redirect to. If set to null the redirect will be removedSets the superclass of this ClassNode