net.bytebuddy.utility.visitor

Class MetadataAwareClassVisitor

java.lang.Object

org.objectweb.asm.ClassVisitor

net.bytebuddy.utility.visitor.MetadataAwareClassVisitor

Direct Known Subclasses:

TypeWriter.Default.ForCreation.CreationClassVisitor, TypeWriter.Default.ForInlining.WithDecorationOnly.DecorationClassVisitor, TypeWriter.Default.ForInlining.WithFullProcessing.RedefinitionClassVisitor

public abstract class MetadataAwareClassVisitor
extends ClassVisitor

A class visitor that traces invocations of visitation methods and notifies if a nest host or outer class was not visited.

Field Summary

Fields inherited from class org.objectweb.asm.ClassVisitor

api, cv

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MetadataAwareClassVisitor(int api, ClassVisitor classVisitor) Creates a metadata aware class visitor.

Method Summary

Modifier and Type	Method and Description
protected void	onAfterAttributes() Invoked if the attribute visitation is about to complete.
protected void	onNestHost() Invoked if the nest host was not visited.
protected void	onOuterType() Invoked if the outer class was not visited.
protected AnnotationVisitor	onVisitAnnotation(String descriptor, boolean visible) An order-sensitive invocation of ClassVisitor.visitAnnotation(String, boolean).
protected void	onVisitAttribute(Attribute attribute) An order-sensitive invocation of ClassVisitor.visitAttribute(Attribute).
protected void	onVisitEnd() An order-sensitive invocation of ClassVisitor.visitEnd().
protected FieldVisitor	onVisitField(int modifiers, String internalName, String descriptor, String signature, Object value) An order-sensitive invocation of ClassVisitor.visitField(int, String, String, String, Object).
protected void	onVisitInnerClass(String internalName, String outerName, String innerName, int modifiers) An order-sensitive invocation of ClassVisitor.visitInnerClass(String, String, String, int).
protected MethodVisitor	onVisitMethod(int modifiers, String internalName, String descriptor, String signature, String[] exception) An order-sensitive invocation of ClassVisitor.visitMethod(int, String, String, String, String[]).
protected void	onVisitNestHost(String nestHost) An order-sensitive invocation of ClassVisitor.visitNestHost(String).
protected void	onVisitNestMember(String nestMember) An order-sensitive invocation of ClassVisitor.visitNestMember(String).
protected void	onVisitOuterClass(String owner, String name, String descriptor) An order-sensitive invocation of ClassVisitor.visitOuterClass(String, String, String).
protected void	onVisitPermittedSubclass(String permittedSubclass) An order-sensitive invocation of ClassVisitor#visitPermittedSubclass.
protected RecordComponentVisitor	onVisitRecordComponent(String name, String descriptor, String signature) An order-sensitive invocation of ClassVisitor.visitRecordComponent(String, String, String).
protected AnnotationVisitor	onVisitTypeAnnotation(int typeReference, TypePath typePath, String descriptor, boolean visible) An order-sensitive invocation of ClassVisitor.visitTypeAnnotation(int, TypePath, String, boolean).
AnnotationVisitor	visitAnnotation(String descriptor, boolean visible)
void	visitAttribute(Attribute attribute)
void	visitEnd()
FieldVisitor	visitField(int modifiers, String internalName, String descriptor, String signature, Object value)
void	visitInnerClass(String name, String outerName, String innerName, int modifiers)
MethodVisitor	visitMethod(int modifiers, String internalName, String descriptor, String signature, String[] exception)
void	visitNestHost(String nestHost)
void	visitNestMember(String nestMember)
void	visitOuterClass(String owner, String name, String descriptor)
void	visitPermittedSubclass(String permittedSubclass)
RecordComponentVisitor	visitRecordComponent(String name, String descriptor, String signature)
AnnotationVisitor	visitTypeAnnotation(int typeReference, TypePath typePath, String descriptor, boolean visible)

Methods inherited from class org.objectweb.asm.ClassVisitor

getDelegate, visit, visitModule, visitSource

Methods inherited from class java.lang.Object

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

Constructor Detail

MetadataAwareClassVisitor

protected MetadataAwareClassVisitor(int api,
                                    ClassVisitor classVisitor)

Creates a metadata aware class visitor.

Parameters:

api - The API version.

classVisitor - The class visitor to delegate to.

Method Detail

onNestHost

protected void onNestHost()

Invoked if the nest host was not visited.

onOuterType

protected void onOuterType()

Invoked if the outer class was not visited.

onAfterAttributes

protected void onAfterAttributes()

Invoked if the attribute visitation is about to complete.

visitNestHost

public final void visitNestHost(String nestHost)

Overrides:

visitNestHost in class ClassVisitor

onVisitNestHost

protected void onVisitNestHost(String nestHost)

An order-sensitive invocation of ClassVisitor.visitNestHost(String).

Parameters:

nestHost - The internal name of the nest host.

visitOuterClass

public final void visitOuterClass(String owner,
                                  @MaybeNull
                                  String name,
                                  @MaybeNull
                                  String descriptor)

Overrides:

visitOuterClass in class ClassVisitor

onVisitOuterClass

protected void onVisitOuterClass(String owner,
                                 @MaybeNull
                                 String name,
                                 @MaybeNull
                                 String descriptor)

An order-sensitive invocation of ClassVisitor.visitOuterClass(String, String, String).

Parameters:

owner - The outer class's internal name.

name - The outer method's name or null if it does not exist.

descriptor - The outer method's descriptor or null if it does not exist.

visitPermittedSubclass

public final void visitPermittedSubclass(String permittedSubclass)

Overrides:

visitPermittedSubclass in class ClassVisitor

onVisitPermittedSubclass

protected void onVisitPermittedSubclass(String permittedSubclass)

An order-sensitive invocation of ClassVisitor#visitPermittedSubclass.

Parameters:

permittedSubclass - The internal name of the permitted subclass.

visitRecordComponent

@MaybeNull
public RecordComponentVisitor visitRecordComponent(String name,
                                                              String descriptor,
                                                              @MaybeNull
                                                              String signature)

Overrides:

visitRecordComponent in class ClassVisitor

onVisitRecordComponent

@MaybeNull
protected RecordComponentVisitor onVisitRecordComponent(String name,
                                                                   String descriptor,
                                                                   @MaybeNull
                                                                   String signature)

An order-sensitive invocation of ClassVisitor.visitRecordComponent(String, String, String).

Parameters:

name - The record component's name.

descriptor - The record component's descriptor.

signature - The record component's generic signature or null if the record component's type is non-generic.

Returns:

The record component visitor or null if the component should not be visited.

visitAnnotation

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

Overrides:

visitAnnotation in class ClassVisitor

onVisitAnnotation

@MaybeNull
protected AnnotationVisitor onVisitAnnotation(String descriptor,
                                                         boolean visible)

An order-sensitive invocation of ClassVisitor.visitAnnotation(String, boolean).

Parameters:

descriptor - The annotation type's descriptor.

visible - true if the annotation is visible at runtime.

Returns:

An annotation visitor or null if the annotation should be ignored.

visitTypeAnnotation

@MaybeNull
public final AnnotationVisitor visitTypeAnnotation(int typeReference,
                                                              TypePath typePath,
                                                              String descriptor,
                                                              boolean visible)

Overrides:

visitTypeAnnotation in class ClassVisitor

onVisitTypeAnnotation

@MaybeNull
protected AnnotationVisitor onVisitTypeAnnotation(int typeReference,
                                                             TypePath typePath,
                                                             String descriptor,
                                                             boolean visible)

An order-sensitive invocation of ClassVisitor.visitTypeAnnotation(int, TypePath, String, boolean).

Parameters:

typeReference - The type reference of the type annotation.

typePath - The type path of the type annotation.

descriptor - The descriptor of the annotation type.

visible - true if the annotation is visible at runtime.

Returns:

An annotation visitor or null if the annotation should be ignored.

visitAttribute

public final void visitAttribute(Attribute attribute)

Overrides:

visitAttribute in class ClassVisitor

onVisitAttribute

protected void onVisitAttribute(Attribute attribute)

An order-sensitive invocation of ClassVisitor.visitAttribute(Attribute).

Parameters:

attribute - The attribute to visit.

visitNestMember

public final void visitNestMember(String nestMember)

Overrides:

visitNestMember in class ClassVisitor

onVisitNestMember

protected void onVisitNestMember(String nestMember)

An order-sensitive invocation of ClassVisitor.visitNestMember(String).

Parameters:

nestMember - The internal name of the nest member.

visitInnerClass

public final void visitInnerClass(String name,
                                  @MaybeNull
                                  String outerName,
                                  @MaybeNull
                                  String innerName,
                                  int modifiers)

Overrides:

visitInnerClass in class ClassVisitor

onVisitInnerClass

protected void onVisitInnerClass(String internalName,
                                 @MaybeNull
                                 String outerName,
                                 @MaybeNull
                                 String innerName,
                                 int modifiers)

An order-sensitive invocation of ClassVisitor.visitInnerClass(String, String, String, int).

Parameters:

internalName - The internal name of the inner class.

outerName - The internal name of the outer class or null for a member class.

innerName - The inner class's simple name or null for an anonymous class.

modifiers - The inner class's source code modifiers.

visitField

@MaybeNull
public final FieldVisitor visitField(int modifiers,
                                                String internalName,
                                                String descriptor,
                                                @MaybeNull
                                                String signature,
                                                @MaybeNull
                                                Object value)

Overrides:

visitField in class ClassVisitor

onVisitField

@MaybeNull
protected FieldVisitor onVisitField(int modifiers,
                                               String internalName,
                                               String descriptor,
                                               @MaybeNull
                                               String signature,
                                               @MaybeNull
                                               Object value)

An order-sensitive invocation of ClassVisitor.visitField(int, String, String, String, Object).

Parameters:

modifiers - The field's modifiers.

internalName - The field's internal name.

descriptor - The field type's descriptor.

signature - The field's generic signature or null if the field is not generic.

value - The field's default value or null if no such value exists.

Returns:

A field visitor to visit the field or null to ignore it.

visitMethod

@MaybeNull
public final MethodVisitor visitMethod(int modifiers,
                                                  String internalName,
                                                  String descriptor,
                                                  @MaybeNull
                                                  String signature,
                                                  @MaybeNull
                                                  String[] exception)

Overrides:

visitMethod in class ClassVisitor

onVisitMethod

@MaybeNull
protected MethodVisitor onVisitMethod(int modifiers,
                                                 String internalName,
                                                 String descriptor,
                                                 @MaybeNull
                                                 String signature,
                                                 @MaybeNull
                                                 String[] exception)

An order-sensitive invocation of ClassVisitor.visitMethod(int, String, String, String, String[]).

Parameters:

modifiers - The method's modifiers.

internalName - The method's internal name.

descriptor - The field type's descriptor.

signature - The method's generic signature or null if the method is not generic.

exception - The method's declared exceptions or null if no exceptions are declared.

Returns:

A method visitor to visit the method or null to ignore it.

visitEnd

public final void visitEnd()

Overrides:

visitEnd in class ClassVisitor

onVisitEnd

protected void onVisitEnd()

An order-sensitive invocation of ClassVisitor.visitEnd().