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 |
Constructor and description |
---|
ClassNode(Class<?> c) Creates a non-primary ClassNode from a real class. |
ClassNode(String name, int modifiers, ClassNode superClass)
|
ClassNode(String name, int modifiers, ClassNode superClass, ClassNode[] interfaces, MixinNode[] mixins)
|
Type Params | Return Type | Name and description |
---|---|---|
|
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) 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. |
|
public void |
addMixin(MixinNode mixin) |
|
public void |
addObjectInitializerStatements(Statement statements) Adds a statement to the object initializer. |
|
public void |
addProperty(PropertyNode node) |
|
public PropertyNode |
addProperty(String name, int modifiers, ClassNode type, Expression initialValueExpression, Statement getterBlock, Statement setterBlock) |
|
public void |
addStaticInitializerStatements(List<Statement> staticStatements, boolean fieldInit) |
|
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. |
|
public void |
addTransform(Class<? extends ASTTransformation> transform, ASTNode node) |
|
public void |
addTypeAnnotation(AnnotationNode annotation) |
|
public void |
addTypeAnnotations(List<AnnotationNode> annotations) |
|
public GenericsType |
asGenericsType() |
|
public boolean |
declaresAnyInterfaces(ClassNode classNodes)
|
|
public boolean |
declaresInterface(ClassNode classNode)
|
|
public boolean |
equals(Object that) |
|
public List<MethodNode> |
getAbstractMethods()
|
|
public List<MethodNode> |
getAllDeclaredMethods() |
|
public Set<ClassNode> |
getAllInterfaces() |
|
public List<AnnotationNode> |
getAnnotations() |
|
public List<AnnotationNode> |
getAnnotations(ClassNode type) |
|
public CompileUnit |
getCompileUnit() |
|
public ClassNode |
getComponentType() |
|
public ConstructorNode |
getDeclaredConstructor(Parameter[] parameters)
|
|
public List<ConstructorNode> |
getDeclaredConstructors() |
|
public FieldNode |
getDeclaredField(String name) Finds a field matching the given name in this class. |
|
public MethodNode |
getDeclaredMethod(String name, Parameter[] parameters) Finds a method matching the given name and parameters in this class. |
|
public List<MethodNode> |
getDeclaredMethods(String name) Returns a list of all methods with the given name from this class. |
|
public Map<String, MethodNode> |
getDeclaredMethodsMap() |
|
public MethodNode |
getEnclosingMethod() |
|
public FieldNode |
getField(String name) Finds a field matching the given name in this class or a parent class. |
|
public Map<String, FieldNode> |
getFieldIndex() |
|
public List<FieldNode> |
getFields()
|
|
public GenericsType[] |
getGenericsTypes() |
|
public MethodNode |
getGetterMethod(String getterName) |
|
public MethodNode |
getGetterMethod(String getterName, boolean searchSuperClasses) |
|
public Iterator<InnerClassNode> |
getInnerClasses()
|
|
public ClassNode[] |
getInterfaces()
|
|
public MethodNode |
getMethod(String name, Parameter[] parameters) Finds a method matching the given name and parameters in this class or any super class. |
|
public List<MethodNode> |
getMethods()
|
|
public List<MethodNode> |
getMethods(String name) Returns a list of all methods with the given name from this class and its super class(es). |
|
public MixinNode[] |
getMixins()
|
|
public int |
getModifiers() |
|
public ModuleNode |
getModule() |
|
public String |
getName() |
|
public String |
getNameWithoutPackage() |
|
public List<Statement> |
getObjectInitializerStatements() |
|
public ClassNode |
getOuterClass() |
|
public List<ClassNode> |
getOuterClasses() |
|
public FieldNode |
getOuterField(String name)
|
|
public PackageNode |
getPackage() |
|
public String |
getPackageName() |
|
public List<ClassNode> |
getPermittedSubclasses()
|
|
public ClassNode |
getPlainNodeReference(boolean skipPrimitives) |
|
public ClassNode |
getPlainNodeReference() |
|
public List<PropertyNode> |
getProperties() |
|
public PropertyNode |
getProperty(String name) |
|
public List<RecordComponentNode> |
getRecordComponentNodes() |
|
public List<RecordComponentNode> |
getRecordComponents() Gets the record components of record type. |
|
public MethodNode |
getSetterMethod(String setterName) |
|
public MethodNode |
getSetterMethod(String setterName, boolean voidOnly) |
|
public ClassNode |
getSuperClass()
|
|
public String |
getText() |
|
public Map<Class<? extends ASTTransformation>, Set<ASTNode>> |
getTransforms(CompilePhase phase) |
|
public List<AnnotationNode> |
getTypeAnnotations() |
|
public List<AnnotationNode> |
getTypeAnnotations(ClassNode type) |
|
public Class |
getTypeClass() Returns the concrete class this classnode relates to. |
|
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) |
|
public boolean |
hasMethod(String name, Parameter[] parameters)
|
|
public boolean |
hasPackageName() |
|
public boolean |
hasPossibleMethod(String name, Expression arguments) Determines if the type has a possibly-matching instance method with the given name and arguments. |
|
public boolean |
hasPossibleStaticMethod(String name, Expression arguments) Checks if the given method has a possibly matching static method with the given name and arguments. |
|
public boolean |
hasProperty(String name) |
|
public int |
hashCode() |
|
public boolean |
implementsAnyInterfaces(ClassNode classNodes)
|
|
public boolean |
implementsInterface(ClassNode classNode)
|
|
public boolean |
isAbstract() |
|
public boolean |
isAnnotated() |
|
public boolean |
isAnnotationDefinition() |
|
public boolean |
isArray() |
|
public boolean |
isDerivedFrom(ClassNode type)
|
|
public boolean |
isDerivedFromGroovyObject()
|
|
public boolean |
isEnum() |
|
public boolean |
isGenericsPlaceHolder() |
|
public boolean |
isInterface() |
|
public boolean |
isPrimaryClassNode()
|
|
public boolean |
isRecord() Checks if the ClassNode instance represents a native record .
|
|
public boolean |
isRedirectNode() |
|
public boolean |
isResolved() |
|
public boolean |
isScript() |
|
public boolean |
isScriptBody()
|
|
public boolean |
isSealed()
|
|
public boolean |
isStaticClass() Is this class declared in a static method (such as a closure / inner class declared in a static method) |
|
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. |
|
public boolean |
isUsingGenerics() |
|
public ClassNode |
makeArray() Returns a ClassNode representing an array of the type represented
by this. |
|
protected boolean |
parametersEqual(Parameter[] a, Parameter[] b) |
|
public void |
positionStmtsAfterEnumInitStmts(List<Statement> staticFieldStatements) |
|
public ClassNode |
redirect() Returns the ClassNode this node is a proxy for or the node itself. |
|
public void |
removeConstructor(ConstructorNode node) |
|
public void |
removeField(String oldName) |
|
public void |
removeMethod(MethodNode node) |
|
public void |
renameField(String oldName, String newName) |
|
public void |
setAnnotated(boolean annotated) Marks if the current class uses annotations or not. |
|
protected void |
setCompileUnit(CompileUnit cu) |
|
public void |
setEnclosingMethod(MethodNode enclosingMethod) |
|
public void |
setGenericsPlaceHolder(boolean placeholder) |
|
public void |
setGenericsTypes(GenericsType[] genericsTypes) |
|
public void |
setInterfaces(ClassNode[] interfaces) |
|
public void |
setMixins(MixinNode[] mixins) |
|
public void |
setModifiers(int modifiers) |
|
public void |
setModule(ModuleNode module) |
|
public String |
setName(String name) |
|
public void |
setPermittedSubclasses(List<ClassNode> permittedSubclasses) |
|
public void |
setRecordComponentNodes(List<RecordComponentNode> recordComponentNodes) |
|
public void |
setRecordComponents(List<RecordComponentNode> recordComponents) Sets the record components for record type. |
|
public void |
setRedirect(ClassNode node) Sets this instance as proxy for the given ClassNode . |
|
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 superClass) |
|
public void |
setUsingGenerics(boolean usesGenerics) |
|
public String |
toString() |
|
public String |
toString(boolean showRedirect) |
|
public MethodNode |
tryFindPossibleMethod(String name, Expression arguments) |
|
public void |
visitContents(GroovyClassVisitor visitor) |
Methods inherited from class | Name |
---|---|
class AnnotatedNode |
addAnnotation, addAnnotation, addAnnotations, getAnnotations, getAnnotations, getDeclaringClass, getGroovydoc, getInstance, hasNoRealSourcePosition, isSynthetic, setDeclaringClass, setHasNoRealSourcePosition, setSynthetic |
class ASTNode |
copyNodeMetaData, getColumnNumber, getLastColumnNumber, getLastLineNumber, getLineNumber, getMetaDataMap, getText, setColumnNumber, setLastColumnNumber, setLastLineNumber, setLineNumber, setMetaDataMap, setSourcePosition, visit |
Creates a non-primary ClassNode
from a real class.
name
- the fully-qualified name of the classmodifiers
- the modifiers; see org.objectweb.asm.OpcodessuperClass
- the base class; use "java.lang.Object" if no direct base class
name
- the fully-qualified name of the classmodifiers
- the modifiers; see org.objectweb.asm.OpcodessuperClass
- the base class; 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.
classNodes
- the class nodes for the interfacestrue
if 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
classNode
- the class node for the interfacetrue
if 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.
ClassNode
null
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.
Returns a list of all methods with the given name from this class.
Finds a field matching the given name in this class or a parent class.
name
- the name of the field of interest
ClassNode
Finds a method matching the given name and parameters in this class or any super class.
ClassNode
Returns a list of all methods with the given name from this class and its super class(es).
ClassNode
null
if this is not an inner class
Gets the record components of record type.
RecordComponentNode
instances
ClassNode
of the super class of this typeReturns 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().
Determines if the type has a possibly-matching instance method with the given name and arguments.
name
- the name of the method of interestarguments
- the arguments to match againstChecks 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 againsttrue
if a matching method was found
classNodes
- the class nodes for the interfacestrue
if this type implements any of the given interfaces
classNode
- the class node for the interfacetrue
if this type implements the given interface
type
- the ClassNode of interest
true
if this type implements GroovyObject
true
if this instance is a primary ClassNode
Checks if the ClassNode instance represents a native record
.
Check instead for the RecordBase
annotation if looking for records and
record-like classes currently being compiled.
true
if the instance represents a native record
true
if this inner class or closure was declared inside a script body
true
for native and emulated (annotation based) sealed classesIs 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. 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.
true
if node is public but had no explicit public modifier Returns a ClassNode
representing an array of the type represented
by this.
Returns the ClassNode
this node is a proxy for or the node itself.
Marks if the current class uses annotations or not.
Sets the record components for record type.
Sets this instance as proxy for the given ClassNode
.
node
- the class to redirect to; if null
the redirect is removed Sets the superclass of this ClassNode
.
Copyright © 2003-2024 The Apache Software Foundation. All rights reserved.