Module org.eclipse.persistence.asm
Package org.eclipse.persistence.internal.libraries.asm.commons

Class MethodRemapper

java.lang.Object
org.eclipse.persistence.internal.libraries.asm.MethodVisitor
org.eclipse.persistence.internal.libraries.asm.commons.MethodRemapper
public class MethodRemapper extends MethodVisitor
A MethodVisitor that remaps types with a Remapper.

  • Field Details

    • remapper

      protected final Remapper remapper
      The remapper used to remap the types in the visited field.

  • Constructor Details

    • MethodRemapper

      public MethodRemapper(MethodVisitor methodVisitor, Remapper remapper)
      Constructs a new MethodRemapper. Subclasses must not use this constructor. Instead, they must use the MethodRemapper(int,MethodVisitor,Remapper) version.
      Parameters:
      methodVisitor - the method visitor this remapper must delegate to.
      remapper - the remapper to use to remap the types in the visited method.

    • MethodRemapper

      protected MethodRemapper(int api, MethodVisitor methodVisitor, Remapper remapper)
      Constructs a new MethodRemapper.
      Parameters:
      api - the ASM API version supported by this remapper. Must be one of the ASMx values in Opcodes.
      methodVisitor - the method visitor this remapper must delegate to.
      remapper - the remapper to use to remap the types in the visited method.

  • Method Details

    • 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, exactly one visit method must be called on this annotation visitor, followed by visitEnd.

    • visitAnnotation

      public AnnotationVisitor visitAnnotation(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.

    • visitTypeAnnotation

      public AnnotationVisitor visitTypeAnnotation(int typeRef, TypePath typePath, String descriptor, boolean visible)
      Description copied from class: MethodVisitor
      Visits an annotation on a type in the method signature.
      Overrides:
      visitTypeAnnotation in class MethodVisitor
      Parameters:
      typeRef - a reference to the annotated type. The sort of this type reference must be TypeReference.METHOD_TYPE_PARAMETER, TypeReference.METHOD_TYPE_PARAMETER_BOUND, TypeReference.METHOD_RETURN, TypeReference.METHOD_RECEIVER, TypeReference.METHOD_FORMAL_PARAMETER or TypeReference.THROWS. 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.

    • visitParameterAnnotation

      public AnnotationVisitor visitParameterAnnotation(int parameter, String descriptor, 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).
      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.

    • visitFrame

      public void visitFrame(int type, int numLocal, Object[] local, int numStack, 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. Long and double values count for one variable.
      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, see Type.getInternalName()), 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. Long and double values count for one stack element.
      stack - the operand stack types in this frame. This array must not be modified. Its content has the same format as the "local" array.

    • visitFieldInsn

      public void visitFieldInsn(int opcode, String owner, String name, 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 opcodeAndSource, String owner, String name, 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:
      opcodeAndSource - 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(String name, String descriptor, Handle bootstrapMethodHandle, 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.

    • visitTypeInsn

      public void visitTypeInsn(int opcode, 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 (see Type.getInternalName()).
      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()).

    • visitLdcInsn

      public void visitLdcInsn(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.

    • visitMultiANewArrayInsn

      public void visitMultiANewArrayInsn(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.

    • visitInsnAnnotation

      public AnnotationVisitor visitInsnAnnotation(int typeRef, TypePath typePath, String descriptor, boolean visible)
      Description copied from class: MethodVisitor
      Visits an annotation on an instruction. This method must be called just after the annotated instruction. It can be called several times for the same instruction.
      Overrides:
      visitInsnAnnotation in class MethodVisitor
      Parameters:
      typeRef - a reference to the annotated type. The sort of this type reference must be TypeReference.INSTANCEOF, TypeReference.NEW, TypeReference.CONSTRUCTOR_REFERENCE, TypeReference.METHOD_REFERENCE, TypeReference.CAST, TypeReference.CONSTRUCTOR_INVOCATION_TYPE_ARGUMENT, TypeReference.METHOD_INVOCATION_TYPE_ARGUMENT, TypeReference.CONSTRUCTOR_REFERENCE_TYPE_ARGUMENT, or TypeReference.METHOD_REFERENCE_TYPE_ARGUMENT. 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.

    • visitTryCatchBlock

      public void visitTryCatchBlock(Label start, Label end, Label handler, 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 (see Type.getInternalName()), or null to catch any exceptions (for "finally" blocks).

    • visitTryCatchAnnotation

      public AnnotationVisitor visitTryCatchAnnotation(int typeRef, TypePath typePath, String descriptor, boolean visible)
      Description copied from class: MethodVisitor
      Visits an annotation on an exception handler type. This method must be called after the MethodVisitor.visitTryCatchBlock(org.eclipse.persistence.internal.libraries.asm.Label, org.eclipse.persistence.internal.libraries.asm.Label, org.eclipse.persistence.internal.libraries.asm.Label, java.lang.String) for the annotated exception handler. It can be called several times for the same exception handler.
      Overrides:
      visitTryCatchAnnotation in class MethodVisitor
      Parameters:
      typeRef - a reference to the annotated type. The sort of this type reference must be TypeReference.EXCEPTION_PARAMETER. 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.

    • visitLocalVariable

      public void visitLocalVariable(String name, String descriptor, 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, 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.

    • createAnnotationRemapper

      @Deprecated protected AnnotationVisitor createAnnotationRemapper(AnnotationVisitor annotationVisitor)
      Deprecated.
      use createAnnotationRemapper(String, AnnotationVisitor) instead.
      Constructs a new remapper for annotations. The default implementation of this method returns a new AnnotationRemapper.
      Parameters:
      annotationVisitor - the AnnotationVisitor the remapper must delegate to.
      Returns:
      the newly created remapper.

    • createAnnotationRemapper

      protected AnnotationVisitor createAnnotationRemapper(String descriptor, AnnotationVisitor annotationVisitor)
      Constructs a new remapper for annotations. The default implementation of this method returns a new AnnotationRemapper.
      Parameters:
      descriptor - the descriptor of the visited annotation.
      annotationVisitor - the AnnotationVisitor the remapper must delegate to.
      Returns:
      the newly created remapper.