org.objectweb.asm.tree
Class TreeClassAdapter

java.lang.Object
  extended by org.objectweb.asm.ClassAdapter
      extended by org.objectweb.asm.tree.TreeClassAdapter
All Implemented Interfaces:
ClassVisitor

public class TreeClassAdapter
extends ClassAdapter

A ClassAdapter that constructs a tree representation of the classes it vists. Each visitXXX method of this class constructs an XXXNode and adds it to the classNode node (except the visitEnd method, which just makes the cv class visitor visit the tree that has just been constructed).

In order to implement a usefull class adapter based on a tree representation of classes, one just need to override the visitEnd method with a method of the following form:

 public void visitEnd () {
   // ...
   // code to modify the classNode tree, can be arbitrary complex
   // ...
   // makes the cv visitor visit this modified class:
   classNode.accept(cv);
 }
 

Author:
Eric Bruneton

Field Summary
 ClassNode classNode
          A tree representation of the class that is being visited by this visitor.
 
Fields inherited from class org.objectweb.asm.ClassAdapter
cv
 
Constructor Summary
TreeClassAdapter(ClassVisitor cv)
          Constructs a new TreeClassAdapter object.
 
Method Summary
 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.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

classNode

public ClassNode classNode
A tree representation of the class that is being visited by this visitor.

Constructor Detail

TreeClassAdapter

public TreeClassAdapter(ClassVisitor cv)
Constructs a new TreeClassAdapter object.

Parameters:
cv - the class visitor to which this adapter must delegate calls.
Method Detail

visit

public void visit(int version,
                  int access,
                  String name,
                  String superName,
                  String[] interfaces,
                  String sourceFile)
Description copied from interface: ClassVisitor
Visits the header of the class.

Specified by:
visit in interface ClassVisitor
Overrides:
visit in class ClassAdapter
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

public void visitInnerClass(String name,
                            String outerName,
                            String innerName,
                            int access)
Description copied from interface: ClassVisitor
Visits information about an inner class. This inner class is not necessarily a member of the class being visited.

Specified by:
visitInnerClass in interface ClassVisitor
Overrides:
visitInnerClass in class ClassAdapter
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

public void visitField(int access,
                       String name,
                       String desc,
                       Object value,
                       Attribute attrs)
Description copied from interface: ClassVisitor
Visits a field of the class.

Specified by:
visitField in interface ClassVisitor
Overrides:
visitField in class ClassAdapter
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

public CodeVisitor visitMethod(int access,
                               String name,
                               String desc,
                               String[] exceptions,
                               Attribute attrs)
Description copied from interface: ClassVisitor
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.

Specified by:
visitMethod in interface ClassVisitor
Overrides:
visitMethod in class ClassAdapter
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

public void visitAttribute(Attribute attr)
Description copied from interface: ClassVisitor
Visits a non standard attribute of the class. This method must visit only the first attribute in the given attribute list.

Specified by:
visitAttribute in interface ClassVisitor
Overrides:
visitAttribute in class ClassAdapter
Parameters:
attr - a non standard class attribute. Must not be null.

visitEnd

public void visitEnd()
Description copied from interface: ClassVisitor
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.

Specified by:
visitEnd in interface ClassVisitor
Overrides:
visitEnd in class ClassAdapter