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.

Author:

Eric Bruneton

Field Summary

Fields

Modifier and Type	Field	Description
int	access	The class's access flags (see Opcodes).
java.util.List<Attribute>	attrs	The non standard attributes of this class.
java.util.List<FieldNode>	fields	The fields of this class.
java.util.List<InnerClassNode>	innerClasses	The inner classes of this class.
java.util.List<java.lang.String>	interfaces	The internal names of the interfaces directly implemented by this class (see Type.getInternalName()).
java.util.List<AnnotationNode>	invisibleAnnotations	The runtime invisible annotations of this class.
java.util.List<TypeAnnotationNode>	invisibleTypeAnnotations	The runtime invisible type annotations of this class.
java.util.List<MethodNode>	methods	The methods of this class.
ModuleNode	module	The module stored in this class.
java.lang.String	name	The internal name of this class (see Type.getInternalName()).
java.lang.String	nestHostClass	The internal name of the nest host class of this class.
java.util.List<java.lang.String>	nestMembers	The internal names of the nest members of this class.
java.lang.String	outerClass	The internal name of the enclosing class of this class.
java.lang.String	outerMethod	The name of the method that contains this class, or null if this class is not enclosed in a method.
java.lang.String	outerMethodDesc	The descriptor of the method that contains this class, or null if this class is not enclosed in a method.
java.util.List<java.lang.String>	permittedSubclasses	The internal names of the permitted subclasses of this class.
java.util.List<RecordComponentNode>	recordComponents	The record components of this class.
java.lang.String	signature	The signature of this class.
java.lang.String	sourceDebug	The correspondence between source and compiled elements of this class.
java.lang.String	sourceFile	The name of the source file from which this class was compiled.
java.lang.String	superName	The internal of name of the super class (see Type.getInternalName()).
int	version	The class version.
java.util.List<AnnotationNode>	visibleAnnotations	The runtime visible annotations of this class.
java.util.List<TypeAnnotationNode>	visibleTypeAnnotations	The runtime visible type annotations of this class.

Fields inherited from class org.objectweb.asm.ClassVisitor

api, cv

Constructor Summary

Constructors

Constructor	Description
ClassNode()	Constructs a new ClassNode.
ClassNode(int api)	Constructs a new ClassNode.

Method Summary

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, java.lang.String name, java.lang.String signature, java.lang.String superName, java.lang.String[] interfaces)
AnnotationVisitor	visitAnnotation(java.lang.String descriptor, boolean visible)
void	visitAttribute(Attribute attribute)
void	visitEnd()
FieldVisitor	visitField(int access, java.lang.String name, java.lang.String descriptor, java.lang.String signature, java.lang.Object value)
void	visitInnerClass(java.lang.String name, java.lang.String outerName, java.lang.String innerName, int access)
MethodVisitor	visitMethod(int access, java.lang.String name, java.lang.String descriptor, java.lang.String signature, java.lang.String[] exceptions)
ModuleVisitor	visitModule(java.lang.String name, int access, java.lang.String version)
void	visitNestHost(java.lang.String nestHost)
void	visitNestMember(java.lang.String nestMember)
void	visitOuterClass(java.lang.String owner, java.lang.String name, java.lang.String descriptor)
void	visitPermittedSubclass(java.lang.String permittedSubclass)
RecordComponentVisitor	visitRecordComponent(java.lang.String name, java.lang.String descriptor, java.lang.String signature)
void	visitSource(java.lang.String file, java.lang.String debug)
AnnotationVisitor	visitTypeAnnotation(int typeRef, TypePath typePath, java.lang.String descriptor, boolean visible)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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 (see Opcodes). This field also indicates if the class is deprecated Opcodes.ACC_DEPRECATED or a record Opcodes.ACC_RECORD.

name

public java.lang.String name

The internal name of this class (see Type.getInternalName()).

signature

public java.lang.String signature

The signature of this class. May be null.

superName

public java.lang.String superName

The internal of name of the super class (see Type.getInternalName()). For interfaces, the super class is Object. May be null, but only for the Object class.

interfaces

public java.util.List<java.lang.String> interfaces

The internal names of the interfaces directly implemented by this class (see Type.getInternalName()).

sourceFile

public java.lang.String sourceFile

The name of the source file from which this class was compiled. May be null.

sourceDebug

public java.lang.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 java.lang.String outerClass

The internal name of the enclosing class of this class. May be null.

outerMethod

public java.lang.String outerMethod

The name of the method that contains this class, or null if this class is not enclosed in a method.

outerMethodDesc

public java.lang.String outerMethodDesc

The descriptor of the method that contains this class, or null if this class is not enclosed in a method.

visibleAnnotations

public java.util.List<AnnotationNode> visibleAnnotations

The runtime visible annotations of this class. May be null.

invisibleAnnotations

public java.util.List<AnnotationNode> invisibleAnnotations

The runtime invisible annotations of this class. May be null.

visibleTypeAnnotations

public java.util.List<TypeAnnotationNode> visibleTypeAnnotations

The runtime visible type annotations of this class. May be null.

invisibleTypeAnnotations

public java.util.List<TypeAnnotationNode> invisibleTypeAnnotations

The runtime invisible type annotations of this class. May be null.

attrs

public java.util.List<Attribute> attrs

The non standard attributes of this class. May be null.

innerClasses

public java.util.List<InnerClassNode> innerClasses

The inner classes of this class.

nestHostClass

public java.lang.String nestHostClass

The internal name of the nest host class of this class. May be null.

nestMembers

public java.util.List<java.lang.String> nestMembers

The internal names of the nest members of this class. May be null.

permittedSubclasses

public java.util.List<java.lang.String> permittedSubclasses

The internal names of the permitted subclasses of this class. May be null.

recordComponents

public java.util.List<RecordComponentNode> recordComponents

The record components of this class. May be null.

fields

public java.util.List<FieldNode> fields

The fields of this class.

methods

public java.util.List<MethodNode> methods

The methods of this class.

Constructor Detail

ClassNode

public ClassNode()

Constructs a new ClassNode. Subclasses must not use this constructor. Instead, they must use the ClassNode(int) version.

Throws:

java.lang.IllegalStateException - If a subclass calls this constructor.

ClassNode

public ClassNode(int api)

Constructs a new ClassNode.

Parameters:

api - the ASM API version implemented by this visitor. Must be one of Opcodes.ASM4, Opcodes.ASM5, Opcodes.ASM6, Opcodes.ASM7, Opcodes.ASM8, or Opcodes.ASM9.

Method Detail

visit

public void visit(int version,
                  int access,
                  java.lang.String name,
                  java.lang.String signature,
                  java.lang.String superName,
                  java.lang.String[] interfaces)

Overrides:

visit in class ClassVisitor

visitSource

public void visitSource(java.lang.String file,
                        java.lang.String debug)

Overrides:

visitSource in class ClassVisitor

visitModule

public ModuleVisitor visitModule(java.lang.String name,
                                 int access,
                                 java.lang.String version)

Overrides:

visitModule in class ClassVisitor

visitNestHost

public void visitNestHost(java.lang.String nestHost)

Overrides:

visitNestHost in class ClassVisitor

visitOuterClass

public void visitOuterClass(java.lang.String owner,
                            java.lang.String name,
                            java.lang.String descriptor)

Overrides:

visitOuterClass in class ClassVisitor

visitAnnotation

public AnnotationVisitor visitAnnotation(java.lang.String descriptor,
                                         boolean visible)

Overrides:

visitAnnotation in class ClassVisitor

visitTypeAnnotation

public AnnotationVisitor visitTypeAnnotation(int typeRef,
                                             TypePath typePath,
                                             java.lang.String descriptor,
                                             boolean visible)

Overrides:

visitTypeAnnotation in class ClassVisitor

visitAttribute

public void visitAttribute(Attribute attribute)

Overrides:

visitAttribute in class ClassVisitor

visitNestMember

public void visitNestMember(java.lang.String nestMember)

Overrides:

visitNestMember in class ClassVisitor

visitPermittedSubclass

public void visitPermittedSubclass(java.lang.String permittedSubclass)

Overrides:

visitPermittedSubclass in class ClassVisitor

visitInnerClass

public void visitInnerClass(java.lang.String name,
                            java.lang.String outerName,
                            java.lang.String innerName,
                            int access)

Overrides:

visitInnerClass in class ClassVisitor

visitRecordComponent

public RecordComponentVisitor visitRecordComponent(java.lang.String name,
                                                   java.lang.String descriptor,
                                                   java.lang.String signature)

Overrides:

visitRecordComponent in class ClassVisitor

visitField

public FieldVisitor visitField(int access,
                               java.lang.String name,
                               java.lang.String descriptor,
                               java.lang.String signature,
                               java.lang.Object value)

Overrides:

visitField in class ClassVisitor

visitMethod

public MethodVisitor visitMethod(int access,
                                 java.lang.String name,
                                 java.lang.String descriptor,
                                 java.lang.String signature,
                                 java.lang.String[] exceptions)

Overrides:

visitMethod in class ClassVisitor

visitEnd

public void visitEnd()

Overrides:

visitEnd in class ClassVisitor

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 Opcodes.ASM4, Opcodes.ASM5, Opcodes.ASM6, Opcodes.ASM7, Opcodes.ASM8 or Opcodes.ASM9.

accept

public void accept(ClassVisitor classVisitor)

Makes the given class visitor visit this class.

Parameters:

classVisitor - a class visitor.