oracle.toplink.libraries.asm

Interface ClassVisitor

All Known Implementing Classes:

ASMifierClassVisitor, CheckClassAdapter, ClassAdapter, ClassWriter, PrintClassVisitor, SAXClassAdapter, TopLinkClassWeaver, TraceClassVisitor, TreeClassAdapter

public interface ClassVisitor

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

Author:

Eric Bruneton

Method Summary

Modifier and Type	Method and Description
void	visit(int version, int access, String name, String superName, String[] interfaces, String sourceFile) Visits the header of the class.
void	visitAttribute(Attribute attr) Visits a non standard attribute of the class.
void	visitEnd() Visits the end of the class.
void	visitField(int access, String name, String desc, Object value, Attribute attrs) Visits a field of the class.
void	visitInnerClass(String name, String outerName, String innerName, int access) Visits information about an inner class.
CodeVisitor	visitMethod(int access, String name, String desc, String[] exceptions, Attribute attrs) Visits a method of the class.

Method Detail

visit

void visit(int version,
           int access,
           String name,
           String superName,
           String[] interfaces,
           String sourceFile)

Visits the header of the class.

Parameters:

version - the class version.

access - the class's access flags (see Constants). This parameter also indicates if the class is deprecated.

name - the internal name of the class (see getInternalName).

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 java.lang.Object class.

interfaces - the internal names of the class's interfaces (see getInternalName). May be null.

sourceFile - the name of the source file from which this class was compiled. May be null.

visitInnerClass

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.

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

void visitField(int access,
                String name,
                String desc,
                Object value,
                Attribute attrs)

Visits a field of the class.

Parameters:

access - the field's access flags (see Constants). This parameter also indicates if the field is synthetic and/or deprecated.

name - the field's name.

desc - the field's descriptor (see Type).

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.

attrs - the non standard method attributes, linked together by their next field. May be null.

visitMethod

CodeVisitor visitMethod(int access,
                        String name,
                        String desc,
                        String[] exceptions,
                        Attribute attrs)

Visits a method of the class. This method must return a new CodeVisitor 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 Constants). This parameter also indicates if the method is synthetic and/or deprecated.

name - the method's name.

desc - the method's descriptor (see Type).

exceptions - the internal names of the method's exception classes (see getInternalName). May be null.

attrs - the non standard method attributes, linked together by their next field. 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.

visitAttribute

void visitAttribute(Attribute attr)

Visits a non standard attribute of the class. This method must visit only the first attribute in the given attribute list.

Parameters:

attr - a non standard class attribute. Must not be null.

visitEnd

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.