Package org.objectweb.asm.tree
Class ClassNode
- java.lang.Object
-
- org.objectweb.asm.ClassVisitor
-
- org.objectweb.asm.tree.ClassNode
-
public class ClassNode extends ClassVisitor
A node that represents a class.
-
-
Field Summary
Fields Modifier and Type Field Description int
access
The class's access flags (seeOpcodes
).List<Attribute>
attrs
The non standard attributes of this class.List<FieldNode>
fields
The fields of this class.List<InnerClassNode>
innerClasses
The inner classes of this class.List<String>
interfaces
The internal names of the interfaces directly implemented by this class (seeType.getInternalName()
).List<AnnotationNode>
invisibleAnnotations
The runtime invisible annotations of this class.List<TypeAnnotationNode>
invisibleTypeAnnotations
The runtime invisible type annotations of this class.List<MethodNode>
methods
The methods of this class.ModuleNode
module
The module stored in this class.String
name
The internal name of this class (seeType.getInternalName()
).String
nestHostClass
The internal name of the nest host class of this class.List<String>
nestMembers
The internal names of the nest members of this class.String
outerClass
The internal name of the enclosing class of this class.String
outerMethod
The name of the method that contains this class, or null if this class is not enclosed in a method.String
outerMethodDesc
The descriptor of the method that contains this class, or null if this class is not enclosed in a method.String
signature
The signature of this class.String
sourceDebug
The correspondence between source and compiled elements of this class.String
sourceFile
The name of the source file from which this class was compiled.String
superName
The internal of name of the super class (seeType.getInternalName()
).int
version
The class version.List<AnnotationNode>
visibleAnnotations
The runtime visible annotations of this class.List<TypeAnnotationNode>
visibleTypeAnnotations
The runtime visible type annotations of this class.-
Fields inherited from class org.objectweb.asm.ClassVisitor
api, cv
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
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.AnnotationVisitor
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.FieldVisitor
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.MethodVisitor
visitMethod(int access, String name, String descriptor, String signature, String[] exceptions)
Visits a method of the class.ModuleVisitor
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
visitSource(String file, String debug)
Visits the source of the class.AnnotationVisitor
visitTypeAnnotation(int typeRef, TypePath typePath, String descriptor, boolean visible)
Visits an annotation on a type in the class signature.
-
-
-
Field Detail
-
version
public int 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
public int access
The class's access flags (seeOpcodes
). This field also indicates if the class is deprecated.
-
name
public String name
The internal name of this class (seeType.getInternalName()
).
-
signature
public String signature
The signature of this class. May be null.
-
superName
public String 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
public List<String> interfaces
The internal names of the interfaces directly implemented by this class (seeType.getInternalName()
).
-
sourceFile
public String sourceFile
The name of the source file from which this class was compiled. May be null.
-
sourceDebug
public String sourceDebug
The correspondence between source and compiled elements of this class. May be null.
-
module
public ModuleNode module
The module stored in this class. May be null.
-
outerClass
public String outerClass
The internal name of the enclosing class of this class. May be null.
-
outerMethod
public String outerMethod
The name of the method that contains this class, or null if this class is not enclosed in a method.
-
outerMethodDesc
public String outerMethodDesc
The descriptor of the method that contains this class, or null if this class is not enclosed in a method.
-
visibleAnnotations
public List<AnnotationNode> visibleAnnotations
The runtime visible annotations of this class. May be null.
-
invisibleAnnotations
public List<AnnotationNode> invisibleAnnotations
The runtime invisible annotations of this class. May be null.
-
visibleTypeAnnotations
public List<TypeAnnotationNode> visibleTypeAnnotations
The runtime visible type annotations of this class. May be null.
-
invisibleTypeAnnotations
public List<TypeAnnotationNode> invisibleTypeAnnotations
The runtime invisible type annotations of this class. May be null.
-
innerClasses
public List<InnerClassNode> innerClasses
The inner classes of this class.
-
nestHostClass
public String nestHostClass
The internal name of the nest host class of this class. May be null.
-
nestMembers
public List<String> nestMembers
The internal names of the nest members of this class. May be null.
-
methods
public List<MethodNode> methods
The methods of this class.
-
-
Constructor Detail
-
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 ofOpcodes.ASM4
,Opcodes.ASM5
,Opcodes.ASM6
orOpcodes.ASM7
.
-
-
Method Detail
-
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 deprecated.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
public void visitSource(String file, String debug)
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
public ModuleVisitor visitModule(String name, int access, String version)
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
public void visitNestHost(String nestHost)
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.
-
visitOuterClass
public void visitOuterClass(String owner, String name, String descriptor)
Description copied from class:ClassVisitor
Visits the enclosing class of the class. This method must be called only if the class has an enclosing class.- Overrides:
visitOuterClass
in classClassVisitor
- Parameters:
owner
- internal name of the enclosing class of the class.name
- the name of the method that contains the class, or null if the class is not enclosed in a method of its enclosing class.descriptor
- the descriptor of the method that contains the class, or null if the class is not enclosed in a method of its enclosing class.
-
visitAnnotation
public AnnotationVisitor visitAnnotation(String descriptor, boolean visible)
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
public void visitAttribute(Attribute attribute)
Description copied from class:ClassVisitor
Visits a non standard attribute of the class.- Overrides:
visitAttribute
in classClassVisitor
- Parameters:
attribute
- an attribute.
-
visitNestMember
public void visitNestMember(String nestMember)
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.
-
visitInnerClass
public void visitInnerClass(String name, String outerName, String innerName, int access)
Description copied from class:ClassVisitor
Visits information about an inner class. This inner class is not necessarily a member of the class being visited.- Overrides:
visitInnerClass
in classClassVisitor
- Parameters:
name
- the internal name of an inner class (seeType.getInternalName()
).outerName
- the internal name of the class to which the inner class belongs (seeType.getInternalName()
). May be null for not member classes.innerName
- the (simple) name of the inner class inside its enclosing class. May be null for anonymous inner classes.access
- the access flags of the inner class as originally declared in the enclosing class.
-
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 ofOpcodes.ASM4
,Opcodes.ASM5
,Opcodes.ASM6
orOpcodes.ASM7
.
-
accept
public void accept(ClassVisitor classVisitor)
Makes the given class visitor visit this class.- Parameters:
classVisitor
- a class visitor.
-
-