org.springframework.asm

Class ClassVisitor

java.lang.Object

org.springframework.asm.ClassVisitor

Direct Known Subclasses:

AnnotationMetadataReadingVisitor, ClassWriter

public abstract class ClassVisitor
extends Object

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

Author:

Eric Bruneton

Field Summary

Fields

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.

Constructor Summary

Constructors

Constructor and Description
ClassVisitor(int api) Constructs a new ClassVisitor.
ClassVisitor(int api, ClassVisitor cv) Constructs a new ClassVisitor.

Method Summary

Modifier and Type	Method and Description
void	visit(int version, int access, String name, String signature, String superName, String[] interfaces) Visits the header of the class.
AnnotationVisitor	visitAnnotation(String desc, boolean visible) Visits an annotation of the class.
void	visitAttribute(Attribute attr) Visits a non standard attribute of the class.
void	visitEnd() Visits the end of the class.
FieldVisitor	visitField(int access, String name, String desc, 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 desc, String signature, String[] exceptions) Visits a method of the class.
void	visitOuterClass(String owner, String name, String desc) Visits the enclosing class of the class.
void	visitSource(String source, String debug) Visits the source of the class.
AnnotationVisitor	visitTypeAnnotation(int typeRef, TypePath typePath, String desc, boolean visible) Visits an annotation on a type in the class signature.

Methods inherited from class java.lang.Object

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

Field Detail

api

protected final int api

The ASM API version implemented by this visitor. The value of this field must be one of Opcodes.ASM4 or Opcodes.ASM5.

cv

protected ClassVisitor cv

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

Constructor Detail

ClassVisitor

public ClassVisitor(int api)

Constructs a new ClassVisitor.

Parameters:

api - the ASM API version implemented by this visitor. Must be one of Opcodes.ASM4 or Opcodes.ASM5.

ClassVisitor

public ClassVisitor(int api,
                    ClassVisitor cv)

Constructs a new ClassVisitor.

Parameters:

api - the ASM API version implemented by this visitor. Must be one of Opcodes.ASM4 or Opcodes.ASM5.

cv - the class visitor to which this visitor must delegate method calls. May be null.

Method Detail

visit

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

visitSource

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

visitOuterClass

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

visitAnnotation

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

visitTypeAnnotation

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

Visits an annotation on a type in the class signature.

Parameters:

typeRef - a reference to the annotated type. The sort of this type reference must be CLASS_TYPE_PARAMETER, CLASS_TYPE_PARAMETER_BOUND or 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.

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.

visitAttribute

public void visitAttribute(Attribute attr)

Visits a non standard attribute of the class.

Parameters:

attr - an attribute.

visitInnerClass

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

visitField

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

visitMethod

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

visitEnd

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.