Summary: Methods | [Expand All]
public interface

ClassVisitor

org.sonatype.guice.bean.scanners.asm.ClassVisitor
Known Indirect Subclasses

Class Overview

A visitor to visit a Java class. The methods of this interface must be called in the following order: visit [ visitSource ] [ visitOuterClass ] ( visitAnnotation | visitAttribute )* (visitInnerClass | visitField | visitMethod )* visitEnd.

Summary

Public Methods
abstract void visit(int version, int access, String name, String signature, String superName, String[] interfaces)
Visits the header of the class.
abstract AnnotationVisitor visitAnnotation(String desc, boolean visible)
Visits an annotation of the class.
abstract void visitAttribute(Attribute attr)
Visits a non standard attribute of the class.
abstract void visitEnd()
Visits the end of the class.
abstract FieldVisitor visitField(int access, String name, String desc, String signature, Object value)
Visits a field of the class.
abstract void visitInnerClass(String name, String outerName, String innerName, int access)
Visits information about an inner class.
abstract MethodVisitor visitMethod(int access, String name, String desc, String signature, String[] exceptions)
Visits a method of the class.
abstract void visitOuterClass(String owner, String name, String desc)
Visits the enclosing class of the class.
abstract void visitSource(String source, String debug)
Visits the source of the class.

Public Methods

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

Visits the header of the class.

Parameters
version the class version.
access the class's access flags (see Opcodes). This parameter also indicates if the class is deprecated.
name the internal name of the class (see 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 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 getInternalName). May be null.

public abstract AnnotationVisitor visitAnnotation (String desc, boolean visible)

Visits an annotation of the class.

Parameters
desc the class descriptor of the annotation class.
visible true if the annotation is visible at runtime.
Returns
  • a visitor to visit the annotation values, or null if this visitor is not interested in visiting this annotation.

public abstract void visitAttribute (Attribute attr)

Visits a non standard attribute of the class.

Parameters
attr an attribute.

public abstract 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.

public abstract FieldVisitor visitField (int access, String name, String desc, String signature, Object value)

Visits a field of the class.

Parameters
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.
desc 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.
Returns
  • a visitor to visit field annotations and attributes, or null if this class visitor is not interested in visiting these annotations and attributes.

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

Visits information about an inner class. This inner class is not necessarily a member of the class being visited.

Parameters
name the internal name of an inner class (see getInternalName).
outerName the internal name of the class to which the inner class belongs (see getInternalName). May be null for not member classes.
innerName the (simple) name of the inner class inside its enclosing class. May be null for anonymous inner classes.
access the access flags of the inner class as originally declared in the enclosing class.

public abstract MethodVisitor visitMethod (int access, String name, String desc, 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.

Parameters
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.
desc 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 getInternalName). May be null.
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.

public abstract void visitOuterClass (String owner, String name, String desc)

Visits the enclosing class of the class. This method must be called only if the class has an enclosing class.

Parameters
owner internal name of the enclosing class of the class.
name the name of the method that contains the class, or null if the class is not enclosed in a method of its enclosing class.
desc the descriptor of the method that contains the class, or null if the class is not enclosed in a method of its enclosing class.

public abstract void visitSource (String source, String debug)

Visits the source of the class.

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