Package org.objectweb.asm

Class MethodWriter

  • final class MethodWriter
extends MethodVisitor
    A MethodVisitor that generates a corresponding 'method_info' structure, as defined in the Java Virtual Machine Specification (JVMS).
    See Also:
    JVMS 4.6

    • Field Detail

      • COMPUTE_NOTHING

        static final int COMPUTE_NOTHING
        Indicates that nothing must be computed.
        See Also:
        Constant Field Values

      • COMPUTE_MAX_STACK_AND_LOCAL

        static final int COMPUTE_MAX_STACK_AND_LOCAL
        Indicates that the maximum stack size and the maximum number of local variables must be computed, from scratch.
        See Also:
        Constant Field Values

      • COMPUTE_MAX_STACK_AND_LOCAL_FROM_FRAMES

        static final int COMPUTE_MAX_STACK_AND_LOCAL_FROM_FRAMES
        Indicates that the maximum stack size and the maximum number of local variables must be computed, from the existing stack map frames. This can be done more efficiently than with the control flow graph algorithm used for COMPUTE_MAX_STACK_AND_LOCAL, by using a linear scan of the bytecode instructions.
        See Also:
        Constant Field Values

      • COMPUTE_INSERTED_FRAMES

        static final int COMPUTE_INSERTED_FRAMES
        Indicates that the stack map frames of type F_INSERT must be computed. The other frames are not computed. They should all be of type F_NEW and should be sufficient to compute the content of the F_INSERT frames, together with the bytecode instructions between a F_NEW and a F_INSERT frame - and without any knowledge of the type hierarchy (by definition of F_INSERT).
        See Also:
        Constant Field Values

      • COMPUTE_ALL_FRAMES

        static final int COMPUTE_ALL_FRAMES
        Indicates that all the stack map frames must be computed. In this case the maximum stack size and the maximum number of local variables is also computed.
        See Also:
        Constant Field Values

      • STACK_SIZE_DELTA

        private static final int[] STACK_SIZE_DELTA
        The stack size variation corresponding to each JVM opcode. The stack size variation for opcode 'o' is given by the array element at index 'o'.
        See Also:
        JVMS 6

      • symbolTable

        private final SymbolTable symbolTable
        Where the constants used in this MethodWriter must be stored.

      • accessFlags

        private final int accessFlags
        The access_flags field of the method_info JVMS structure. This field can contain ASM specific access flags, such as Opcodes.ACC_DEPRECATED, which are removed when generating the ClassFile structure.

      • nameIndex

        private final int nameIndex
        The name_index field of the method_info JVMS structure.

      • name

        private final java.lang.String name
        The name of this method.

      • descriptorIndex

        private final int descriptorIndex
        The descriptor_index field of the method_info JVMS structure.

      • descriptor

        private final java.lang.String descriptor
        The descriptor of this method.

      • maxStack

        private int maxStack
        The max_stack field of the Code attribute.

      • maxLocals

        private int maxLocals
        The max_locals field of the Code attribute.

      • code

        private final ByteVector code
        The 'code' field of the Code attribute.

      • firstHandler

        private Handler firstHandler
        The first element in the exception handler list (used to generate the exception_table of the Code attribute). The next ones can be accessed with the Handler.nextHandler field. May be null.

      • lastHandler

        private Handler lastHandler
        The last element in the exception handler list (used to generate the exception_table of the Code attribute). The next ones can be accessed with the Handler.nextHandler field. May be null.

      • lineNumberTableLength

        private int lineNumberTableLength
        The line_number_table_length field of the LineNumberTable code attribute.

      • lineNumberTable

        private ByteVector lineNumberTable
        The line_number_table array of the LineNumberTable code attribute, or null.

      • localVariableTableLength

        private int localVariableTableLength
        The local_variable_table_length field of the LocalVariableTable code attribute.

      • localVariableTable

        private ByteVector localVariableTable
        The local_variable_table array of the LocalVariableTable code attribute, or null.

      • localVariableTypeTableLength

        private int localVariableTypeTableLength
        The local_variable_type_table_length field of the LocalVariableTypeTable code attribute.

      • localVariableTypeTable

        private ByteVector localVariableTypeTable
        The local_variable_type_table array of the LocalVariableTypeTable code attribute, or null.

      • stackMapTableNumberOfEntries

        private int stackMapTableNumberOfEntries
        The number_of_entries field of the StackMapTable code attribute.

      • stackMapTableEntries

        private ByteVector stackMapTableEntries
        The 'entries' array of the StackMapTable code attribute.

      • lastCodeRuntimeVisibleTypeAnnotation

        private AnnotationWriter lastCodeRuntimeVisibleTypeAnnotation
        The last runtime visible type annotation of the Code attribute. The previous ones can be accessed with the AnnotationWriter.previousAnnotation field. May be null.

      • lastCodeRuntimeInvisibleTypeAnnotation

        private AnnotationWriter lastCodeRuntimeInvisibleTypeAnnotation
        The last runtime invisible type annotation of the Code attribute. The previous ones can be accessed with the AnnotationWriter.previousAnnotation field. May be null.

      • numberOfExceptions

        private final int numberOfExceptions
        The number_of_exceptions field of the Exceptions attribute.

      • exceptionIndexTable

        private final int[] exceptionIndexTable
        The exception_index_table array of the Exceptions attribute, or null.

      • signatureIndex

        private final int signatureIndex
        The signature_index field of the Signature attribute.

      • visibleAnnotableParameterCount

        private int visibleAnnotableParameterCount
        The number of method parameters that can have runtime visible annotations, or 0.

      • lastRuntimeVisibleParameterAnnotations

        private AnnotationWriter[] lastRuntimeVisibleParameterAnnotations
        The runtime visible parameter annotations of this method. Each array element contains the last annotation of a parameter (which can be null - the previous ones can be accessed with the AnnotationWriter.previousAnnotation field). May be null.

      • invisibleAnnotableParameterCount

        private int invisibleAnnotableParameterCount
        The number of method parameters that can have runtime visible annotations, or 0.

      • lastRuntimeInvisibleParameterAnnotations

        private AnnotationWriter[] lastRuntimeInvisibleParameterAnnotations
        The runtime invisible parameter annotations of this method. Each array element contains the last annotation of a parameter (which can be null - the previous ones can be accessed with the AnnotationWriter.previousAnnotation field). May be null.

      • lastRuntimeInvisibleTypeAnnotation

        private AnnotationWriter lastRuntimeInvisibleTypeAnnotation
        The last runtime invisible type annotation of this method. The previous ones can be accessed with the AnnotationWriter.previousAnnotation field. May be null.

      • defaultValue

        private ByteVector defaultValue
        The default_value field of the AnnotationDefault attribute, or null.

      • parametersCount

        private int parametersCount
        The parameters_count field of the MethodParameters attribute.

      • parameters

        private ByteVector parameters
        The 'parameters' array of the MethodParameters attribute, or null.

      • firstBasicBlock

        private Label firstBasicBlock
        The first basic block of the method. The next ones (in bytecode offset order) can be accessed with the Label.nextBasicBlock field.

      • lastBasicBlock

        private Label lastBasicBlock
        The last basic block of the method (in bytecode offset order). This field is updated each time a basic block is encountered, and is used to append it at the end of the basic block list.

      • currentLocals

        private int currentLocals
        The number of local variables in the last visited stack map frame.

      • previousFrameOffset

        private int previousFrameOffset
        The bytecode offset of the last frame that was written in stackMapTableEntries.

      • currentFrame

        private int[] currentFrame
        The current stack map frame. The first element contains the bytecode offset of the instruction to which the frame corresponds, the second element is the number of locals and the third one is the number of stack elements. The local variables start at index 3 and are followed by the operand stack elements. In summary frame[0] = offset, frame[1] = numLocal, frame[2] = numStack. Local variables and operand stack entries contain abstract types, as defined in Frame, but restricted to Frame.CONSTANT_KIND, Frame.REFERENCE_KIND or Frame.UNINITIALIZED_KIND abstract types. Long and double types use only one array entry.

      • hasSubroutines

        private boolean hasSubroutines
        Whether this method contains subroutines.

      • hasAsmInstructions

        private boolean hasAsmInstructions
        Whether the bytecode of this method contains ASM specific instructions.

      • lastBytecodeOffset

        private int lastBytecodeOffset
        The start offset of the last visited instruction. Used to set the offset field of type annotations of type 'offset_target' (see JVMS 4.7.20.1).

      • sourceOffset

        private int sourceOffset
        The offset in bytes in SymbolTable.getSource() from which the method_info for this method (excluding its first 6 bytes) must be copied, or 0.

      • sourceLength

        private int sourceLength
        The length in bytes in SymbolTable.getSource() which must be copied to get the method_info for this method (excluding its first 6 bytes for access_flags, name_index and descriptor_index).

    • Constructor Detail

      • MethodWriter

        MethodWriter​(SymbolTable symbolTable,
             int access,
             java.lang.String name,
             java.lang.String descriptor,
             java.lang.String signature,
             java.lang.String[] exceptions,
             int compute)
        Constructs a new MethodWriter.
        Parameters:
        symbolTable - where the constants used in this AnnotationWriter must be stored.
        access - the method's access flags (see Opcodes).
        name - the method's name.
        descriptor - the method's descriptor (see Type).
        signature - the method's signature. May be null.
        exceptions - the internal names of the method's exceptions. May be null.
        compute - indicates what must be computed (see #compute).

    • Method Detail

      • hasFrames

        boolean hasFrames()

      • hasAsmInstructions

        boolean hasAsmInstructions()

      • visitParameter

        public void visitParameter​(java.lang.String name,
                           int access)
        Description copied from class: MethodVisitor
        Visits a parameter of this method.
        Overrides:
        visitParameter in class MethodVisitor
        Parameters:
        name - parameter name or null if none is provided.
        access - the parameter's access flags, only ACC_FINAL, ACC_SYNTHETIC or/and ACC_MANDATED are allowed (see Opcodes).

      • visitAnnotationDefault

        public AnnotationVisitor visitAnnotationDefault()
        Description copied from class: MethodVisitor
        Visits the default value of this annotation interface method.
        Overrides:
        visitAnnotationDefault in class MethodVisitor
        Returns:
        a visitor to the visit the actual default value of this annotation interface method, or null if this visitor is not interested in visiting this default value. The 'name' parameters passed to the methods of this annotation visitor are ignored. Moreover, exacly one visit method must be called on this annotation visitor, followed by visitEnd.

      • visitAnnotation

        public AnnotationVisitor visitAnnotation​(java.lang.String descriptor,
                                         boolean visible)
        Description copied from class: MethodVisitor
        Visits an annotation of this method.
        Overrides:
        visitAnnotation in class MethodVisitor
        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.

      • visitAnnotableParameterCount

        public void visitAnnotableParameterCount​(int parameterCount,
                                         boolean visible)
        Description copied from class: MethodVisitor
        Visits the number of method parameters that can have annotations. By default (i.e. when this method is not called), all the method parameters defined by the method descriptor can have annotations.
        Overrides:
        visitAnnotableParameterCount in class MethodVisitor
        Parameters:
        parameterCount - the number of method parameters than can have annotations. This number must be less or equal than the number of parameter types in the method descriptor. It can be strictly less when a method has synthetic parameters and when these parameters are ignored when computing parameter indices for the purpose of parameter annotations (see https://docs.oracle.com/javase/specs/jvms/se9/html/jvms-4.html#jvms-4.7.18).
        visible - true to define the number of method parameters that can have annotations visible at runtime, false to define the number of method parameters that can have annotations invisible at runtime.

      • visitParameterAnnotation

        public AnnotationVisitor visitParameterAnnotation​(int parameter,
                                                  java.lang.String annotationDescriptor,
                                                  boolean visible)
        Description copied from class: MethodVisitor
        Visits an annotation of a parameter this method.
        Overrides:
        visitParameterAnnotation in class MethodVisitor
        Parameters:
        parameter - the parameter index. This index must be strictly smaller than the number of parameters in the method descriptor, and strictly smaller than the parameter count specified in MethodVisitor.visitAnnotableParameterCount(int, boolean). Important note: a parameter index i is not required to correspond to the i'th parameter descriptor in the method descriptor, in particular in case of synthetic parameters (see https://docs.oracle.com/javase/specs/jvms/se9/html/jvms-4.html#jvms-4.7.18).
        annotationDescriptor - 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: MethodVisitor
        Visits a non standard attribute of this method.
        Overrides:
        visitAttribute in class MethodVisitor
        Parameters:
        attribute - an attribute.

      • visitCode

        public void visitCode()
        Description copied from class: MethodVisitor
        Starts the visit of the method's code, if any (i.e. non abstract method).
        Overrides:
        visitCode in class MethodVisitor

      • visitFrame

        public void visitFrame​(int type,
                       int numLocal,
                       java.lang.Object[] local,
                       int numStack,
                       java.lang.Object[] stack)
        Description copied from class: MethodVisitor
        Visits the current state of the local variables and operand stack elements. This method must(*) be called just before any instruction i that follows an unconditional branch instruction such as GOTO or THROW, that is the target of a jump instruction, or that starts an exception handler block. The visited types must describe the values of the local variables and of the operand stack elements just before i is executed.

        (*) this is mandatory only for classes whose version is greater than or equal to Opcodes.V1_6.

        The frames of a method must be given either in expanded form, or in compressed form (all frames must use the same format, i.e. you must not mix expanded and compressed frames within a single method):
        • In expanded form, all frames must have the F_NEW type.
        • In compressed form, frames are basically "deltas" from the state of the previous frame:
          • Opcodes.F_SAME representing frame with exactly the same locals as the previous frame and with the empty stack.
          • Opcodes.F_SAME1 representing frame with exactly the same locals as the previous frame and with single value on the stack ( numStack is 1 and stack[0] contains value for the type of the stack item).
          • Opcodes.F_APPEND representing frame with current locals are the same as the locals in the previous frame, except that additional locals are defined ( numLocal is 1, 2 or 3 and local elements contains values representing added types).
          • Opcodes.F_CHOP representing frame with current locals are the same as the locals in the previous frame, except that the last 1-3 locals are absent and with the empty stack (numLocal is 1, 2 or 3).
          • Opcodes.F_FULL representing complete frame data.

        In both cases the first frame, corresponding to the method's parameters and access flags, is implicit and must not be visited. Also, it is illegal to visit two or more frames for the same code location (i.e., at least one instruction must be visited between two calls to visitFrame).
        Overrides:
        visitFrame in class MethodVisitor
        Parameters:
        type - the type of this stack map frame. Must be Opcodes.F_NEW for expanded frames, or Opcodes.F_FULL, Opcodes.F_APPEND, Opcodes.F_CHOP, Opcodes.F_SAME or Opcodes.F_APPEND, Opcodes.F_SAME1 for compressed frames.
        numLocal - the number of local variables in the visited frame.
        local - the local variable types in this frame. This array must not be modified. Primitive types are represented by Opcodes.TOP, Opcodes.INTEGER, Opcodes.FLOAT, Opcodes.LONG, Opcodes.DOUBLE, Opcodes.NULL or Opcodes.UNINITIALIZED_THIS (long and double are represented by a single element). Reference types are represented by String objects (representing internal names), and uninitialized types by Label objects (this label designates the NEW instruction that created this uninitialized value).
        numStack - the number of operand stack elements in the visited frame.
        stack - the operand stack types in this frame. This array must not be modified. Its content has the same format as the "local" array.

      • visitInsn

        public void visitInsn​(int opcode)
        Description copied from class: MethodVisitor
        Visits a zero operand instruction.
        Overrides:
        visitInsn in class MethodVisitor
        Parameters:
        opcode - the opcode of the instruction to be visited. This opcode is either NOP, ACONST_NULL, ICONST_M1, ICONST_0, ICONST_1, ICONST_2, ICONST_3, ICONST_4, ICONST_5, LCONST_0, LCONST_1, FCONST_0, FCONST_1, FCONST_2, DCONST_0, DCONST_1, IALOAD, LALOAD, FALOAD, DALOAD, AALOAD, BALOAD, CALOAD, SALOAD, IASTORE, LASTORE, FASTORE, DASTORE, AASTORE, BASTORE, CASTORE, SASTORE, POP, POP2, DUP, DUP_X1, DUP_X2, DUP2, DUP2_X1, DUP2_X2, SWAP, IADD, LADD, FADD, DADD, ISUB, LSUB, FSUB, DSUB, IMUL, LMUL, FMUL, DMUL, IDIV, LDIV, FDIV, DDIV, IREM, LREM, FREM, DREM, INEG, LNEG, FNEG, DNEG, ISHL, LSHL, ISHR, LSHR, IUSHR, LUSHR, IAND, LAND, IOR, LOR, IXOR, LXOR, I2L, I2F, I2D, L2I, L2F, L2D, F2I, F2L, F2D, D2I, D2L, D2F, I2B, I2C, I2S, LCMP, FCMPL, FCMPG, DCMPL, DCMPG, IRETURN, LRETURN, FRETURN, DRETURN, ARETURN, RETURN, ARRAYLENGTH, ATHROW, MONITORENTER, or MONITOREXIT.

      • visitVarInsn

        public void visitVarInsn​(int opcode,
                         int var)
        Description copied from class: MethodVisitor
        Visits a local variable instruction. A local variable instruction is an instruction that loads or stores the value of a local variable.
        Overrides:
        visitVarInsn in class MethodVisitor
        Parameters:
        opcode - the opcode of the local variable instruction to be visited. This opcode is either ILOAD, LLOAD, FLOAD, DLOAD, ALOAD, ISTORE, LSTORE, FSTORE, DSTORE, ASTORE or RET.
        var - the operand of the instruction to be visited. This operand is the index of a local variable.

      • visitTypeInsn

        public void visitTypeInsn​(int opcode,
                          java.lang.String type)
        Description copied from class: MethodVisitor
        Visits a type instruction. A type instruction is an instruction that takes the internal name of a class as parameter.
        Overrides:
        visitTypeInsn in class MethodVisitor
        Parameters:
        opcode - the opcode of the type instruction to be visited. This opcode is either NEW, ANEWARRAY, CHECKCAST or INSTANCEOF.
        type - the operand of the instruction to be visited. This operand must be the internal name of an object or array class (see Type.getInternalName()).

      • visitFieldInsn

        public void visitFieldInsn​(int opcode,
                           java.lang.String owner,
                           java.lang.String name,
                           java.lang.String descriptor)
        Description copied from class: MethodVisitor
        Visits a field instruction. A field instruction is an instruction that loads or stores the value of a field of an object.
        Overrides:
        visitFieldInsn in class MethodVisitor
        Parameters:
        opcode - the opcode of the type instruction to be visited. This opcode is either GETSTATIC, PUTSTATIC, GETFIELD or PUTFIELD.
        owner - the internal name of the field's owner class (see Type.getInternalName()).
        name - the field's name.
        descriptor - the field's descriptor (see Type).

      • visitMethodInsn

        public void visitMethodInsn​(int opcode,
                            java.lang.String owner,
                            java.lang.String name,
                            java.lang.String descriptor,
                            boolean isInterface)
        Description copied from class: MethodVisitor
        Visits a method instruction. A method instruction is an instruction that invokes a method.
        Overrides:
        visitMethodInsn in class MethodVisitor
        Parameters:
        opcode - the opcode of the type instruction to be visited. This opcode is either INVOKEVIRTUAL, INVOKESPECIAL, INVOKESTATIC or INVOKEINTERFACE.
        owner - the internal name of the method's owner class (see Type.getInternalName()).
        name - the method's name.
        descriptor - the method's descriptor (see Type).
        isInterface - if the method's owner class is an interface.

      • visitInvokeDynamicInsn

        public void visitInvokeDynamicInsn​(java.lang.String name,
                                   java.lang.String descriptor,
                                   Handle bootstrapMethodHandle,
                                   java.lang.Object... bootstrapMethodArguments)
        Description copied from class: MethodVisitor
        Visits an invokedynamic instruction.
        Overrides:
        visitInvokeDynamicInsn in class MethodVisitor
        Parameters:
        name - the method's name.
        descriptor - the method's descriptor (see Type).
        bootstrapMethodHandle - the bootstrap method.
        bootstrapMethodArguments - the bootstrap method constant arguments. Each argument must be an Integer, Float, Long, Double, String, Type, Handle or ConstantDynamic value. This method is allowed to modify the content of the array so a caller should expect that this array may change.

      • visitJumpInsn

        public void visitJumpInsn​(int opcode,
                          Label label)
        Description copied from class: MethodVisitor
        Visits a jump instruction. A jump instruction is an instruction that may jump to another instruction.
        Overrides:
        visitJumpInsn in class MethodVisitor
        Parameters:
        opcode - the opcode of the type instruction to be visited. This opcode is either IFEQ, IFNE, IFLT, IFGE, IFGT, IFLE, IF_ICMPEQ, IF_ICMPNE, IF_ICMPLT, IF_ICMPGE, IF_ICMPGT, IF_ICMPLE, IF_ACMPEQ, IF_ACMPNE, GOTO, JSR, IFNULL or IFNONNULL.
        label - the operand of the instruction to be visited. This operand is a label that designates the instruction to which the jump instruction may jump.

      • visitLabel

        public void visitLabel​(Label label)
        Description copied from class: MethodVisitor
        Visits a label. A label designates the instruction that will be visited just after it.
        Overrides:
        visitLabel in class MethodVisitor
        Parameters:
        label - a Label object.

      • visitLdcInsn

        public void visitLdcInsn​(java.lang.Object value)
        Description copied from class: MethodVisitor
        Visits a LDC instruction. Note that new constant types may be added in future versions of the Java Virtual Machine. To easily detect new constant types, implementations of this method should check for unexpected constant types, like this: 
         if (cst instanceof Integer) {
     // ...
 } else if (cst instanceof Float) {
     // ...
 } else if (cst instanceof Long) {
     // ...
 } else if (cst instanceof Double) {
     // ...
 } else if (cst instanceof String) {
     // ...
 } else if (cst instanceof Type) {
     int sort = ((Type) cst).getSort();
     if (sort == Type.OBJECT) {
         // ...
     } else if (sort == Type.ARRAY) {
         // ...
     } else if (sort == Type.METHOD) {
         // ...
     } else {
         // throw an exception
     }
 } else if (cst instanceof Handle) {
     // ...
 } else if (cst instanceof ConstantDynamic) {
     // ...
 } else {
     // throw an exception
 }
        Overrides:
        visitLdcInsn in class MethodVisitor
        Parameters:
        value - the constant to be loaded on the stack. This parameter must be a non null Integer, a Float, a Long, a Double, a String, a Type of OBJECT or ARRAY sort for .class constants, for classes whose version is 49, a Type of METHOD sort for MethodType, a Handle for MethodHandle constants, for classes whose version is 51 or a ConstantDynamic for a constant dynamic for classes whose version is 55.

      • visitIincInsn

        public void visitIincInsn​(int var,
                          int increment)
        Description copied from class: MethodVisitor
        Visits an IINC instruction.
        Overrides:
        visitIincInsn in class MethodVisitor
        Parameters:
        var - index of the local variable to be incremented.
        increment - amount to increment the local variable by.

      • visitTableSwitchInsn

        public void visitTableSwitchInsn​(int min,
                                 int max,
                                 Label dflt,
                                 Label... labels)
        Description copied from class: MethodVisitor
        Visits a TABLESWITCH instruction.
        Overrides:
        visitTableSwitchInsn in class MethodVisitor
        Parameters:
        min - the minimum key value.
        max - the maximum key value.
        dflt - beginning of the default handler block.
        labels - beginnings of the handler blocks. labels[i] is the beginning of the handler block for the min + i key.

      • visitLookupSwitchInsn

        public void visitLookupSwitchInsn​(Label dflt,
                                  int[] keys,
                                  Label[] labels)
        Description copied from class: MethodVisitor
        Visits a LOOKUPSWITCH instruction.
        Overrides:
        visitLookupSwitchInsn in class MethodVisitor
        Parameters:
        dflt - beginning of the default handler block.
        keys - the values of the keys.
        labels - beginnings of the handler blocks. labels[i] is the beginning of the handler block for the keys[i] key.

      • visitSwitchInsn

        private void visitSwitchInsn​(Label dflt,
                             Label[] labels)

      • visitMultiANewArrayInsn

        public void visitMultiANewArrayInsn​(java.lang.String descriptor,
                                    int numDimensions)
        Description copied from class: MethodVisitor
        Visits a MULTIANEWARRAY instruction.
        Overrides:
        visitMultiANewArrayInsn in class MethodVisitor
        Parameters:
        descriptor - an array type descriptor (see Type).
        numDimensions - the number of dimensions of the array to allocate.

      • visitTryCatchBlock

        public void visitTryCatchBlock​(Label start,
                               Label end,
                               Label handler,
                               java.lang.String type)
        Description copied from class: MethodVisitor
        Visits a try catch block.
        Overrides:
        visitTryCatchBlock in class MethodVisitor
        Parameters:
        start - the beginning of the exception handler's scope (inclusive).
        end - the end of the exception handler's scope (exclusive).
        handler - the beginning of the exception handler's code.
        type - the internal name of the type of exceptions handled by the handler, or null to catch any exceptions (for "finally" blocks).

      • visitLocalVariable

        public void visitLocalVariable​(java.lang.String name,
                               java.lang.String descriptor,
                               java.lang.String signature,
                               Label start,
                               Label end,
                               int index)
        Description copied from class: MethodVisitor
        Visits a local variable declaration.
        Overrides:
        visitLocalVariable in class MethodVisitor
        Parameters:
        name - the name of a local variable.
        descriptor - the type descriptor of this local variable.
        signature - the type signature of this local variable. May be null if the local variable type does not use generic types.
        start - the first instruction corresponding to the scope of this local variable (inclusive).
        end - the last instruction corresponding to the scope of this local variable (exclusive).
        index - the local variable's index.

      • visitLocalVariableAnnotation

        public AnnotationVisitor visitLocalVariableAnnotation​(int typeRef,
                                                      TypePath typePath,
                                                      Label[] start,
                                                      Label[] end,
                                                      int[] index,
                                                      java.lang.String descriptor,
                                                      boolean visible)
        Description copied from class: MethodVisitor
        Visits an annotation on a local variable type.
        Overrides:
        visitLocalVariableAnnotation in class MethodVisitor
        Parameters:
        typeRef - a reference to the annotated type. The sort of this type reference must be TypeReference.LOCAL_VARIABLE or TypeReference.RESOURCE_VARIABLE. 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.
        start - the fist instructions corresponding to the continuous ranges that make the scope of this local variable (inclusive).
        end - the last instructions corresponding to the continuous ranges that make the scope of this local variable (exclusive). This array must have the same size as the 'start' array.
        index - the local variable's index in each range. This array must have the same size as the 'start' array.
        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.

      • visitLineNumber

        public void visitLineNumber​(int line,
                            Label start)
        Description copied from class: MethodVisitor
        Visits a line number declaration.
        Overrides:
        visitLineNumber in class MethodVisitor
        Parameters:
        line - a line number. This number refers to the source file from which the class was compiled.
        start - the first instruction corresponding to this line number.

      • visitMaxs

        public void visitMaxs​(int maxStack,
                      int maxLocals)
        Description copied from class: MethodVisitor
        Visits the maximum stack size and the maximum number of local variables of the method.
        Overrides:
        visitMaxs in class MethodVisitor
        Parameters:
        maxStack - maximum stack size of the method.
        maxLocals - maximum number of local variables for the method.

      • computeAllFrames

        private void computeAllFrames()
        Computes all the stack map frames of the method, from scratch.

      • computeMaxStackAndLocal

        private void computeMaxStackAndLocal()
        Computes the maximum stack size of the method.

      • visitEnd

        public void visitEnd()
        Description copied from class: MethodVisitor
        Visits the end of the method. This method, which is the last one to be called, is used to inform the visitor that all the annotations and attributes of the method have been visited.
        Overrides:
        visitEnd in class MethodVisitor

      • addSuccessorToCurrentBasicBlock

        private void addSuccessorToCurrentBasicBlock​(int info,
                                             Label successor)
        Adds a successor to currentBasicBlock in the control flow graph.
        Parameters:
        info - information about the control flow edge to be added.
        successor - the successor block to be added to the current basic block.

      • endCurrentBasicBlockWithNoSuccessor

        private void endCurrentBasicBlockWithNoSuccessor()
        Ends the current basic block. This method must be used in the case where the current basic block does not have any successor.

        WARNING: this method must be called after the currently visited instruction has been put in code (if frames are computed, this method inserts a new Label to start a new basic block after the current instruction).

      • visitFrameStart

        int visitFrameStart​(int offset,
                    int numLocal,
                    int numStack)
        Starts the visit of a new stack map frame, stored in currentFrame.
        Parameters:
        offset - the bytecode offset of the instruction to which the frame corresponds.
        numLocal - the number of local variables in the frame.
        numStack - the number of stack elements in the frame.
        Returns:
        the index of the next element to be written in this frame.

      • visitAbstractType

        void visitAbstractType​(int frameIndex,
                       int abstractType)
        Sets an abstract type in currentFrame.
        Parameters:
        frameIndex - the index of the element to be set in currentFrame.
        abstractType - an abstract type.

      • visitFrameEnd

        void visitFrameEnd()
        Ends the visit of currentFrame by writing it in the StackMapTable entries and by updating the StackMapTable number_of_entries (except if the current frame is the first one, which is implicit in StackMapTable). Then resets currentFrame to null.

      • putFrame

        private void putFrame()
        Compresses and writes currentFrame in a new StackMapTable entry.

      • putAbstractTypes

        private void putAbstractTypes​(int start,
                              int end)
        Puts some abstract types of currentFrame in stackMapTableEntries , using the JVMS verification_type_info format used in StackMapTable attributes.
        Parameters:
        start - index of the first type in currentFrame to write.
        end - index of last type in currentFrame to write (exclusive).

      • canCopyMethodAttributes

        boolean canCopyMethodAttributes​(ClassReader source,
                                boolean hasSyntheticAttribute,
                                boolean hasDeprecatedAttribute,
                                int descriptorIndex,
                                int signatureIndex,
                                int exceptionsOffset)
        Returns whether the attributes of this method can be copied from the attributes of the given method (assuming there is no method visitor between the given ClassReader and this MethodWriter). This method should only be called just after this MethodWriter has been created, and before any content is visited. It returns true if the attributes corresponding to the constructor arguments (at most a Signature, an Exception, a Deprecated and a Synthetic attribute) are the same as the corresponding attributes in the given method.
        Parameters:
        source - the source ClassReader from which the attributes of this method might be copied.
        hasSyntheticAttribute - whether the method_info JVMS structure from which the attributes of this method might be copied contains a Synthetic attribute.
        hasDeprecatedAttribute - whether the method_info JVMS structure from which the attributes of this method might be copied contains a Deprecated attribute.
        descriptorIndex - the descriptor_index field of the method_info JVMS structure from which the attributes of this method might be copied.
        signatureIndex - the constant pool index contained in the Signature attribute of the method_info JVMS structure from which the attributes of this method might be copied, or 0.
        exceptionsOffset - the offset in 'source.b' of the Exceptions attribute of the method_info JVMS structure from which the attributes of this method might be copied, or 0.
        Returns:
        whether the attributes of this method can be copied from the attributes of the method_info JVMS structure in 'source.b', between 'methodInfoOffset' and 'methodInfoOffset' + 'methodInfoLength'.

      • setMethodAttributesSource

        void setMethodAttributesSource​(int methodInfoOffset,
                               int methodInfoLength)
        Sets the source from which the attributes of this method will be copied.
        Parameters:
        methodInfoOffset - the offset in 'symbolTable.getSource()' of the method_info JVMS structure from which the attributes of this method will be copied.
        methodInfoLength - the length in 'symbolTable.getSource()' of the method_info JVMS structure from which the attributes of this method will be copied.

      • computeMethodInfoSize

        int computeMethodInfoSize()
        Returns the size of the method_info JVMS structure generated by this MethodWriter. Also add the names of the attributes of this method in the constant pool.
        Returns:
        the size in bytes of the method_info JVMS structure.

      • putMethodInfo

        void putMethodInfo​(ByteVector output)
        Puts the content of the method_info JVMS structure generated by this MethodWriter into the given ByteVector.
        Parameters:
        output - where the method_info structure must be put.

      • collectAttributePrototypes

        final void collectAttributePrototypes​(Attribute.Set attributePrototypes)
        Collects the attributes of this method into the given set of attribute prototypes.
        Parameters:
        attributePrototypes - a set of attribute prototypes.