Byte Buddy 1.14.12 · net.bytebuddy.jar.asm.ClassVisitor

Modifier and Type	Field and Description
protected final int	api The ASM API version implemented by this visitor.
protected ClassVisitor	cv The class visitor to which this visitor must delegate method calls.

Access	Constructor and Description
protected	ClassVisitor(final int the ASM API version implemented by this visitor. Must be one of the `ASM`x values in `Opcodes`. api) Constructs a new `ClassVisitor`.
protected	ClassVisitor(final int the ASM API version implemented by this visitor. Must be one of the `ASM`x values in `Opcodes`. api, final ClassVisitor the class visitor to which this visitor must delegate method calls. May be null. classVisitor) Constructs a new `ClassVisitor`.

Method Summary

Modifier and Type	Method and Description
public ClassVisitor	Returns: the class visitor to which this visitor must delegate method calls, or null. getDelegate() The class visitor to which this visitor must delegate method calls.
public void	visit(final int the class version. The minor version is stored in the 16 most significant bits, and the major version in the 16 least significant bits. version, final int 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`. access, final String the internal name of the class (see `Type#getInternalName()`). name, final String 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. signature, final String 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. superName, final String[] the internal names of the class's interfaces (see `Type#getInternalName()`). May be null. interfaces) Visits the header of the class.
public AnnotationVisitor	Returns: a visitor to visit the annotation values, or null if this visitor is not interested in visiting this annotation. visitAnnotation(final String the class descriptor of the annotation class. descriptor, final boolean true if the annotation is visible at runtime. visible) Visits an annotation of the class.
public void	visitAttribute(final Attribute an attribute. attribute) Visits a non standard attribute of the class.
public void	visitEnd() Visits the end of the class.
public FieldVisitor	Returns: a visitor to visit field annotations and attributes, or null if this class visitor is not interested in visiting these annotations and attributes. visitField(final int the field's access flags (see `Opcodes`). This parameter also indicates if the field is synthetic and/or deprecated. access, final String the field's name. name, final String the field's descriptor (see `Type`). descriptor, final String the field's signature. May be null if the field's type does not use generic types. signature, final Object 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. value) Visits a field of the class.
public void	visitInnerClass(final String the internal name of C (see `Type#getInternalName()`). name, final String 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). outerName, final String the (simple) name of C. Must be null for anonymous inner classes. innerName, final int the access flags of C originally declared in the source code from which this class was compiled. access) Visits information about an inner class.
public MethodVisitor	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. visitMethod(final int the method's access flags (see `Opcodes`). This parameter also indicates if the method is synthetic and/or deprecated. access, final String the method's name. name, final String the method's descriptor (see `Type`). descriptor, final String the method's signature. May be null if the method parameters, return type and exceptions do not use generic types. signature, final String[] the internal names of the method's exception classes (see `Type#getInternalName()`). May be null. exceptions) Visits a method of the class.
public ModuleVisitor	Returns: a visitor to visit the module values, or null if this visitor is not interested in visiting this module. visitModule(final String the fully qualified name (using dots) of the module. name, final int the module access flags, among `ACC_OPEN`, `ACC_SYNTHETIC` and `ACC_MANDATED`. access, final String the module version, or null. version) Visit the module corresponding to the class.
public void	visitNestHost(final String the internal name of the host class of the nest (see `Type#getInternalName()`). nestHost) Visits the nest host class of the class.
public void	visitNestMember(final String the internal name of a nest member (see `Type#getInternalName()`). nestMember) Visits a member of the nest.
public void	visitOuterClass(final String internal name of the enclosing class of the class (see `Type#getInternalName()`). owner, final String 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). name, final String 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). descriptor) Visits the enclosing class of the class.
public void	visitPermittedSubclass(final String the internal name of a permitted subclass (see `Type#getInternalName()`). permittedSubclass) Visits a permitted subclasses.
public RecordComponentVisitor	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. visitRecordComponent(final String the record component name. name, final String the record component descriptor (see `Type`). descriptor, final String the record component signature. May be null if the record component type does not use generic types. signature) Visits a record component of the class.
public void	visitSource(final String the name of the source file from which the class was compiled. May be null. source, final String additional debug information to compute the correspondence between source and compiled elements of the class. May be null. debug) Visits the source of the class.
public AnnotationVisitor	Returns: a visitor to visit the annotation values, or null if this visitor is not interested in visiting this annotation. visitTypeAnnotation(final int 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`. typeRef, final 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. typePath, final String the class descriptor of the annotation class. descriptor, final boolean true if the annotation is visible at runtime. visible) Visits an annotation on a type in the class signature.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

api	back to summary
protected final int api The ASM API version implemented by this visitor. The value of this field must be one of the `ASM`x values in `Opcodes`.

cv	back to summary
protected ClassVisitor cv The class visitor to which this visitor must delegate method calls. May be null.

ClassVisitor	back to summary
protected ClassVisitor(final int api) Constructs a new `ClassVisitor`. Parameters api:int the ASM API version implemented by this visitor. Must be one of the `ASM`x values in `Opcodes`.

ClassVisitor	back to summary
protected ClassVisitor(final int api, final ClassVisitor classVisitor) Constructs a new `ClassVisitor`. Parameters api:int the ASM API version implemented by this visitor. Must be one of the `ASM`x values in `Opcodes`. classVisitor:ClassVisitor the class visitor to which this visitor must delegate method calls. May be null.

Method Detail

getDelegate	back to summary
public ClassVisitor getDelegate() The class visitor to which this visitor must delegate method calls. May be null. Returns:ClassVisitor the class visitor to which this visitor must delegate method calls, or null.

getDelegate

back to summary

public ClassVisitor getDelegate()

The class visitor to which this visitor must delegate method calls. May be null.

Returns:ClassVisitor: the class visitor to which this visitor must delegate method calls, or null.

visit back to summary

visit	back to summary
public void visit(final int version, final int access, final String name, final String signature, final String superName, final String[] interfaces) Visits the header of the class. Parameters version:int 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:int 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:String the internal name of the class (see `Type#getInternalName()`). signature:String 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:String 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:String[] the internal names of the class's interfaces (see `Type#getInternalName()`). May be null.

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

Visits the header of the class.

Parameters

version:int: 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:int: 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:String: the internal name of the class (see Type#getInternalName()).
signature:String: 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:String: 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:String[]: the internal names of the class's interfaces (see Type#getInternalName()). May be null.

visitAnnotation	back to summary
public AnnotationVisitor visitAnnotation(final String descriptor, final boolean visible) Visits an annotation of the class. Parameters descriptor:String the class descriptor of the annotation class. visible:boolean true if the annotation is visible at runtime. Returns:AnnotationVisitor a visitor to visit the annotation values, or null if this visitor is not interested in visiting this annotation.

visitAnnotation

back to summary

public AnnotationVisitor visitAnnotation(final String descriptor, final boolean visible)

Visits an annotation of the class.

Parameters

descriptor:String: the class descriptor of the annotation class.
visible:boolean: true if the annotation is visible at runtime.

Returns:AnnotationVisitor

a visitor to visit the annotation values, or null if this visitor is not interested in visiting this annotation.

visitAttribute	back to summary
public void visitAttribute(final Attribute attribute) Visits a non standard attribute of the class. Parameters attribute:Attribute an attribute.

visitAttribute

back to summary

public void visitAttribute(final Attribute attribute)

Visits a non standard attribute of the class.

Parameters

attribute:Attribute: an attribute.

visitEnd	back to summary
public void visitEnd() 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.

visitField back to summary

visitField	back to summary
public FieldVisitor visitField(final int access, final String name, final String descriptor, final String signature, final Object value) Visits a field of the class. Parameters access:int the field's access flags (see `Opcodes`). This parameter also indicates if the field is synthetic and/or deprecated. name:String the field's name. descriptor:String the field's descriptor (see `Type`). signature:String the field's signature. May be null if the field's type does not use generic types. value:Object 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. Returns:FieldVisitor a visitor to visit field annotations and attributes, or null if this class visitor is not interested in visiting these annotations and attributes.

public FieldVisitor visitField(final int access, final String name, final String descriptor, final String signature, final Object value)

Visits a field of the class.

Parameters

access:int: the field's access flags (see Opcodes). This parameter also indicates if the field is synthetic and/or deprecated.
name:String: the field's name.
descriptor:String: the field's descriptor (see Type).
signature:String: the field's signature. May be null if the field's type does not use generic types.
value:Object: 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.

Returns:FieldVisitor

a visitor to visit field annotations and attributes, or null if this class visitor is not interested in visiting these annotations and attributes.

visitInnerClass back to summary

visitInnerClass	back to summary
public void visitInnerClass(final String name, final String outerName, final String innerName, final int access) 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. Parameters name:String the internal name of C (see `Type#getInternalName()`). outerName:String 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:String the (simple) name of C. Must be null for anonymous inner classes. access:int the access flags of C originally declared in the source code from which this class was compiled.

public void visitInnerClass(final String name, final String outerName, final String innerName, final int access)

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.

Parameters

name:String: the internal name of C (see Type#getInternalName()).
outerName:String: 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:String: the (simple) name of C. Must be null for anonymous inner classes.
access:int: the access flags of C originally declared in the source code from which this class was compiled.

visitMethod back to summary

visitMethod	back to summary
public MethodVisitor visitMethod(final int access, final String name, final String descriptor, final String signature, final 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. Parameters access:int the method's access flags (see `Opcodes`). This parameter also indicates if the method is synthetic and/or deprecated. name:String the method's name. descriptor:String the method's descriptor (see `Type`). signature:String the method's signature. May be null if the method parameters, return type and exceptions do not use generic types. exceptions:String[] the internal names of the method's exception classes (see `Type#getInternalName()`). May be null. Returns:MethodVisitor 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.

public MethodVisitor visitMethod(final int access, final String name, final String descriptor, final String signature, final 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.

Parameters

access:int: the method's access flags (see Opcodes). This parameter also indicates if the method is synthetic and/or deprecated.
name:String: the method's name.
descriptor:String: the method's descriptor (see Type).
signature:String: the method's signature. May be null if the method parameters, return type and exceptions do not use generic types.
exceptions:String[]: the internal names of the method's exception classes (see Type#getInternalName()). May be null.

Returns:MethodVisitor

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.

visitModule back to summary

visitModule	back to summary
public ModuleVisitor visitModule(final String name, final int access, final String version) Visit the module corresponding to the class. Parameters name:String the fully qualified name (using dots) of the module. access:int the module access flags, among `ACC_OPEN`, `ACC_SYNTHETIC` and `ACC_MANDATED`. version:String the module version, or null. Returns:ModuleVisitor a visitor to visit the module values, or null if this visitor is not interested in visiting this module.

public ModuleVisitor visitModule(final String name, final int access, final String version)

Visit the module corresponding to the class.

Parameters

name:String: the fully qualified name (using dots) of the module.
access:int: the module access flags, among ACC_OPEN, ACC_SYNTHETIC and ACC_MANDATED.
version:String: the module version, or null.

Returns:ModuleVisitor

a visitor to visit the module values, or null if this visitor is not interested in visiting this module.

visitNestHost back to summary

visitNestHost	back to summary
public void visitNestHost(final String nestHost) 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. Parameters nestHost:String the internal name of the host class of the nest (see `Type#getInternalName()`).

public void visitNestHost(final String nestHost)

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.

Parameters

nestHost:String: the internal name of the host class of the nest (see Type#getInternalName()).

visitNestMember back to summary

visitNestMember	back to summary
public void visitNestMember(final String nestMember) 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. Parameters nestMember:String the internal name of a nest member (see `Type#getInternalName()`).

public void visitNestMember(final String nestMember)

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.

Parameters

nestMember:String: the internal name of a nest member (see Type#getInternalName()).

visitOuterClass back to summary

visitOuterClass	back to summary
public void visitOuterClass(final String owner, final String name, final String descriptor) 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. Parameters owner:String internal name of the enclosing class of the class (see `Type#getInternalName()`). name:String 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:String 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 void visitOuterClass(final String owner, final String name, final String descriptor)

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.

Parameters

owner:String: internal name of the enclosing class of the class (see Type#getInternalName()).
name:String: 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:String: 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).

visitPermittedSubclass back to summary

visitPermittedSubclass	back to summary
public void visitPermittedSubclass(final String permittedSubclass) Visits a permitted subclasses. A permitted subclass is one of the allowed subclasses of the current class. Parameters permittedSubclass:String the internal name of a permitted subclass (see `Type#getInternalName()`).

public void visitPermittedSubclass(final String permittedSubclass)

Visits a permitted subclasses. A permitted subclass is one of the allowed subclasses of the current class.

Parameters

permittedSubclass:String: the internal name of a permitted subclass (see Type#getInternalName()).

visitRecordComponent back to summary

visitRecordComponent	back to summary
public RecordComponentVisitor visitRecordComponent(final String name, final String descriptor, final String signature) Visits a record component of the class. Parameters name:String the record component name. descriptor:String the record component descriptor (see `Type`). signature:String the record component signature. May be null if the record component type does not use generic types. Returns:RecordComponentVisitor 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.

public RecordComponentVisitor visitRecordComponent(final String name, final String descriptor, final String signature)

Visits a record component of the class.

Parameters

name:String: the record component name.
descriptor:String: the record component descriptor (see Type).
signature:String: the record component signature. May be null if the record component type does not use generic types.

Returns:RecordComponentVisitor

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.

visitSource	back to summary
public void visitSource(final String source, final String debug) Visits the source of the class. Parameters source:String the name of the source file from which the class was compiled. May be null. debug:String additional debug information to compute the correspondence between source and compiled elements of the class. May be null.

visitSource

back to summary

public void visitSource(final String source, final String debug)

Visits the source of the class.

Parameters

source:String: the name of the source file from which the class was compiled. May be null.
debug:String: additional debug information to compute the correspondence between source and compiled elements of the class. May be null.

visitTypeAnnotation back to summary

visitTypeAnnotation	back to summary
public AnnotationVisitor visitTypeAnnotation(final int typeRef, final TypePath typePath, final String descriptor, final boolean visible) Visits an annotation on a type in the class signature. Parameters typeRef:int 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: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:String the class descriptor of the annotation class. visible:boolean true if the annotation is visible at runtime. Returns:AnnotationVisitor a visitor to visit the annotation values, or null if this visitor is not interested in visiting this annotation.

public AnnotationVisitor visitTypeAnnotation(final int typeRef, final TypePath typePath, final String descriptor, final boolean visible)

Visits an annotation on a type in the class signature.

Parameters

typeRef:int: 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: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:String: the class descriptor of the annotation class.
visible:boolean: true if the annotation is visible at runtime.

Returns:AnnotationVisitor

a visitor to visit the annotation values, or null if this visitor is not interested in visiting this annotation.

public abstract Class ClassVisitor

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail