public abstract class ClassVisitor
A visitor to visit a Java class. The methods of this class must be called in the following order:
visit
[ visitSource
] [ visitModule
][ visitNestHost
][
visitPermittedSubclass
][ visitOuterClass
] ( visitAnnotation
|
visitTypeAnnotation
| visitAttribute
)* ( visitNestMember
|
visitInnerClass
| visitRecordComponent
| visitField
| visitMethod
)*
visitEnd
.protected final int | The ASM API version implemented by this visitor. |
protected ClassVisitor | The class visitor to which this visitor must delegate method calls. |
public | ClassVisitor( Constructs a new ClassVisitor. |
public | ClassVisitor( Constructs a new ClassVisitor. |
public void | visit( Visits the header of the class. |
public AnnotationVisitor | visitAnnotation( Visits an annotation of the class. |
public void | visitAttribute( Visits a non standard attribute of the class. |
public void | visitEnd() Visits the end of the class. |
public FieldVisitor | visitField( Visits a field of the class. |
public void | visitInnerClass( Visits information about an inner class. |
public MethodVisitor | visitMethod( Visits a method of the class. |
public ModuleVisitor | visitModule( Visit the module corresponding to the class. |
public void | visitNestHost( Visits the nest host class of the class. |
public void | visitNestMember( Visits a member of the nest. |
public void | visitOuterClass( Visits the enclosing class of the class. |
public void | visitPermittedSubclass( Visits a permitted subclasses. |
public RecordComponentVisitor | visitRecordComponent( Visits a record component of the class. |
public void | visitSource( Visits the source of the class. |
public AnnotationVisitor | visitTypeAnnotation( Visits an annotation on a type in the class signature. |
The class visitor to which this visitor must delegate method calls. May be null.
public void visit(int version, int access, String name, String signature, String superName, String[] interfaces)
Visits the header of the class.
versionthe class version. The minor version is stored in the 16 most significant bits,
and the major version in the 16 least significant bits.
accessthe class's access flags (see Opcodes). This parameter also indicates if
the class is deprecated Opcodes.ACC_DEPRECATED or a record Opcodes.ACC_RECORD.
namethe internal name of the class (see Type.getInternalName()).
signaturethe 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.
superNamethe 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.
interfacesthe internal names of the class's interfaces (see Type.getInternalName()). May be null.
Visits an annotation of the class.
descriptorthe class descriptor of the annotation class.
visibletrue if the annotation is visible at runtime.
a visitor to visit the annotation values, or null if this visitor is not
interested in visiting this annotation.
Visits a non standard attribute of the class.
attributean attribute.
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.
public FieldVisitor visitField(int access, String name, String descriptor, String signature, Object value)
Visits a field of the class.
accessthe field's access flags (see Opcodes). This parameter also indicates if
the field is synthetic and/or deprecated.
namethe field's name.
descriptorthe field's descriptor (see Type).
signaturethe field's signature. May be null if the field's type does not use
generic types.
valuethe field's initial value. This parameter, which may be null if the
field does not have an initial value, must be an Integer, a Float, a Long, a Double or a String (for
int
, float
, long
or String
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.a visitor to visit field annotations and attributes, or null if this class
visitor is not interested in visiting these annotations and attributes.
Visits information about an inner class. This inner class is not necessarily a member of the
class being visited.
namethe internal name of an inner class (see Type.getInternalName()).
outerNamethe internal name of the class to which the inner class belongs (see Type.getInternalName()). May be null for not member classes.
innerNamethe (simple) name of the inner class inside its enclosing class. May be
null for anonymous inner classes.
accessthe access flags of the inner class as originally declared in the enclosing
class.
public MethodVisitor visitMethod(int access, String name, String descriptor, String signature, String[] exceptions)
Visits a method of the class. This method must return a new MethodVisitor
instance (or null) each time it is called, i.e., it should not return a previously
returned visitor.
accessthe method's access flags (see Opcodes). This parameter also indicates if
the method is synthetic and/or deprecated.
namethe method's name.
descriptorthe method's descriptor (see Type).
signaturethe method's signature. May be null if the method parameters,
return type and exceptions do not use generic types.
exceptionsthe internal names of the method's exception classes (see Type.getInternalName()). May be null.
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.
Visit the module corresponding to the class.
namethe fully qualified name (using dots) of the module.
accessthe module access flags, among
ACC_OPEN
, ACC_SYNTHETIC
and
ACC_MANDATED
.versionthe module version, or null.
a visitor to visit the module values, or null if this visitor is not
interested in visiting this module.
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.
nestHostthe internal name of the host class of the nest.
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.
nestMemberthe internal name of a nest member.
Visits the enclosing class of the class. This method must be called only if the class has an
enclosing class.
ownerinternal name of the enclosing class of the class.
namethe name of the method that contains the class, or null if the class is
not enclosed in a method of its enclosing class.
descriptorthe descriptor of the method that contains the class, or null if
the class is not enclosed in a method of its enclosing class.
Visits a permitted subclasses. A permitted subclass is one of the allowed subclasses of the
current class.
permittedSubclassthe internal name of a permitted subclass.
public RecordComponentVisitor visitRecordComponent(String name, String descriptor, String signature)
Visits a record component of the class.
namethe record component name.
descriptorthe record component descriptor (see Type).
signaturethe record component signature. May be null if the record component
type does not use generic types.
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.
Visits the source of the class.
sourcethe name of the source file from which the class was compiled. May be
null.
debugadditional debug information to compute the correspondence between source and
compiled elements of the class. May be null.
public AnnotationVisitor visitTypeAnnotation(int typeRef, TypePath typePath, String descriptor, boolean visible)
Visits an annotation on a type in the class signature.
typeRefa reference to the annotated type. The sort of this type reference must be
TypeReference.CLASS_TYPE_PARAMETER, TypeReference.CLASS_TYPE_PARAMETER_BOUND or TypeReference.CLASS_EXTENDS. See
TypeReference.
typePaththe 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.
descriptorthe class descriptor of the annotation class.
visibletrue if the annotation is visible at runtime.
a visitor to visit the annotation values, or null if this visitor is not
interested in visiting this annotation.