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 Class<?>static final ClassNode[]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 node) 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 statement) Adds a statement to the object initializer.addProperty(String name, int modifiers, ClassNode type, Expression initialValue, Statement getterBlock, Statement setterBlock) voidaddProperty(PropertyNode node) voidaddStaticInitializerStatements(List<Statement> statements, 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) Returns a list of all methods with the given name from this class.The enclosing method of local inner class.Finds a field matching the given name in this class or a parent class.Deprecated, for removal: This API element is subject to removal in a future version.getGetterMethod(String getterName) getGetterMethod(String getterName, boolean searchSupers) Finds a method matching the given name and parameters in this class or any super class.getMethods(String name) Returns a list of all methods with the given name from this class and its super class(es).intgetName()getOuterField(String name) getPlainNodeReference(boolean skipPrimitives) getProperty(String name) 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 deref) getUnresolvedSuperClass(boolean deref) 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, for removal: This API element is subject to removal in a future version.voidpositionStmtsAfterEnumInitStmts(List<Statement> staticFieldInitializerStatements) 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) protected voidDeprecated, for removal: This API element is subject to removal in a future version.voidsetEnclosingMethod(MethodNode enclosingMethod) voidsetGenericsPlaceHolder(boolean placeholder) voidsetGenericsTypes(GenericsType[] genericsTypes) voidsetInterfaces(ClassNode[] interfaces) voidvoidsetModifiers(int modifiers) voidsetModule(ModuleNode module) voidsetPermittedSubclasses(List<ClassNode> permittedSubclasses) 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) 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, newMetaDataMap, putNodeMetaData, removeNodeMetaData, setNodeMetaData
-
Field Details
-
EMPTY_ARRAY
-
THIS
-
SUPER
-
isPrimaryNode
protected boolean isPrimaryNode -
lazyInitLock
-
clazz
-
-
Constructor Details
-
ClassNode
public ClassNode(String name, int modifiers, ClassNode superClass, ClassNode[] interfaces, MixinNode[] mixins) - Parameters:
name- the fully-qualified name of the classmodifiers- the modifiers; seeModifierorOpcodessuperClass- the base class; use "java.lang.Object" if no direct base classinterfaces- the interfacesmixins- the mixins
-
ClassNode
- Parameters:
name- the fully-qualified name of the classmodifiers- the modifiers; seeModifierorOpcodessuperClass- the base class; use "java.lang.Object" if no direct base class
-
ClassNode
Creates a non-primaryClassNodefrom a real 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
-
isPrimaryClassNode
public boolean isPrimaryClassNode()- Returns:
trueif this instance is a primaryClassNode
-
getPlainNodeReference
-
getPlainNodeReference
-
getModule
-
setModule
-
getCompileUnit
-
setCompileUnit
Deprecated, for removal: This API element is subject to removal in a future version. -
getPackage
-
getPackageName
-
hasPackageName
public boolean hasPackageName() -
getNameWithoutPackage
-
getUnresolvedName
-
getUnresolvedSuperClass
-
getUnresolvedSuperClass
-
setUnresolvedSuperClass
-
getUnresolvedInterfaces
-
getUnresolvedInterfaces
-
getText
-
getName
-
setName
-
getModifiers
public int getModifiers() -
setModifiers
public void setModifiers(int modifiers) -
getSuperClass
- Returns:
- the
ClassNodeof the super class of this type
-
setSuperClass
-
getInterfaces
- Returns:
- the interfaces implemented by this
ClassNode
-
getAllInterfaces
-
setInterfaces
-
getMixins
- Returns:
- the mixins associated with this
ClassNode
-
setMixins
-
getPermittedSubclasses
- Returns:
- permitted subclasses of sealed type, may initially be empty in early compiler phases
-
setPermittedSubclasses
-
getRecordComponents
Gets the record components of record type.- Returns:
RecordComponentNodeinstances- Since:
- 4.0.0
-
setRecordComponents
Sets the record components for record type.- Since:
- 4.0.0
-
addInterface
-
addMixin
-
addField
-
addField
-
addFieldFirst
-
addFieldFirst
-
addProperty
-
addProperty
public PropertyNode addProperty(String name, int modifiers, ClassNode type, Expression initialValue, Statement getterBlock, Statement setterBlock) -
addMethod
-
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. -
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. -
addConstructor
-
addConstructor
public ConstructorNode addConstructor(int modifiers, Parameter[] parameters, ClassNode[] exceptions, Statement code) -
addObjectInitializerStatements
Adds a statement to the object initializer.- Parameters:
statement- the statement to be added
-
addStaticInitializerStatements
-
positionStmtsAfterEnumInitStmts
-
getFields
- Returns:
- the fields associated with this
ClassNode
-
getProperties
-
getFieldIndex
Deprecated, for removal: This API element is subject to removal in a future version. -
hasProperty
-
getProperty
-
getMethods
- Returns:
- the methods associated with this
ClassNode
-
getAbstractMethods
- Returns:
- the abstract methods associated with this
ClassNode
-
getAllDeclaredMethods
-
getDeclaredMethodsMap
-
getDeclaredConstructors
-
getDeclaredConstructor
- Returns:
- the constructor matching the given parameters or
null
-
hasMethod
- See Also:
-
hasDeclaredMethod
- See Also:
-
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
-
getObjectInitializerStatements
-
getDeclaredMethods
Returns a list of all methods with the given name from this class.- Returns:
- method list (possibly empty)
- See Also:
-
getMethods
Returns a list of all methods with the given name from this class and its super class(es).- Returns:
- method list (possibly empty)
- See Also:
-
getDeclaredMethod
Finds a method matching the given name and parameters in this class.- Returns:
- method node or null
-
getMethod
Finds a method matching the given name and parameters in this class or any super class.- Returns:
- method node 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:
-
parametersEqual
@Deprecated(forRemoval=true, since="4.0.0") protected boolean parametersEqual(Parameter[] a, Parameter[] b) Deprecated, for removal: This API element is subject to removal in a future version. -
getGetterMethod
-
getGetterMethod
-
getSetterMethod
-
getSetterMethod
-
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
-
renameField
-
removeField
-
removeMethod
-
removeConstructor
-
equals
-
hashCode
public int hashCode() -
toString
-
toString
-
visitContents
-
isAbstract
public boolean isAbstract() -
isInterface
public boolean isInterface() -
isAnnotationDefinition
public boolean isAnnotationDefinition() -
isEnum
public boolean isEnum() -
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
-
isSealed
- Returns:
truefor native and emulated (annotation based) sealed classes- Since:
- 4.0.0
-
isResolved
public boolean isResolved() -
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.
-
isArray
public boolean isArray() -
makeArray
Returns aClassNoderepresenting an array of the type represented by this. -
getComponentType
-
getOuterClass
-
getOuterClasses
-
getOuterField
- Returns:
- the field on the outer class or
nullif this is not an inner class
-
getInnerClasses
- Returns:
- iterator of inner classes defined inside this one
-
getEnclosingMethod
The enclosing method of local inner class. -
setEnclosingMethod
-
asGenericsType
-
getGenericsTypes
-
setGenericsTypes
-
isGenericsPlaceHolder
public boolean isGenericsPlaceHolder() -
setGenericsPlaceHolder
public void setGenericsPlaceHolder(boolean placeholder) -
isUsingGenerics
public boolean isUsingGenerics() -
setUsingGenerics
public void setUsingGenerics(boolean usesGenerics) -
isScript
public boolean isScript() -
setScript
public void setScript(boolean script) -
isScriptBody
public boolean isScriptBody()- Returns:
trueif this inner class or closure was declared inside a script body
-
setScriptBody
public void setScriptBody(boolean scriptBody) -
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) -
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) -
isAnnotated
public boolean isAnnotated() -
setAnnotated
public void setAnnotated(boolean annotated) -
getAnnotations
- Overrides:
getAnnotationsin classAnnotatedNode
-
getAnnotations
- Overrides:
getAnnotationsin classAnnotatedNode
-
getTypeAnnotations
-
getTypeAnnotations
-
addTypeAnnotation
-
addTypeAnnotations
-
addTransform
-
getTransforms
-