org.objectweb.asm.tree
Class ClassNode

java.lang.Object
  extended by org.objectweb.asm.tree.MemberNode
      extended by org.objectweb.asm.tree.ClassNode
All Implemented Interfaces:
ClassVisitor

public class ClassNode
extends MemberNode
implements ClassVisitor

A node that represents a class.

Author:
Eric Bruneton

Field Summary
 int access
          The class's access flags (see Opcodes).
 java.util.List fields
          The fields of this class.
 java.util.List innerClasses
          Informations about the inner classes of this class.
 java.util.List interfaces
          The internal names of the class's interfaces (see getInternalName).
 java.util.List methods
          The methods of this class.
 java.lang.String name
          The internal name of the class (see getInternalName).
 java.lang.String outerClass
          The internal name of the enclosing class of the class.
 java.lang.String outerMethod
          The name of the method that contains the class, or null if the class is not enclosed in a method.
 java.lang.String outerMethodDesc
          The descriptor of the method that contains the class, or null if the class is not enclosed in a method.
 java.lang.String signature
          The signature of the class.
 java.lang.String sourceDebug
          Debug information to compute the correspondance between source and compiled elements of the class.
 java.lang.String sourceFile
          The name of the source file from which this class was compiled.
 java.lang.String superName
          The internal of name of the super class (see getInternalName).
 int version
          The class version.
 
Fields inherited from class org.objectweb.asm.tree.MemberNode
attrs, invisibleAnnotations, visibleAnnotations
 
Constructor Summary
ClassNode()
          Constructs a new ClassNode.
 
Method Summary
 void accept(ClassVisitor cv)
          Makes the given class visitor visit this class.
 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.
 void visitEnd()
          Visits the end of this class, field or method.
 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 file, java.lang.String debug)
          Visits the source of the class.
 
Methods inherited from class org.objectweb.asm.tree.MemberNode
visitAnnotation, visitAttribute
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.objectweb.asm.ClassVisitor
visitAnnotation, visitAttribute
 

Field Detail

version

public int version
The class version.


access

public int access
The class's access flags (see Opcodes). This field also indicates if the class is deprecated.


name

public java.lang.String name
The internal name of the class (see getInternalName).


signature

public java.lang.String signature
The signature of the class. Mayt be null.


superName

public java.lang.String 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

public java.util.List interfaces
The internal names of the class's interfaces (see getInternalName). This list is a list of String objects.


sourceFile

public java.lang.String sourceFile
The name of the source file from which this class was compiled. May be null.


sourceDebug

public java.lang.String sourceDebug
Debug information to compute the correspondance between source and compiled elements of the class. May be null.


outerClass

public java.lang.String outerClass
The internal name of the enclosing class of the class. May be null.


outerMethod

public java.lang.String outerMethod
The name of the method that contains the class, or null if the class is not enclosed in a method.


outerMethodDesc

public java.lang.String outerMethodDesc
The descriptor of the method that contains the class, or null if the class is not enclosed in a method.


innerClasses

public java.util.List innerClasses
Informations about the inner classes of this class. This list is a list of InnerClassNode objects.


fields

public java.util.List fields
The fields of this class. This list is a list of FieldNode objects.


methods

public java.util.List methods
The methods of this class. This list is a list of MethodNode objects.

Constructor Detail

ClassNode

public ClassNode()
Constructs a new ClassNode.

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)
Description copied from interface: ClassVisitor
Visits the header of the class.

Specified by:
visit in interface ClassVisitor
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(java.lang.String file,
                        java.lang.String debug)
Description copied from interface: ClassVisitor
Visits the source of the class.

Specified by:
visitSource in interface ClassVisitor
Parameters:
file - 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(java.lang.String owner,
                            java.lang.String name,
                            java.lang.String desc)
Description copied from interface: ClassVisitor
Visits the enclosing class of the class. This method must be called only if the class has an enclosing class.

Specified by:
visitOuterClass in interface ClassVisitor
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.

visitInnerClass

public void visitInnerClass(java.lang.String name,
                            java.lang.String outerName,
                            java.lang.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
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 FieldVisitor visitField(int access,
                               java.lang.String name,
                               java.lang.String desc,
                               java.lang.String signature,
                               java.lang.Object value)
Description copied from interface: ClassVisitor
Visits a field of the class.

Specified by:
visitField in interface ClassVisitor
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,
                                 java.lang.String name,
                                 java.lang.String desc,
                                 java.lang.String signature,
                                 java.lang.String[] exceptions)
Description copied from interface: ClassVisitor
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.

Specified by:
visitMethod in interface ClassVisitor
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()
Description copied from class: MemberNode
Visits the end of this class, field or method.

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

accept

public void accept(ClassVisitor cv)
Makes the given class visitor visit this class.

Parameters:
cv - a class visitor.