Module org.eclipse.persistence.asm
Class MethodRemapper
java.lang.Object
org.eclipse.persistence.internal.libraries.asm.MethodVisitor
org.eclipse.persistence.internal.libraries.asm.commons.MethodRemapper
A
MethodVisitor
that remaps types with a Remapper
.-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected final Remapper
The remapper used to remap the types in the visited field.Fields inherited from class org.eclipse.persistence.internal.libraries.asm.MethodVisitor
api, mv
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
MethodRemapper
(int api, MethodVisitor methodVisitor, Remapper remapper) Constructs a newMethodRemapper
.MethodRemapper
(MethodVisitor methodVisitor, Remapper remapper) Constructs a newMethodRemapper
. -
Method Summary
Modifier and TypeMethodDescriptionprotected AnnotationVisitor
createAnnotationRemapper
(String descriptor, AnnotationVisitor annotationVisitor) Constructs a new remapper for annotations.protected AnnotationVisitor
createAnnotationRemapper
(AnnotationVisitor annotationVisitor) Deprecated.visitAnnotation
(String descriptor, boolean visible) Visits an annotation of this method.Visits the default value of this annotation interface method.void
visitFieldInsn
(int opcode, String owner, String name, String descriptor) Visits a field instruction.void
visitFrame
(int type, int numLocal, Object[] local, int numStack, Object[] stack) Visits the current state of the local variables and operand stack elements.visitInsnAnnotation
(int typeRef, TypePath typePath, String descriptor, boolean visible) Visits an annotation on an instruction.void
visitInvokeDynamicInsn
(String name, String descriptor, Handle bootstrapMethodHandle, Object... bootstrapMethodArguments) Visits an invokedynamic instruction.void
visitLdcInsn
(Object value) Visits a LDC instruction.void
visitLocalVariable
(String name, String descriptor, String signature, Label start, Label end, int index) Visits a local variable declaration.visitLocalVariableAnnotation
(int typeRef, TypePath typePath, Label[] start, Label[] end, int[] index, String descriptor, boolean visible) Visits an annotation on a local variable type.void
visitMethodInsn
(int opcodeAndSource, String owner, String name, String descriptor, boolean isInterface) Visits a method instruction.void
visitMultiANewArrayInsn
(String descriptor, int numDimensions) Visits a MULTIANEWARRAY instruction.visitParameterAnnotation
(int parameter, String descriptor, boolean visible) Visits an annotation of a parameter this method.visitTryCatchAnnotation
(int typeRef, TypePath typePath, String descriptor, boolean visible) Visits an annotation on an exception handler type.void
visitTryCatchBlock
(Label start, Label end, Label handler, String type) Visits a try catch block.visitTypeAnnotation
(int typeRef, TypePath typePath, String descriptor, boolean visible) Visits an annotation on a type in the method signature.void
visitTypeInsn
(int opcode, String type) Visits a type instruction.Methods inherited from class org.eclipse.persistence.internal.libraries.asm.MethodVisitor
getDelegate, visitAnnotableParameterCount, visitAttribute, visitCode, visitEnd, visitIincInsn, visitInsn, visitIntInsn, visitJumpInsn, visitLabel, visitLineNumber, visitLookupSwitchInsn, visitMaxs, visitMethodInsn, visitParameter, visitTableSwitchInsn, visitVarInsn
-
Field Details
-
remapper
The remapper used to remap the types in the visited field.
-
-
Constructor Details
-
MethodRemapper
Constructs a newMethodRemapper
. Subclasses must not use this constructor. Instead, they must use theMethodRemapper(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
Constructs a newMethodRemapper
.- Parameters:
api
- the ASM API version supported by this remapper. Must be one of theASM
x values inOpcodes
.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
Description copied from class:MethodVisitor
Visits the default value of this annotation interface method.- Overrides:
visitAnnotationDefault
in classMethodVisitor
- 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
Description copied from class:MethodVisitor
Visits an annotation of this method.- Overrides:
visitAnnotation
in classMethodVisitor
- 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 classMethodVisitor
- Parameters:
typeRef
- a reference to the annotated type. The sort of this type reference must beTypeReference.METHOD_TYPE_PARAMETER
,TypeReference.METHOD_TYPE_PARAMETER_BOUND
,TypeReference.METHOD_RETURN
,TypeReference.METHOD_RECEIVER
,TypeReference.METHOD_FORMAL_PARAMETER
orTypeReference.THROWS
. SeeTypeReference
.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 classMethodVisitor
- 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 inMethodVisitor.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
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 toOpcodes.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 andstack[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 andlocal
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 classMethodVisitor
- Parameters:
type
- the type of this stack map frame. Must beOpcodes.F_NEW
for expanded frames, orOpcodes.F_FULL
,Opcodes.F_APPEND
,Opcodes.F_CHOP
,Opcodes.F_SAME
orOpcodes.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 byOpcodes.TOP
,Opcodes.INTEGER
,Opcodes.FLOAT
,Opcodes.LONG
,Opcodes.DOUBLE
,Opcodes.NULL
orOpcodes.UNINITIALIZED_THIS
(long and double are represented by a single element). Reference types are represented by String objects (representing internal names, seeType.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
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 classMethodVisitor
- 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 (seeType.getInternalName()
).name
- the field's name.descriptor
- the field's descriptor (seeType
).
-
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 classMethodVisitor
- 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 (seeType.getInternalName()
).name
- the method's name.descriptor
- the method's descriptor (seeType
).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 classMethodVisitor
- Parameters:
name
- the method's name.descriptor
- the method's descriptor (seeType
).bootstrapMethodHandle
- the bootstrap method.bootstrapMethodArguments
- the bootstrap method constant arguments. Each argument must be anInteger
,Float
,Long
,Double
,String
,Type
,Handle
orConstantDynamic
value. This method is allowed to modify the content of the array so a caller should expect that this array may change.
-
visitTypeInsn
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 (seeType.getInternalName()
).- Overrides:
visitTypeInsn
in classMethodVisitor
- 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 (seeType.getInternalName()
).
-
visitLdcInsn
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 classMethodVisitor
- Parameters:
value
- the constant to be loaded on the stack. This parameter must be a non nullInteger
, aFloat
, aLong
, aDouble
, aString
, aType
of OBJECT or ARRAY sort for.class
constants, for classes whose version is 49, aType
of METHOD sort for MethodType, aHandle
for MethodHandle constants, for classes whose version is 51 or aConstantDynamic
for a constant dynamic for classes whose version is 55.
-
visitMultiANewArrayInsn
Description copied from class:MethodVisitor
Visits a MULTIANEWARRAY instruction.- Overrides:
visitMultiANewArrayInsn
in classMethodVisitor
- Parameters:
descriptor
- an array type descriptor (seeType
).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 classMethodVisitor
- Parameters:
typeRef
- a reference to the annotated type. The sort of this type reference must beTypeReference.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
, orTypeReference.METHOD_REFERENCE_TYPE_ARGUMENT
. SeeTypeReference
.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
Description copied from class:MethodVisitor
Visits a try catch block.- Overrides:
visitTryCatchBlock
in classMethodVisitor
- 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 (seeType.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 theMethodVisitor.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 classMethodVisitor
- Parameters:
typeRef
- a reference to the annotated type. The sort of this type reference must beTypeReference.EXCEPTION_PARAMETER
. SeeTypeReference
.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 classMethodVisitor
- 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 classMethodVisitor
- Parameters:
typeRef
- a reference to the annotated type. The sort of this type reference must beTypeReference.LOCAL_VARIABLE
orTypeReference.RESOURCE_VARIABLE
. SeeTypeReference
.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.usecreateAnnotationRemapper(String, AnnotationVisitor)
instead.Constructs a new remapper for annotations. The default implementation of this method returns a newAnnotationRemapper
.- 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 newAnnotationRemapper
.- Parameters:
descriptor
- the descriptor of the visited annotation.annotationVisitor
- the AnnotationVisitor the remapper must delegate to.- Returns:
- the newly created remapper.
-
createAnnotationRemapper(String, AnnotationVisitor)
instead.