Class ClassNode
- All Implemented Interfaces:
GroovydocHolder<AnnotatedNode>,NodeMetaDataHandler
- Direct Known Subclasses:
DecompiledClassNode,InnerClassNode,MixinNode,WideningCategories.LowestUpperBoundClassNode
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:
- 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. - 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 - Labels:
ClassNodes created through ClassHelper.makeWithoutCaching. They are placeholders, 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.
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.
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected Classstatic final ClassNode[]protected List<InnerClassNode>protected booleanprotected final Objectstatic final ClassNodestatic final ClassNodeFields inherited from interface groovy.lang.groovydoc.GroovydocHolder
DOC_COMMENT -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddConstructor(int modifiers, Parameter[] parameters, ClassNode[] exceptions, Statement code) voidaddField(String name, int modifiers, ClassNode type, Expression initialValue) voidaddFieldFirst(String name, int modifiers, ClassNode type, Expression initialValue) voidaddFieldFirst(FieldNode node) voidaddInterface(ClassNode type) 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.voidaddMethod(MethodNode node) voidvoidaddObjectInitializerStatements(Statement statements) Adds a statement to the object initializer.addProperty(String name, int modifiers, ClassNode type, Expression initialValueExpression, Statement getterBlock, Statement setterBlock) voidaddProperty(PropertyNode node) voidaddStaticInitializerStatements(List<Statement> staticStatements, boolean fieldInit) addSyntheticMethod(String name, int modifiers, ClassNode returnType, Parameter[] parameters, ClassNode[] exceptions, Statement code) Adds a synthetic method as part of the compilation process.voidaddTransform(Class<? extends ASTTransformation> transform, ASTNode node) voidaddTypeAnnotation(AnnotationNode annotation) voidaddTypeAnnotations(List<AnnotationNode> annotations) booleandeclaresAnyInterfaces(ClassNode... classNodes) booleandeclaresInterface(ClassNode classNode) booleangetAnnotations(ClassNode type) getDeclaredConstructor(Parameter[] parameters) getDeclaredField(String name) Finds a field matching the given name in this class.getDeclaredMethod(String name, Parameter[] parameters) Finds a method matching the given name and parameters in this class.getDeclaredMethods(String name) This method returns a list of all methods of the given name defined in the current classFinds a field matching the given name in this class or a parent class.getGetterMethod(String getterName) getGetterMethod(String getterName, boolean searchSuperClasses) Finds a method matching the given name and parameters in this class or any parent class.getMethods(String name) This method creates a list of all methods with this name of the current class and of all super classesintgetName()getOuterField(String name) getPlainNodeReference(boolean skipPrimitives) getProperty(String name) Deprecated.Gets the record components of record type.getSetterMethod(String setterName) getSetterMethod(String setterName, boolean voidOnly) getText()Map<Class<? extends ASTTransformation>,Set<ASTNode>> getTransforms(CompilePhase phase) getTypeAnnotations(ClassNode type) Returns the concrete class this classnode relates to.getUnresolvedInterfaces(boolean useRedirect) getUnresolvedSuperClass(boolean useRedirect) booleanhasDeclaredMethod(String name, Parameter[] parameters) inthashCode()booleanbooleanbooleanhasPossibleMethod(String name, Expression arguments) Determines if the type has a possibly-matching instance method with the given name and arguments.booleanhasPossibleStaticMethod(String name, Expression arguments) Checks if the given method has a possibly matching static method with the given name and arguments.booleanhasProperty(String name) booleanimplementsAnyInterfaces(ClassNode... classNodes) booleanimplementsInterface(ClassNode classNode) booleanbooleanbooleanbooleanisArray()booleanisDerivedFrom(ClassNode type) booleanbooleanisEnum()booleanbooleanbooleanbooleanisRecord()Checks if theClassNodeinstance represents a nativerecord.booleanbooleanbooleanisScript()booleanbooleanisSealed()booleanIs this class declared in a static method (such as a closure / inner class declared in a static method)booleanIndicates that this class has been "promoted" to public by Groovy when in fact there was no public modifier explicitly in the source code.booleanReturns aClassNoderepresenting an array of the type represented by this.protected booleanparametersEqual(Parameter[] a, Parameter[] b) Deprecated.voidpositionStmtsAfterEnumInitStmts(List<Statement> staticFieldStatements) redirect()Returns theClassNodethis node is a proxy for or the node itself.voidvoidremoveField(String oldName) voidremoveMethod(MethodNode node) voidrenameField(String oldName, String newName) voidsetAnnotated(boolean annotated) Marks if the current class uses annotations or not.protected voidvoidsetEnclosingMethod(MethodNode enclosingMethod) voidsetGenericsPlaceHolder(boolean placeholder) voidsetGenericsTypes(GenericsType[] genericsTypes) voidsetInterfaces(ClassNode[] interfaces) voidvoidsetModifiers(int modifiers) voidsetModule(ModuleNode module) voidsetPermittedSubclasses(List<ClassNode> permittedSubclasses) voidsetRecordComponentNodes(List<RecordComponentNode> recordComponentNodes) Deprecated.voidsetRecordComponents(List<RecordComponentNode> recordComponents) Sets the record components for record type.voidsetRedirect(ClassNode node) Sets this instance as proxy for the givenClassNode.voidsetScript(boolean script) voidsetScriptBody(boolean scriptBody) voidsetStaticClass(boolean staticClass) voidsetSuperClass(ClassNode superClass) Sets the superclass of thisClassNode.voidsetSyntheticPublic(boolean syntheticPublic) voidsetUnresolvedSuperClass(ClassNode superClass) voidsetUsingGenerics(boolean usesGenerics) toString()toString(boolean showRedirect) tryFindPossibleMethod(String name, Expression arguments) voidvisitContents(GroovyClassVisitor visitor) Methods inherited from class org.codehaus.groovy.ast.AnnotatedNode
addAnnotation, addAnnotation, addAnnotations, getDeclaringClass, getGroovydoc, getInstance, hasNoRealSourcePosition, isSynthetic, setDeclaringClass, setHasNoRealSourcePosition, setSyntheticMethods inherited from class org.codehaus.groovy.ast.ASTNode
copyNodeMetaData, getColumnNumber, getLastColumnNumber, getLastLineNumber, getLineNumber, getMetaDataMap, setColumnNumber, setLastColumnNumber, setLastLineNumber, setLineNumber, setMetaDataMap, setSourcePosition, visitMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface org.codehaus.groovy.ast.NodeMetaDataHandler
copyNodeMetaData, getNodeMetaData, getNodeMetaData, getNodeMetaData, putNodeMetaData, removeNodeMetaData, setNodeMetaData
-
Field Details
-
EMPTY_ARRAY
-
THIS
-
SUPER
-
isPrimaryNode
protected boolean isPrimaryNode -
innerClasses
-
lazyInitLock
-
clazz
-
-
Constructor Details
-
ClassNode
Creates a non-primaryClassNodefrom a real class. -
ClassNode
- Parameters:
name- the fully-qualified name of the classmodifiers- the modifiers; seeOpcodessuperClass- the base class; use "java.lang.Object" if no direct base class
-
ClassNode
public ClassNode(String name, int modifiers, ClassNode superClass, ClassNode[] interfaces, MixinNode[] mixins) - Parameters:
name- the fully-qualified name of the classmodifiers- the modifiers; seeOpcodessuperClass- the base class; use "java.lang.Object" if no direct base classinterfaces- the interfaces for this classmixins- the mixins for this class
-
-
Method Details
-
redirect
Returns theClassNodethis node is a proxy for or the node itself. -
isRedirectNode
public boolean isRedirectNode() -
setRedirect
Sets this instance as proxy for the givenClassNode.- Parameters:
node- the class to redirect to; ifnullthe redirect is removed
-
makeArray
Returns aClassNoderepresenting an array of the type represented by this. -
isPrimaryClassNode
public boolean isPrimaryClassNode()- Returns:
trueif this instance is a primaryClassNode
-
getEnclosingMethod
-
setEnclosingMethod
-
isSyntheticPublic
public 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. That is, 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:
trueif node is public but had no explicit public modifier
-
setSyntheticPublic
public void setSyntheticPublic(boolean syntheticPublic) -
setSuperClass
Sets the superclass of thisClassNode. -
getFields
- Returns:
- the fields associated with this
ClassNode
-
getInterfaces
- Returns:
- the interfaces implemented by this
ClassNode
-
setInterfaces
-
getPermittedSubclasses
- Returns:
- permitted subclasses of sealed type, may initially be empty in early compiler phases
-
setPermittedSubclasses
-
getMixins
- Returns:
- the mixins associated with this
ClassNode
-
setMixins
-
getMethods
- Returns:
- the methods associated with this
ClassNode
-
getAbstractMethods
- Returns:
- the abstract methods associated with this
ClassNode
-
getAllDeclaredMethods
-
getAllInterfaces
-
getDeclaredMethodsMap
-
getName
-
getUnresolvedName
-
setName
-
getModifiers
public int getModifiers() -
setModifiers
public void setModifiers(int modifiers) -
getProperties
-
getDeclaredConstructors
-
getDeclaredConstructor
- Returns:
- the constructor matching the given parameters or
null
-
removeConstructor
-
getModule
-
getPackage
-
setModule
-
addField
-
addFieldFirst
-
getFieldIndex
-
addProperty
-
addProperty
public PropertyNode addProperty(String name, int modifiers, ClassNode type, Expression initialValueExpression, Statement getterBlock, Statement setterBlock) -
hasProperty
-
getProperty
-
addConstructor
-
addConstructor
public ConstructorNode addConstructor(int modifiers, Parameter[] parameters, ClassNode[] exceptions, Statement code) -
addMethod
-
removeMethod
-
addMethod
public 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. 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. -
hasDeclaredMethod
- See Also:
-
hasMethod
- See Also:
-
addSyntheticMethod
public MethodNode addSyntheticMethod(String name, int modifiers, ClassNode returnType, Parameter[] parameters, ClassNode[] exceptions, Statement code) Adds a synthetic method as part of the compilation process. -
addField
-
addFieldFirst
-
addInterface
-
equals
-
hashCode
public int hashCode() -
addMixin
-
getDeclaredField
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
-
getField
Finds a field matching the given name in this class or a parent class.- Parameters:
name- the name of the field of interest- Returns:
- the method matching the given name and parameters or null
-
getOuterField
- Returns:
- the field on the outer class or
nullif this is not an inner class
-
getOuterClass
-
getOuterClasses
-
addObjectInitializerStatements
Adds a statement to the object initializer.- Parameters:
statements- the statement to be added
-
getObjectInitializerStatements
-
addStaticInitializerStatements
-
positionStmtsAfterEnumInitStmts
-
getDeclaredMethods
This method returns a list of all methods of the given name defined in the current class- Returns:
- the method list
- See Also:
-
getMethods
This method creates a list of all methods with this name of the current class and of all super classes- Returns:
- the methods list
- See Also:
-
getDeclaredMethod
Finds a method matching the given name and parameters in this class.- Returns:
- the method matching the given name and parameters or null
-
getMethod
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
-
isDerivedFrom
- Parameters:
type- the ClassNode of interest- Returns:
- true if this node is derived from the given ClassNode
-
isDerivedFromGroovyObject
public boolean isDerivedFromGroovyObject()- Returns:
trueif this type implementsGroovyObject
-
implementsAnyInterfaces
- Parameters:
classNodes- the class nodes for the interfaces- Returns:
trueif this type implements any of the given interfaces
-
implementsInterface
- Parameters:
classNode- the class node for the interface- Returns:
trueif this type implements the given interface
-
declaresAnyInterfaces
- Parameters:
classNodes- the class nodes for the interfaces- Returns:
trueif this type declares that it implements any of the given interfaces or if one of its interfaces extends directly/indirectly any of the given interfaces
-
declaresInterface
- Parameters:
classNode- the class node for the interface- Returns:
trueif this class declares that it implements the given interface or if one of its interfaces extends directly/indirectly the interface NOTE: Doesn't consider an interface to implement itself. I think this is intended to be called on ClassNodes representing classes, not interfaces.- See Also:
-
getSuperClass
- Returns:
- the
ClassNodeof the super class of this type
-
getUnresolvedSuperClass
-
getUnresolvedSuperClass
-
setUnresolvedSuperClass
-
getUnresolvedInterfaces
-
getUnresolvedInterfaces
-
getCompileUnit
-
setCompileUnit
-
parametersEqual
Deprecated. -
getPackageName
-
getNameWithoutPackage
-
visitContents
-
getGetterMethod
-
getGetterMethod
-
getSetterMethod
-
getSetterMethod
-
isStaticClass
public boolean isStaticClass()Is this class declared in a static method (such as a closure / inner class declared in a static method) -
setStaticClass
public void setStaticClass(boolean staticClass) -
isScriptBody
public boolean isScriptBody()- Returns:
trueif this inner class or closure was declared inside a script body
-
setScriptBody
public void setScriptBody(boolean scriptBody) -
isScript
public boolean isScript() -
setScript
public void setScript(boolean script) -
toString
-
toString
-
hasPossibleMethod
Determines if the type has a possibly-matching instance method with the given name and arguments.- Parameters:
name- the name of the method of interestarguments- the arguments to match against- Returns:
- true if a matching method was found
-
tryFindPossibleMethod
-
hasPossibleStaticMethod
Checks if the given method has a possibly matching static method with the given name and arguments.- Parameters:
name- the name of the method of interestarguments- the arguments to match against- Returns:
trueif a matching method was found
-
isInterface
public boolean isInterface() -
isRecord
Checks if theClassNodeinstance represents a nativerecord. Check instead for theRecordBaseannotation if looking for records and record-like classes currently being compiled.- Returns:
trueif the instance represents a nativerecord- Since:
- 4.0.0
-
getRecordComponents
Gets the record components of record type.- Returns:
RecordComponentNodeinstances- Since:
- 4.0.0
-
getRecordComponentNodes
Deprecated. -
setRecordComponents
Sets the record components for record type.- Since:
- 4.0.0
-
setRecordComponentNodes
Deprecated. -
isAbstract
public boolean isAbstract() -
isSealed
- Returns:
truefor native and emulated (annotation based) sealed classes- Since:
- 4.0.0
-
isResolved
public boolean isResolved() -
isArray
public boolean isArray() -
getComponentType
-
getTypeClass
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 usinggetPlainNodeReference().- Returns:
- the class this classnode relates to. May return null.
-
hasPackageName
public boolean hasPackageName() -
setAnnotated
public void setAnnotated(boolean annotated) Marks if the current class uses annotations or not. -
isAnnotated
public boolean isAnnotated() -
asGenericsType
-
getGenericsTypes
-
setGenericsTypes
-
setGenericsPlaceHolder
public void setGenericsPlaceHolder(boolean placeholder) -
isGenericsPlaceHolder
public boolean isGenericsPlaceHolder() -
isUsingGenerics
public boolean isUsingGenerics() -
setUsingGenerics
public void setUsingGenerics(boolean usesGenerics) -
getPlainNodeReference
-
getPlainNodeReference
-
isAnnotationDefinition
public boolean isAnnotationDefinition() -
getAnnotations
- Overrides:
getAnnotationsin classAnnotatedNode
-
getAnnotations
- Overrides:
getAnnotationsin classAnnotatedNode
-
addTransform
-
getTransforms
-
renameField
-
removeField
-
isEnum
public boolean isEnum() -
getInnerClasses
- Returns:
- iterator of inner classes defined inside this one
-
getText
-
getTypeAnnotations
-
getTypeAnnotations
-
addTypeAnnotation
-
addTypeAnnotations
-