public class ClassNode extends AnnotatedNode implements org.objectweb.asm.Opcodes
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.
ClassHelper
Modifier and Type | Field and Description |
---|---|
protected Class |
clazz |
static ClassNode[] |
EMPTY_ARRAY |
protected List<InnerClassNode> |
innerClasses |
protected boolean |
isPrimaryNode |
protected Object |
lazyInitLock |
static ClassNode |
SUPER |
static ClassNode |
THIS |
AALOAD, AASTORE, ACC_ABSTRACT, ACC_ANNOTATION, ACC_BRIDGE, ACC_DEPRECATED, ACC_ENUM, ACC_FINAL, ACC_INTERFACE, ACC_MANDATED, ACC_NATIVE, ACC_PRIVATE, ACC_PROTECTED, ACC_PUBLIC, ACC_STATIC, ACC_STRICT, ACC_SUPER, ACC_SYNCHRONIZED, ACC_SYNTHETIC, ACC_TRANSIENT, ACC_VARARGS, ACC_VOLATILE, ACONST_NULL, ALOAD, ANEWARRAY, ARETURN, ARRAYLENGTH, ASM4, ASM5, ASTORE, ATHROW, BALOAD, BASTORE, BIPUSH, CALOAD, CASTORE, CHECKCAST, D2F, D2I, D2L, DADD, DALOAD, DASTORE, DCMPG, DCMPL, DCONST_0, DCONST_1, DDIV, DLOAD, DMUL, DNEG, DOUBLE, DREM, DRETURN, DSTORE, DSUB, DUP, DUP_X1, DUP_X2, DUP2, DUP2_X1, DUP2_X2, F_APPEND, F_CHOP, F_FULL, F_NEW, F_SAME, F_SAME1, F2D, F2I, F2L, FADD, FALOAD, FASTORE, FCMPG, FCMPL, FCONST_0, FCONST_1, FCONST_2, FDIV, FLOAD, FLOAT, FMUL, FNEG, FREM, FRETURN, FSTORE, FSUB, GETFIELD, GETSTATIC, GOTO, H_GETFIELD, H_GETSTATIC, H_INVOKEINTERFACE, H_INVOKESPECIAL, H_INVOKESTATIC, H_INVOKEVIRTUAL, H_NEWINVOKESPECIAL, H_PUTFIELD, H_PUTSTATIC, I2B, I2C, I2D, I2F, I2L, I2S, IADD, IALOAD, IAND, IASTORE, ICONST_0, ICONST_1, ICONST_2, ICONST_3, ICONST_4, ICONST_5, ICONST_M1, IDIV, IF_ACMPEQ, IF_ACMPNE, IF_ICMPEQ, IF_ICMPGE, IF_ICMPGT, IF_ICMPLE, IF_ICMPLT, IF_ICMPNE, IFEQ, IFGE, IFGT, IFLE, IFLT, IFNE, IFNONNULL, IFNULL, IINC, ILOAD, IMUL, INEG, INSTANCEOF, INTEGER, INVOKEDYNAMIC, INVOKEINTERFACE, INVOKESPECIAL, INVOKESTATIC, INVOKEVIRTUAL, IOR, IREM, IRETURN, ISHL, ISHR, ISTORE, ISUB, IUSHR, IXOR, JSR, L2D, L2F, L2I, LADD, LALOAD, LAND, LASTORE, LCMP, LCONST_0, LCONST_1, LDC, LDIV, LLOAD, LMUL, LNEG, LONG, LOOKUPSWITCH, LOR, LREM, LRETURN, LSHL, LSHR, LSTORE, LSUB, LUSHR, LXOR, MONITORENTER, MONITOREXIT, MULTIANEWARRAY, NEW, NEWARRAY, NOP, NULL, POP, POP2, PUTFIELD, PUTSTATIC, RET, RETURN, SALOAD, SASTORE, SIPUSH, SWAP, T_BOOLEAN, T_BYTE, T_CHAR, T_DOUBLE, T_FLOAT, T_INT, T_LONG, T_SHORT, TABLESWITCH, TOP, UNINITIALIZED_THIS, V1_1, V1_2, V1_3, V1_4, V1_5, V1_6, V1_7, V1_8
Constructor and Description |
---|
ClassNode(Class c)
Creates a ClassNode from a real class.
|
ClassNode(String name,
int modifiers,
ClassNode superClass) |
ClassNode(String name,
int modifiers,
ClassNode superClass,
ClassNode[] interfaces,
MixinNode[] mixins) |
Modifier and Type | Method and Description |
---|---|
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) |
boolean |
equals(Object o) |
List<MethodNode> |
getAbstractMethods() |
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() |
GenericsType[] |
getGenericsTypes() |
MethodNode |
getGetterMethod(String getterName) |
Iterator<InnerClassNode> |
getInnerClasses() |
ClassNode[] |
getInterfaces() |
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() |
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() |
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) |
PackageNode |
getPackage() |
String |
getPackageName() |
ClassNode |
getPlainNodeReference() |
List<PropertyNode> |
getProperties() |
PropertyNode |
getProperty(String name) |
MethodNode |
getSetterMethod(String setterName) |
MethodNode |
getSetterMethod(String setterName,
boolean voidOnly) |
ClassNode |
getSuperClass() |
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) |
int |
hashCode() |
boolean |
hasMethod(String name,
Parameter[] parameters) |
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) |
boolean |
implementsInterface(ClassNode classNode) |
boolean |
isAnnotated() |
boolean |
isAnnotationDefinition() |
boolean |
isArray() |
boolean |
isDerivedFrom(ClassNode type) |
boolean |
isDerivedFromGroovyObject() |
boolean |
isEnum() |
boolean |
isGenericsPlaceHolder() |
boolean |
isInterface() |
boolean |
isPrimaryClassNode() |
boolean |
isRedirectNode() |
boolean |
isResolved() |
boolean |
isScript() |
boolean |
isScriptBody() |
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) |
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) |
addAnnotation, addAnnotations, getDeclaringClass, hasNoRealSourcePosition, isSynthetic, setDeclaringClass, setHasNoRealSourcePosition, setSynthetic
copyNodeMetaData, getColumnNumber, getLastColumnNumber, getLastLineNumber, getLineNumber, getNodeMetaData, getNodeMetaData, putNodeMetaData, removeNodeMetaData, setColumnNumber, setLastColumnNumber, setLastLineNumber, setLineNumber, setNodeMetaData, setSourcePosition, visit
public static final ClassNode[] EMPTY_ARRAY
public static final ClassNode THIS
public static final ClassNode SUPER
protected boolean isPrimaryNode
protected List<InnerClassNode> innerClasses
protected Object lazyInitLock
protected Class clazz
public ClassNode(Class c)
public ClassNode(String name, int modifiers, ClassNode superClass)
name
- is the full name of the classmodifiers
- the modifiers,superClass
- the base class name - use "java.lang.Object" if no direct
base classOpcodes
public ClassNode(String name, int modifiers, ClassNode superClass, ClassNode[] interfaces, MixinNode[] mixins)
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 classOpcodes
public ClassNode redirect()
public void setRedirect(ClassNode cn)
cn
- the class to redirect to. If set to null the redirect will be removedpublic ClassNode makeArray()
public boolean isPrimaryClassNode()
public MethodNode getEnclosingMethod()
public void setEnclosingMethod(MethodNode enclosingMethod)
public boolean isSyntheticPublic()
public void setSyntheticPublic(boolean syntheticPublic)
public void setSuperClass(ClassNode superClass)
public List<FieldNode> getFields()
public ClassNode[] getInterfaces()
public void setInterfaces(ClassNode[] interfaces)
public MixinNode[] getMixins()
public List<MethodNode> getMethods()
public List<MethodNode> getAbstractMethods()
public List<MethodNode> getAllDeclaredMethods()
public Map<String,MethodNode> getDeclaredMethodsMap()
public String getName()
public String getUnresolvedName()
public int getModifiers()
public void setModifiers(int modifiers)
public List<PropertyNode> getProperties()
public List<ConstructorNode> getDeclaredConstructors()
public ConstructorNode getDeclaredConstructor(Parameter[] parameters)
public void removeConstructor(ConstructorNode node)
public ModuleNode getModule()
public PackageNode getPackage()
public void setModule(ModuleNode module)
public void addField(FieldNode node)
public void addFieldFirst(FieldNode node)
public void addProperty(PropertyNode node)
public PropertyNode addProperty(String name, int modifiers, ClassNode type, Expression initialValueExpression, Statement getterBlock, Statement setterBlock)
public boolean hasProperty(String name)
public PropertyNode getProperty(String name)
public void addConstructor(ConstructorNode node)
public ConstructorNode addConstructor(int modifiers, Parameter[] parameters, ClassNode[] exceptions, Statement code)
public void addMethod(MethodNode node)
public void removeMethod(MethodNode node)
public MethodNode addMethod(String name, int modifiers, ClassNode returnType, Parameter[] parameters, ClassNode[] exceptions, Statement code)
public boolean hasMethod(String name, Parameter[] parameters)
getMethod(String, Parameter[])
public MethodNode addSyntheticMethod(String name, int modifiers, ClassNode returnType, Parameter[] parameters, ClassNode[] exceptions, Statement code)
public FieldNode addField(String name, int modifiers, ClassNode type, Expression initialValue)
public FieldNode addFieldFirst(String name, int modifiers, ClassNode type, Expression initialValue)
public void addInterface(ClassNode type)
public void addMixin(MixinNode mixin)
public FieldNode getDeclaredField(String name)
name
- the name of the field of interestpublic FieldNode getField(String name)
name
- the name of the field of interestpublic FieldNode getOuterField(String name)
public ClassNode getOuterClass()
public void addObjectInitializerStatements(Statement statements)
statements
- the statement to be addedpublic void addStaticInitializerStatements(List<Statement> staticStatements, boolean fieldInit)
public void positionStmtsAfterEnumInitStmts(List<Statement> staticFieldStatements)
public List<MethodNode> getDeclaredMethods(String name)
getMethods(String)
public List<MethodNode> getMethods(String name)
getDeclaredMethods(String)
public MethodNode getDeclaredMethod(String name, Parameter[] parameters)
public MethodNode getMethod(String name, Parameter[] parameters)
public boolean isDerivedFrom(ClassNode type)
type
- the ClassNode of interestpublic boolean isDerivedFromGroovyObject()
public boolean implementsInterface(ClassNode classNode)
classNode
- the class node for the interfacepublic boolean declaresInterface(ClassNode classNode)
classNode
- the class node for the interfacepublic ClassNode getSuperClass()
public ClassNode getUnresolvedSuperClass()
public ClassNode getUnresolvedSuperClass(boolean useRedirect)
public void setUnresolvedSuperClass(ClassNode sn)
public ClassNode[] getUnresolvedInterfaces()
public ClassNode[] getUnresolvedInterfaces(boolean useRedirect)
public CompileUnit getCompileUnit()
protected void setCompileUnit(CompileUnit cu)
protected boolean parametersEqual(Parameter[] a, Parameter[] b)
public String getPackageName()
public String getNameWithoutPackage()
public void visitContents(GroovyClassVisitor visitor)
public MethodNode getGetterMethod(String getterName)
public MethodNode getSetterMethod(String setterName)
public MethodNode getSetterMethod(String setterName, boolean voidOnly)
public boolean isStaticClass()
public void setStaticClass(boolean staticClass)
public boolean isScriptBody()
public void setScriptBody(boolean scriptBody)
public boolean isScript()
public void setScript(boolean script)
public String toString(boolean showRedirect)
public boolean hasPossibleMethod(String name, Expression arguments)
name
- the name of the method of interestarguments
- the arguments to match againstpublic MethodNode tryFindPossibleMethod(String name, Expression arguments)
public boolean hasPossibleStaticMethod(String name, Expression arguments)
name
- the name of the method of interestarguments
- the arguments to match againstpublic boolean isInterface()
public boolean isResolved()
public boolean isArray()
public ClassNode getComponentType()
public Class getTypeClass()
getPlainNodeReference()
.public boolean hasPackageName()
public void setAnnotated(boolean flag)
flag
- public boolean isAnnotated()
public GenericsType[] getGenericsTypes()
public void setGenericsTypes(GenericsType[] genericsTypes)
public void setGenericsPlaceHolder(boolean b)
public boolean isGenericsPlaceHolder()
public boolean isUsingGenerics()
public void setUsingGenerics(boolean b)
public ClassNode getPlainNodeReference()
public boolean isAnnotationDefinition()
public List<AnnotationNode> getAnnotations()
getAnnotations
in class AnnotatedNode
public List<AnnotationNode> getAnnotations(ClassNode type)
getAnnotations
in class AnnotatedNode
public void addTransform(Class<? extends ASTTransformation> transform, ASTNode node)
public Map<Class<? extends ASTTransformation>,Set<ASTNode>> getTransforms(CompilePhase phase)
public void removeField(String oldName)
public boolean isEnum()
public Iterator<InnerClassNode> getInnerClasses()
public boolean isRedirectNode()