Package org.objectweb.asm.util

Class TraceClassVisitor

  • public final class TraceClassVisitor
extends ClassVisitor
    A ClassVisitor that prints the classes it visits with a Printer. This class visitor can be used in the middle of a class visitor chain to trace the class that is visited at a given point in this chain. This may be useful for debugging purposes.

    When used with a Textifier, the trace printed when visiting the Hello class is the following: 

     // class version 49.0 (49) // access flags 0x21 public class Hello {

 // compiled from: Hello.java

 // access flags 0x1
 public <init> ()V
 ALOAD 0
 INVOKESPECIAL java/lang/Object <init> ()V
 RETURN
 MAXSTACK = 1 MAXLOCALS = 1

 // access flags 0x9
 public static main ([Ljava/lang/String;)V
 GETSTATIC java/lang/System out Ljava/io/PrintStream;
 LDC "hello"
 INVOKEVIRTUAL java/io/PrintStream println (Ljava/lang/String;)V
 RETURN
 MAXSTACK = 2 MAXLOCALS = 1
 }

    where Hello is defined by: 

     public class Hello {

   public static void main(String[] args) {
     System.out.println("hello");
   }
 }

    • Field Summary

      Fields 
      Modifier and Type Field Description
      Printer p
      The printer to convert the visited class into text.
      private java.io.PrintWriter printWriter
      The print writer to be used to print the class.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      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 descriptor, boolean visible)
      Visits an annotation of the class.
      void visitAttribute​(Attribute attribute)
      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 descriptor, 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 descriptor, java.lang.String signature, java.lang.String[] exceptions)
      Visits a method of the class.
      ModuleVisitor visitModule​(java.lang.String name, int flags, java.lang.String version)
      Visit the module corresponding to the class.
      void visitNestHost​(java.lang.String nestHost)
      Visits the nest host class of the class.
      void visitNestMember​(java.lang.String nestMember)
      Visits a member of the nest.
      void visitOuterClass​(java.lang.String owner, java.lang.String name, java.lang.String descriptor)
      Visits the enclosing class of the class.
      void visitPermittedSubclass​(java.lang.String permittedSubclass)
      Visits a permitted subclasses.
      RecordComponentVisitor visitRecordComponent​(java.lang.String name, java.lang.String descriptor, java.lang.String signature)
      Visits a record component of the class.
      void visitSource​(java.lang.String file, java.lang.String debug)
      Visits the source of the class.
      AnnotationVisitor visitTypeAnnotation​(int typeRef, TypePath typePath, java.lang.String descriptor, 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

      • printWriter

        private final java.io.PrintWriter printWriter
        The print writer to be used to print the class. May be null.

      • p

        public final Printer p
        The printer to convert the visited class into text.

    • Constructor Detail

      • TraceClassVisitor

        public TraceClassVisitor​(java.io.PrintWriter printWriter)
        Constructs a new TraceClassVisitor.
        Parameters:
        printWriter - the print writer to be used to print the class. May be null.

      • TraceClassVisitor

        public TraceClassVisitor​(ClassVisitor classVisitor,
                         java.io.PrintWriter printWriter)
        Constructs a new TraceClassVisitor.
        Parameters:
        classVisitor - the class visitor to which to delegate calls. May be null.
        printWriter - the print writer to be used to print the class. May be null.

      • TraceClassVisitor

        public TraceClassVisitor​(ClassVisitor classVisitor,
                         Printer printer,
                         java.io.PrintWriter printWriter)
        Constructs a new TraceClassVisitor.
        Parameters:
        classVisitor - the class visitor to which to delegate calls. May be null.
        printer - the printer to convert the visited class into text.
        printWriter - the print writer to be used to print the class. 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)
        Description copied from class: ClassVisitor
        Visits the header of the class.
        Overrides:
        visit in class ClassVisitor
        Parameters:
        version - the class version. The minor version is stored in the 16 most significant bits, and the major version in the 16 least significant bits.
        access - the class's access flags (see Opcodes). This parameter also indicates if the class is deprecated Opcodes.ACC_DEPRECATED or a record Opcodes.ACC_RECORD.
        name - the internal name of the class (see Type.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 Type.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 Type.getInternalName()). May be null.

      • visitSource

        public void visitSource​(java.lang.String file,
                        java.lang.String debug)
        Description copied from class: ClassVisitor
        Visits the source of the class.
        Overrides:
        visitSource in class 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 correspondence between source and compiled elements of the class. May be null.

      • visitModule

        public ModuleVisitor visitModule​(java.lang.String name,
                                 int flags,
                                 java.lang.String version)
        Description copied from class: ClassVisitor
        Visit the module corresponding to the class.
        Overrides:
        visitModule in class ClassVisitor
        Parameters:
        name - the fully qualified name (using dots) of the module.
        flags - the module access flags, among ACC_OPEN, ACC_SYNTHETIC and ACC_MANDATED.
        version - the module version, or null.
        Returns:
        a visitor to visit the module values, or null if this visitor is not interested in visiting this module.

      • visitNestHost

        public void visitNestHost​(java.lang.String nestHost)
        Description copied from class: ClassVisitor
        Visits the nest host class of the class. A nest is a set of classes of the same package that share access to their private members. One of these classes, called the host, lists the other members of the nest, which in turn should link to the host of their nest. This method must be called only once and only if the visited class is a non-host member of a nest. A class is implicitly its own nest, so it's invalid to call this method with the visited class name as argument.
        Overrides:
        visitNestHost in class ClassVisitor
        Parameters:
        nestHost - the internal name of the host class of the nest.

      • visitOuterClass

        public void visitOuterClass​(java.lang.String owner,
                            java.lang.String name,
                            java.lang.String descriptor)
        Description copied from class: ClassVisitor
        Visits the enclosing class of the class. This method must be called only if the class has an enclosing class.
        Overrides:
        visitOuterClass in class 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.
        descriptor - 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 descriptor,
                                         boolean visible)
        Description copied from class: ClassVisitor
        Visits an annotation of the class.
        Overrides:
        visitAnnotation in class ClassVisitor
        Parameters:
        descriptor - 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,
                                             java.lang.String descriptor,
                                             boolean visible)
        Description copied from class: ClassVisitor
        Visits an annotation on a type in the class signature.
        Overrides:
        visitTypeAnnotation in class ClassVisitor
        Parameters:
        typeRef - a reference to the annotated type. The sort of this type reference must be TypeReference.CLASS_TYPE_PARAMETER, TypeReference.CLASS_TYPE_PARAMETER_BOUND or TypeReference.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.
        descriptor - 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 attribute)
        Description copied from class: ClassVisitor
        Visits a non standard attribute of the class.
        Overrides:
        visitAttribute in class ClassVisitor
        Parameters:
        attribute - an attribute.

      • visitNestMember

        public void visitNestMember​(java.lang.String nestMember)
        Description copied from class: ClassVisitor
        Visits a member of the nest. A nest is a set of classes of the same package that share access to their private members. One of these classes, called the host, lists the other members of the nest, which in turn should link to the host of their nest. This method must be called only if the visited class is the host of a nest. A nest host is implicitly a member of its own nest, so it's invalid to call this method with the visited class name as argument.
        Overrides:
        visitNestMember in class ClassVisitor
        Parameters:
        nestMember - the internal name of a nest member.

      • visitPermittedSubclass

        public void visitPermittedSubclass​(java.lang.String permittedSubclass)
        Description copied from class: ClassVisitor
        Visits a permitted subclasses. A permitted subclass is one of the allowed subclasses of the current class.
        Overrides:
        visitPermittedSubclass in class ClassVisitor
        Parameters:
        permittedSubclass - the internal name of a permitted subclass.

      • visitInnerClass

        public void visitInnerClass​(java.lang.String name,
                            java.lang.String outerName,
                            java.lang.String innerName,
                            int access)
        Description copied from class: ClassVisitor
        Visits information about an inner class. This inner class is not necessarily a member of the class being visited.
        Overrides:
        visitInnerClass in class ClassVisitor
        Parameters:
        name - the internal name of an inner class (see Type.getInternalName()).
        outerName - the internal name of the class to which the inner class belongs (see Type.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.

      • visitRecordComponent

        public RecordComponentVisitor visitRecordComponent​(java.lang.String name,
                                                   java.lang.String descriptor,
                                                   java.lang.String signature)
        Description copied from class: ClassVisitor
        Visits a record component of the class.
        Overrides:
        visitRecordComponent in class ClassVisitor
        Parameters:
        name - the record component name.
        descriptor - the record component descriptor (see Type).
        signature - the record component signature. May be null if the record component type does not use generic types.
        Returns:
        a visitor to visit this record component annotations and attributes, or null if this class visitor is not interested in visiting these annotations and attributes.

      • visitField

        public FieldVisitor visitField​(int access,
                               java.lang.String name,
                               java.lang.String descriptor,
                               java.lang.String signature,
                               java.lang.Object value)
        Description copied from class: ClassVisitor
        Visits a field of the class.
        Overrides:
        visitField in class 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.
        descriptor - 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 descriptor,
                                 java.lang.String signature,
                                 java.lang.String[] exceptions)
        Description copied from class: 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.
        Overrides:
        visitMethod in class 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.
        descriptor - 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 Type.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: 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.
        Overrides:
        visitEnd in class ClassVisitor