public abstract class ClassVisitor extends Object
visit
[ visitSource
] [ visitModule
][ visitNestHost
][ visitOuterClass
] ( visitAnnotation
| visitTypeAnnotation
| visitAttribute
)* ( visitNestMember
| [ * visitPermittedSubclass
] | visitInnerClass
| visitRecordComponent
| visitField
| visitMethod
)*
visitEnd
.Modifier and Type | Field and Description |
---|---|
protected int |
api
The ASM API version implemented by this visitor.
|
protected ClassVisitor |
cv
The class visitor to which this visitor must delegate method calls.
|
Modifier | Constructor and Description |
---|---|
protected |
ClassVisitor(int api)
Constructs a new
ClassVisitor . |
protected |
ClassVisitor(int api,
ClassVisitor classVisitor)
Constructs a new
ClassVisitor . |
Modifier and Type | Method and Description |
---|---|
ClassVisitor |
getDelegate()
The class visitor to which this visitor must delegate method calls.
|
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 |
visitPermittedSubclass(String permittedSubclass)
Visits a permitted subclasses.
|
RecordComponentVisitor |
visitRecordComponent(String name,
String descriptor,
String signature)
Visits a record component of the class.
|
void |
visitSource(String source,
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.
|
protected final int api
ASM
x values in Opcodes
.protected ClassVisitor cv
protected ClassVisitor(int api)
ClassVisitor
.api
- the ASM API version implemented by this visitor. Must be one of the ASM
x values in Opcodes
.protected ClassVisitor(int api, ClassVisitor classVisitor)
ClassVisitor
.api
- the ASM API version implemented by this visitor. Must be one of the ASM
x values in Opcodes
.classVisitor
- the class visitor to which this visitor must delegate method calls. May be
null.public ClassVisitor getDelegate()
public void visit(int version, int access, String name, String signature, String superName, String[] interfaces)
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 (see Opcodes
). This parameter also indicates if
the class is deprecated Opcodes.ACC_DEPRECATED
or a record Opcodes.ACC_RECORD
.name
- the internal name of the class (see Type.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 (see Type.getInternalName()
).
For interfaces, the super class is Object
. May be null, but only for the
Object
class.interfaces
- the internal names of the class's interfaces (see Type.getInternalName()
). May be null.public void visitSource(String source, String debug)
source
- 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.public ModuleVisitor visitModule(String name, int access, String version)
name
- the fully qualified name (using dots) of the module.access
- the module access flags, among ACC_OPEN
, ACC_SYNTHETIC
and ACC_MANDATED
.version
- the module version, or null.public void visitNestHost(String nestHost)
nestHost
- the internal name of the host class of the nest (see Type.getInternalName()
).public void visitOuterClass(String owner, String name, String descriptor)
owner
- internal name of the enclosing class of the class (see Type.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).public AnnotationVisitor visitAnnotation(String descriptor, boolean visible)
descriptor
- the class descriptor of the annotation class.visible
- true if the annotation is visible at runtime.public AnnotationVisitor visitTypeAnnotation(int typeRef, TypePath typePath, String descriptor, boolean visible)
typeRef
- a 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
.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.public void visitAttribute(Attribute attribute)
attribute
- an attribute.public void visitNestMember(String nestMember)
nestMember
- the internal name of a nest member (see Type.getInternalName()
).public void visitPermittedSubclass(String permittedSubclass)
permittedSubclass
- the internal name of a permitted subclass (see Type.getInternalName()
).public void visitInnerClass(String name, String outerName, String innerName, int access)
name
- the internal name of C (see Type.getInternalName()
).outerName
- the internal name of the class or interface C is a member of (see Type.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.public RecordComponentVisitor visitRecordComponent(String name, String descriptor, String signature)
name
- the record component name.descriptor
- the record component descriptor (see Type
).signature
- the record component signature. May be null if the record component
type does not use generic types.public FieldVisitor visitField(int access, String name, String descriptor, String signature, Object value)
access
- the field's access flags (see Opcodes
). This parameter also indicates if
the field is synthetic and/or deprecated.name
- the field's name.descriptor
- the field's descriptor (see Type
).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 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.public MethodVisitor visitMethod(int access, String name, String descriptor, String signature, String[] exceptions)
MethodVisitor
instance (or null) each time it is called, i.e., it should not return a previously
returned visitor.access
- the method's access flags (see Opcodes
). This parameter also indicates if
the method is synthetic and/or deprecated.name
- the method's name.descriptor
- the method's descriptor (see Type
).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 (see Type.getInternalName()
). May be null.public void visitEnd()
Copyright © 2007-2023, Oracle and/or its affiliates. All Rights Reserved. Use is subject to license terms.