Package org.objectweb.asm.tree
Class ClassNode
java.lang.Object
org.objectweb.asm.ClassVisitor
org.objectweb.asm.tree.ClassNode
A node that represents a class.
-
Field Summary
Modifier and TypeFieldDescriptionint
The class's access flags (seeOpcodes
).The non standard attributes of this class.The fields of this class.The inner classes of this class.The internal names of the interfaces directly implemented by this class (seeType.getInternalName()
).The runtime invisible annotations of this class.The runtime invisible type annotations of this class.The methods of this class.The module stored in this class.The internal name of this class (seeType.getInternalName()
).The internal name of the nest host class of this class (seeType.getInternalName()
).The internal names of the nest members of this class (seeType.getInternalName()
).The internal name of the enclosing class of this class (seeType.getInternalName()
).The name of the method that contains the class, or null if the class has no enclosing class, or is not enclosed in a method or constructor of its enclosing class (e.g.The descriptor of the method that contains the class, or null if the class has no enclosing class, or is not enclosed in a method or constructor of its enclosing class (e.g.The internal names of the permitted subclasses of this class (seeType.getInternalName()
).The record components of this class.The signature of this class.The correspondence between source and compiled elements of this class.The name of the source file from which this class was compiled.The internal of name of the super class (seeType.getInternalName()
).int
The class version.The runtime visible annotations of this class.The runtime visible type annotations of this class.Fields inherited from class org.objectweb.asm.ClassVisitor
api, cv
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
accept
(ClassVisitor classVisitor) Makes the given class visitor visit this class.void
check
(int api) Checks that this class node is compatible with the given ASM API version.void
visit
(int version, int access, String name, String signature, String superName, String[] interfaces) Visits the header of the class.visitAnnotation
(String descriptor, boolean visible) Visits an annotation of the class.void
visitAttribute
(Attribute attribute) Visits a non standard attribute of the class.void
visitEnd()
Visits the end of the class.visitField
(int access, String name, String descriptor, String signature, Object value) Visits a field of the class.void
visitInnerClass
(String name, String outerName, String innerName, int access) Visits information about an inner class.visitMethod
(int access, String name, String descriptor, String signature, String[] exceptions) Visits a method of the class.visitModule
(String name, int access, String version) Visit the module corresponding to the class.void
visitNestHost
(String nestHost) Visits the nest host class of the class.void
visitNestMember
(String nestMember) Visits a member of the nest.void
visitOuterClass
(String owner, String name, String descriptor) Visits the enclosing class of the class.void
visitPermittedSubclass
(String permittedSubclass) Visits a permitted subclasses.visitRecordComponent
(String name, String descriptor, String signature) Visits a record component of the class.void
visitSource
(String file, String debug) Visits the source of the class.visitTypeAnnotation
(int typeRef, TypePath typePath, String descriptor, boolean visible) Visits an annotation on a type in the class signature.Methods inherited from class org.objectweb.asm.ClassVisitor
getDelegate
-
Field Details
-
version
public int versionThe class version. The minor version is stored in the 16 most significant bits, and the major version in the 16 least significant bits. -
access
public int accessThe class's access flags (seeOpcodes
). This field also indicates if the class is deprecatedOpcodes.ACC_DEPRECATED
or a recordOpcodes.ACC_RECORD
. -
name
The internal name of this class (seeType.getInternalName()
). -
signature
The signature of this class. May be null. -
superName
The internal of name of the super class (seeType.getInternalName()
). For interfaces, the super class isObject
. May be null, but only for theObject
class. -
interfaces
The internal names of the interfaces directly implemented by this class (seeType.getInternalName()
). -
sourceFile
The name of the source file from which this class was compiled. May be null. -
sourceDebug
The correspondence between source and compiled elements of this class. May be null. -
module
The module stored in this class. May be null. -
outerClass
The internal name of the enclosing class of this class (seeType.getInternalName()
). Must be null if this class is not a local or anonymous class. -
outerMethod
The name of the method that contains the class, or null if the class has no enclosing class, or is not enclosed in a method or constructor of its enclosing class (e.g. if it is enclosed in an instance initializer, static initializer, instance variable initializer, or class variable initializer). -
outerMethodDesc
The descriptor of the method that contains the class, or null if the class has no enclosing class, or is not enclosed in a method or constructor of its enclosing class (e.g. if it is enclosed in an instance initializer, static initializer, instance variable initializer, or class variable initializer). -
visibleAnnotations
The runtime visible annotations of this class. May be null. -
invisibleAnnotations
The runtime invisible annotations of this class. May be null. -
visibleTypeAnnotations
The runtime visible type annotations of this class. May be null. -
invisibleTypeAnnotations
The runtime invisible type annotations of this class. May be null. -
attrs
The non standard attributes of this class. May be null. -
innerClasses
The inner classes of this class. -
nestHostClass
The internal name of the nest host class of this class (seeType.getInternalName()
). May be null. -
nestMembers
The internal names of the nest members of this class (seeType.getInternalName()
). May be null. -
permittedSubclasses
The internal names of the permitted subclasses of this class (seeType.getInternalName()
). May be null. -
recordComponents
The record components of this class. May be null. -
fields
The fields of this class. -
methods
The methods of this class.
-
-
Constructor Details
-
ClassNode
public ClassNode()Constructs a newClassNode
. Subclasses must not use this constructor. Instead, they must use theClassNode(int)
version.- Throws:
IllegalStateException
- If a subclass calls this constructor.
-
ClassNode
public ClassNode(int api) Constructs a newClassNode
.- Parameters:
api
- the ASM API version implemented by this visitor. Must be one of theASM
x values inOpcodes
.
-
-
Method Details
-
visit
public void visit(int version, int access, String name, String signature, String superName, String[] interfaces) Description copied from class:ClassVisitor
Visits the header of the class.- Overrides:
visit
in classClassVisitor
- Parameters:
version
- the class version. The minor version is stored in the 16 most significant bits, and the major version in the 16 least significant bits.access
- the class's access flags (seeOpcodes
). This parameter also indicates if the class is deprecatedOpcodes.ACC_DEPRECATED
or a recordOpcodes.ACC_RECORD
.name
- the internal name of the class (seeType.getInternalName()
).signature
- the signature of this class. May be null if the class is not a generic one, and does not extend or implement generic classes or interfaces.superName
- the internal of name of the super class (seeType.getInternalName()
). For interfaces, the super class isObject
. May be null, but only for theObject
class.interfaces
- the internal names of the class's interfaces (seeType.getInternalName()
). May be null.
-
visitSource
Description copied from class:ClassVisitor
Visits the source of the class.- Overrides:
visitSource
in classClassVisitor
- Parameters:
file
- the name of the source file from which the class was compiled. May be null.debug
- additional debug information to compute the correspondence between source and compiled elements of the class. May be null.
-
visitModule
Description copied from class:ClassVisitor
Visit the module corresponding to the class.- Overrides:
visitModule
in classClassVisitor
- Parameters:
name
- the fully qualified name (using dots) of the module.access
- the module access flags, amongACC_OPEN
,ACC_SYNTHETIC
andACC_MANDATED
.version
- the module version, or null.- Returns:
- a visitor to visit the module values, or null if this visitor is not interested in visiting this module.
-
visitNestHost
Description copied from class:ClassVisitor
Visits the nest host class of the class. A nest is a set of classes of the same package that share access to their private members. One of these classes, called the host, lists the other members of the nest, which in turn should link to the host of their nest. This method must be called only once and only if the visited class is a non-host member of a nest. A class is implicitly its own nest, so it's invalid to call this method with the visited class name as argument.- Overrides:
visitNestHost
in classClassVisitor
- Parameters:
nestHost
- the internal name of the host class of the nest (seeType.getInternalName()
).
-
visitOuterClass
Description copied from class:ClassVisitor
Visits the enclosing class of the class. This method must be called only if this class is a local or anonymous class. See the JVMS 4.7.7 section for more details.- Overrides:
visitOuterClass
in classClassVisitor
- Parameters:
owner
- internal name of the enclosing class of the class (seeType.getInternalName()
).name
- the name of the method that contains the class, or null if the class is not enclosed in a method or constructor of its enclosing class (e.g. if it is enclosed in an instance initializer, static initializer, instance variable initializer, or class variable initializer).descriptor
- the descriptor of the method that contains the class, or null if the class is not enclosed in a method or constructor of its enclosing class (e.g. if it is enclosed in an instance initializer, static initializer, instance variable initializer, or class variable initializer).
-
visitAnnotation
Description copied from class:ClassVisitor
Visits an annotation of the class.- Overrides:
visitAnnotation
in classClassVisitor
- Parameters:
descriptor
- the class descriptor of the annotation class.visible
- true if the annotation is visible at runtime.- Returns:
- a visitor to visit the annotation values, or null if this visitor is not interested in visiting this annotation.
-
visitTypeAnnotation
public AnnotationVisitor visitTypeAnnotation(int typeRef, TypePath typePath, String descriptor, boolean visible) Description copied from class:ClassVisitor
Visits an annotation on a type in the class signature.- Overrides:
visitTypeAnnotation
in classClassVisitor
- Parameters:
typeRef
- a reference to the annotated type. The sort of this type reference must beTypeReference.CLASS_TYPE_PARAMETER
,TypeReference.CLASS_TYPE_PARAMETER_BOUND
orTypeReference.CLASS_EXTENDS
. SeeTypeReference
.typePath
- the path to the annotated type argument, wildcard bound, array element type, or static inner type within 'typeRef'. May be null if the annotation targets 'typeRef' as a whole.descriptor
- the class descriptor of the annotation class.visible
- true if the annotation is visible at runtime.- Returns:
- a visitor to visit the annotation values, or null if this visitor is not interested in visiting this annotation.
-
visitAttribute
Description copied from class:ClassVisitor
Visits a non standard attribute of the class.- Overrides:
visitAttribute
in classClassVisitor
- Parameters:
attribute
- an attribute.
-
visitNestMember
Description copied from class:ClassVisitor
Visits a member of the nest. A nest is a set of classes of the same package that share access to their private members. One of these classes, called the host, lists the other members of the nest, which in turn should link to the host of their nest. This method must be called only if the visited class is the host of a nest. A nest host is implicitly a member of its own nest, so it's invalid to call this method with the visited class name as argument.- Overrides:
visitNestMember
in classClassVisitor
- Parameters:
nestMember
- the internal name of a nest member (seeType.getInternalName()
).
-
visitPermittedSubclass
Description copied from class:ClassVisitor
Visits a permitted subclasses. A permitted subclass is one of the allowed subclasses of the current class.- Overrides:
visitPermittedSubclass
in classClassVisitor
- Parameters:
permittedSubclass
- the internal name of a permitted subclass (seeType.getInternalName()
).
-
visitInnerClass
Description copied from class:ClassVisitor
Visits information about an inner class. This inner class is not necessarily a member of the class being visited. More precisely, every class or interface C which is referenced by this class and which is not a package member must be visited with this method. This class must reference its nested class or interface members, and its enclosing class, if any. See the JVMS 4.7.6 section for more details.- Overrides:
visitInnerClass
in classClassVisitor
- Parameters:
name
- the internal name of C (seeType.getInternalName()
).outerName
- the internal name of the class or interface C is a member of (seeType.getInternalName()
). Must be null if C is not the member of a class or interface (e.g. for local or anonymous classes).innerName
- the (simple) name of C. Must be null for anonymous inner classes.access
- the access flags of C originally declared in the source code from which this class was compiled.
-
visitRecordComponent
public RecordComponentVisitor visitRecordComponent(String name, String descriptor, String signature) Description copied from class:ClassVisitor
Visits a record component of the class.- Overrides:
visitRecordComponent
in classClassVisitor
- Parameters:
name
- the record component name.descriptor
- the record component descriptor (seeType
).signature
- the record component signature. May be null if the record component type does not use generic types.- Returns:
- a visitor to visit this record component annotations and attributes, or null if this class visitor is not interested in visiting these annotations and attributes.
-
visitField
public FieldVisitor visitField(int access, String name, String descriptor, String signature, Object value) Description copied from class:ClassVisitor
Visits a field of the class.- Overrides:
visitField
in classClassVisitor
- Parameters:
access
- the field's access flags (seeOpcodes
). This parameter also indicates if the field is synthetic and/or deprecated.name
- the field's name.descriptor
- the field's descriptor (seeType
).signature
- the field's signature. May be null if the field's type does not use generic types.value
- the field's initial value. This parameter, which may be null if the field does not have an initial value, must be anInteger
, aFloat
, aLong
, aDouble
or aString
(forint
,float
,long
orString
fields respectively). This parameter is only used for static fields. Its value is ignored for non static fields, which must be initialized through bytecode instructions in constructors or methods.- Returns:
- a visitor to visit field annotations and attributes, or null if this class visitor is not interested in visiting these annotations and attributes.
-
visitMethod
public MethodVisitor visitMethod(int access, String name, String descriptor, String signature, String[] exceptions) Description copied from class:ClassVisitor
Visits a method of the class. This method must return a newMethodVisitor
instance (or null) each time it is called, i.e., it should not return a previously returned visitor.- Overrides:
visitMethod
in classClassVisitor
- Parameters:
access
- the method's access flags (seeOpcodes
). This parameter also indicates if the method is synthetic and/or deprecated.name
- the method's name.descriptor
- the method's descriptor (seeType
).signature
- the method's signature. May be null if the method parameters, return type and exceptions do not use generic types.exceptions
- the internal names of the method's exception classes (seeType.getInternalName()
). May be null.- Returns:
- an object to visit the byte code of the method, or null if this class visitor is not interested in visiting the code of this method.
-
visitEnd
public void visitEnd()Description copied from class:ClassVisitor
Visits the end of the class. This method, which is the last one to be called, is used to inform the visitor that all the fields and methods of the class have been visited.- Overrides:
visitEnd
in classClassVisitor
-
check
public void check(int api) Checks that this class node is compatible with the given ASM API version. This method checks that this node, and all its children recursively, do not contain elements that were introduced in more recent versions of the ASM API than the given version.- Parameters:
api
- an ASM API version. Must be one of theASM
x values inOpcodes
.
-
accept
Makes the given class visitor visit this class.- Parameters:
classVisitor
- a class visitor.
-