org.ow2.asmdex
Class ClassVisitor

java.lang.Object
  org.ow2.asmdex.ClassVisitor

Direct Known Subclasses:

AsmDexifierClassVisitor, ClassNode, ClassWriter, RegisterShiftClassAdapter

public abstract class ClassVisitor
extends java.lang.Object

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

Changes with ASM :

• visit : the parameters have no effect and are only given for compatibility with ASM, as the Class currently visited has its identity given by ApplicationVisitor.visitClass. Also, the signature is now an array of Strings, instead of just one String.
• visitSource : the Debug information is ignored by AsmDex, and is only there for compatibility with ASM.
• visitAttribute : this method has no effect in AsmDex, since Attributes are not supported.
• The "deprecated" flag is not encoded in the access flags.

Note :

• In ASM, it seems visitOuterClass() is only called from an Inner class INSIDE a Method, not a Class.

Author:

Julien Névo, based on the ASM Framework.

Field Summary

protected int	api The ASM API version implemented by this visitor.
protected ClassVisitor	cv he class visitor to which this visitor must delegate method calls.

Constructor Summary

ClassVisitor(int api)
Constructs a new ClassVisitor.

ClassVisitor(int api, ClassVisitor cv)
Constructs a new ClassVisitor.

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

cv

protected ClassVisitor cv

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

api

protected final int api

The ASM API version implemented by this visitor.

Constructor Detail

ClassVisitor

public ClassVisitor(int api)

Constructs a new ClassVisitor.

ClassVisitor

public ClassVisitor(int api,
                    ClassVisitor cv)

Constructs a new ClassVisitor.

Parameters:

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,
                  java.lang.String name,
                  java.lang.String[] signature,
                  java.lang.String superName,
                  java.lang.String[] interfaces)

Visits the header of the class. The information given here is only given for compatibility with ASM. They are NOT used by AsmDex, as the Class currently visited has its identity given by ApplicationVisitor.visitClass.

Parameters:

version - the class version. Ignored by AsmDex, only here for compatibility with ASM.

access - the class's access flags (see Opcodes). Ignored by AsmDex, only here for compatibility with ASM, as this parameter has already been filled by an ApplicationVisitor.

name - the internal name of the class. Ignored by AsmDex, only here for compatibility with ASM, as this parameter has already been filled by an ApplicationVisitor.

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. Ignored by AsmDex, only here for compatibility with ASM, as this parameter has already been filled by an ApplicationVisitor.

superName - the internal of name of the super class. For interfaces, the super class is Object. May be null, but only for the Object class. Ignored by AsmDex, only here for compatibility with ASM, as this parameter has already been filled by an ApplicationVisitor.

interfaces - the internal names of the class's interfaces. May be null. Ignored by AsmDex, only here for compatibility with ASM, as this parameter has already been filled by an ApplicationVisitor.

visitSource

public void visitSource(java.lang.String source,
                        java.lang.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 link between source and compiled elements of the class. May be null. This parameter is ignored by AsmDex, and is only there for compatibility with ASM.

visitOuterClass

public void visitOuterClass(java.lang.String owner,
                            java.lang.String name,
                            java.lang.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(java.lang.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.

visitAttribute

public void visitAttribute(java.lang.Object attr)

Visits a non standard attribute of the class. This method is ignored by AsmDex, since attributes are not supported.

Parameters:

attr - an attribute.

visitInnerClass

public void visitInnerClass(java.lang.String name,
                            java.lang.String outerName,
                            java.lang.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.

outerName - the internal name of the class to which the inner class belongs. 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,
                               java.lang.String name,
                               java.lang.String desc,
                               java.lang.String[] signature,
                               java.lang.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.

name - the field's name.

desc - the field's descriptor.

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,
                                 java.lang.String name,
                                 java.lang.String desc,
                                 java.lang.String[] signature,
                                 java.lang.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.

name - the method's name.

desc - the method's descriptor.

signature - the field's signature. May be null if the field's type does not use generic types.

exceptions - the internal names of the method's exception classes. 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.