Module org.eclipse.persistence.asm
Class AdviceAdapter
java.lang.Object
org.eclipse.persistence.internal.libraries.asm.MethodVisitor
org.eclipse.persistence.internal.libraries.asm.commons.LocalVariablesSorter
org.eclipse.persistence.internal.libraries.asm.commons.GeneratorAdapter
org.eclipse.persistence.internal.libraries.asm.commons.AdviceAdapter
- All Implemented Interfaces:
Opcodes
A
MethodVisitor
to insert before, after and around advices in methods and constructors.
For constructors, the code keeps track of the elements on the stack in order to detect when the
super class constructor is called (note that there can be multiple such calls in different
branches). onMethodEnter
is called after each super class constructor call, because the
object cannot be used before it is properly initialized.-
Field Summary
Modifier and TypeFieldDescriptionprotected int
The access flags of the visited method.protected String
The descriptor of the visited method.Fields inherited from class org.eclipse.persistence.internal.libraries.asm.commons.GeneratorAdapter
ADD, AND, DIV, EQ, GE, GT, LE, LT, MUL, NE, NEG, OR, REM, SHL, SHR, SUB, USHR, XOR
Fields inherited from class org.eclipse.persistence.internal.libraries.asm.commons.LocalVariablesSorter
firstLocal, nextLocal
Fields inherited from class org.eclipse.persistence.internal.libraries.asm.MethodVisitor
api, mv
Fields inherited from interface org.eclipse.persistence.internal.libraries.asm.Opcodes
AALOAD, AASTORE, ACC_ABSTRACT, ACC_ANNOTATION, ACC_BRIDGE, ACC_DEPRECATED, ACC_ENUM, ACC_FINAL, ACC_INTERFACE, ACC_MANDATED, ACC_MODULE, ACC_NATIVE, ACC_OPEN, ACC_PRIVATE, ACC_PROTECTED, ACC_PUBLIC, ACC_RECORD, ACC_STATIC, ACC_STATIC_PHASE, ACC_STRICT, ACC_SUPER, ACC_SYNCHRONIZED, ACC_SYNTHETIC, ACC_TRANSIENT, ACC_TRANSITIVE, ACC_VARARGS, ACC_VOLATILE, ACONST_NULL, ALOAD, ANEWARRAY, ARETURN, ARRAYLENGTH, ASM10_EXPERIMENTAL, ASM4, ASM5, ASM6, ASM7, ASM8, ASM9, ASTORE, ATHROW, BALOAD, BASTORE, BIPUSH, CALOAD, CASTORE, CHECKCAST, D2F, D2I, D2L, DADD, DALOAD, DASTORE, DCMPG, DCMPL, DCONST_0, DCONST_1, DDIV, DLOAD, DMUL, DNEG, DOUBLE, DREM, DRETURN, DSTORE, DSUB, DUP, DUP_X1, DUP_X2, DUP2, DUP2_X1, DUP2_X2, F_APPEND, F_CHOP, F_FULL, F_NEW, F_SAME, F_SAME1, F2D, F2I, F2L, FADD, FALOAD, FASTORE, FCMPG, FCMPL, FCONST_0, FCONST_1, FCONST_2, FDIV, FLOAD, FLOAT, FMUL, FNEG, FREM, FRETURN, FSTORE, FSUB, GETFIELD, GETSTATIC, GOTO, H_GETFIELD, H_GETSTATIC, H_INVOKEINTERFACE, H_INVOKESPECIAL, H_INVOKESTATIC, H_INVOKEVIRTUAL, H_NEWINVOKESPECIAL, H_PUTFIELD, H_PUTSTATIC, I2B, I2C, I2D, I2F, I2L, I2S, IADD, IALOAD, IAND, IASTORE, ICONST_0, ICONST_1, ICONST_2, ICONST_3, ICONST_4, ICONST_5, ICONST_M1, IDIV, IF_ACMPEQ, IF_ACMPNE, IF_ICMPEQ, IF_ICMPGE, IF_ICMPGT, IF_ICMPLE, IF_ICMPLT, IF_ICMPNE, IFEQ, IFGE, IFGT, IFLE, IFLT, IFNE, IFNONNULL, IFNULL, IINC, ILOAD, IMUL, INEG, INSTANCEOF, INTEGER, INVOKEDYNAMIC, INVOKEINTERFACE, INVOKESPECIAL, INVOKESTATIC, INVOKEVIRTUAL, IOR, IREM, IRETURN, ISHL, ISHR, ISTORE, ISUB, IUSHR, IXOR, JSR, L2D, L2F, L2I, LADD, LALOAD, LAND, LASTORE, LCMP, LCONST_0, LCONST_1, LDC, LDIV, LLOAD, LMUL, LNEG, LONG, LOOKUPSWITCH, LOR, LREM, LRETURN, LSHL, LSHR, LSTORE, LSUB, LUSHR, LXOR, MONITORENTER, MONITOREXIT, MULTIANEWARRAY, NEW, NEWARRAY, NOP, NULL, POP, POP2, PUTFIELD, PUTSTATIC, RET, RETURN, SALOAD, SASTORE, SIPUSH, SOURCE_DEPRECATED, SOURCE_MASK, SWAP, T_BOOLEAN, T_BYTE, T_CHAR, T_DOUBLE, T_FLOAT, T_INT, T_LONG, T_SHORT, TABLESWITCH, TOP, V_PREVIEW, V1_1, V1_2, V1_3, V1_4, V1_5, V1_6, V1_7, V1_8, V10, V11, V12, V13, V14, V15, V16, V17, V18, V19, V20, V21, V22, V23, V9
-
Constructor Summary
ModifierConstructorDescriptionprotected
AdviceAdapter
(int api, MethodVisitor methodVisitor, int access, String name, String descriptor) Constructs a newAdviceAdapter
. -
Method Summary
Modifier and TypeMethodDescriptionprotected void
Generates the "before" advice for the visited method.protected void
onMethodExit
(int opcode) Generates the "after" advice for the visited method.void
Starts the visit of the method's code, if any (i.e.void
visitFieldInsn
(int opcode, String owner, String name, String descriptor) Visits a field instruction.void
visitInsn
(int opcode) Visits a zero operand instruction.void
visitIntInsn
(int opcode, int operand) Visits an instruction with a single int operand.void
visitInvokeDynamicInsn
(String name, String descriptor, Handle bootstrapMethodHandle, Object... bootstrapMethodArguments) Visits an invokedynamic instruction.void
visitJumpInsn
(int opcode, Label label) Visits a jump instruction.void
visitLabel
(Label label) Visits a label.void
visitLdcInsn
(Object value) Visits a LDC instruction.void
visitLookupSwitchInsn
(Label dflt, int[] keys, Label[] labels) Visits a LOOKUPSWITCH instruction.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.void
visitTableSwitchInsn
(int min, int max, Label dflt, Label... labels) Visits a TABLESWITCH instruction.void
visitTryCatchBlock
(Label start, Label end, Label handler, String type) Visits a try catch block.void
visitTypeInsn
(int opcode, String type) Visits a type instruction.void
visitVarInsn
(int opcode, int varIndex) Visits a local variable instruction.Methods inherited from class org.eclipse.persistence.internal.libraries.asm.commons.GeneratorAdapter
arrayLength, arrayLoad, arrayStore, box, cast, catchException, checkCast, dup, dup2, dup2X1, dup2X2, dupX1, dupX2, endMethod, getAccess, getArgumentTypes, getField, getLocalType, getName, getReturnType, getStatic, goTo, ifCmp, ifICmp, ifNonNull, ifNull, ifZCmp, iinc, instanceOf, invokeConstructor, invokeDynamic, invokeInterface, invokeStatic, invokeVirtual, loadArg, loadArgArray, loadArgs, loadArgs, loadLocal, loadLocal, loadThis, mark, mark, math, monitorEnter, monitorExit, newArray, newInstance, newLabel, not, pop, pop2, push, push, push, push, push, push, push, push, push, putField, putStatic, ret, returnValue, setLocalType, storeArg, storeLocal, storeLocal, swap, swap, tableSwitch, tableSwitch, throwException, throwException, unbox, valueOf
Methods inherited from class org.eclipse.persistence.internal.libraries.asm.commons.LocalVariablesSorter
newLocal, newLocalMapping, updateNewLocals, visitFrame, visitIincInsn, visitLocalVariable, visitLocalVariableAnnotation, visitMaxs
Methods inherited from class org.eclipse.persistence.internal.libraries.asm.MethodVisitor
getDelegate, visitAnnotableParameterCount, visitAnnotation, visitAnnotationDefault, visitAttribute, visitEnd, visitInsnAnnotation, visitLineNumber, visitMethodInsn, visitParameter, visitParameterAnnotation, visitTryCatchAnnotation, visitTypeAnnotation
-
Field Details
-
methodAccess
protected int methodAccessThe access flags of the visited method. -
methodDesc
The descriptor of the visited method.
-
-
Constructor Details
-
AdviceAdapter
protected AdviceAdapter(int api, MethodVisitor methodVisitor, int access, String name, String descriptor) Constructs a newAdviceAdapter
.- Parameters:
api
- the ASM API version implemented by this visitor. Must be one of theASM
x values inOpcodes
.methodVisitor
- the method visitor to which this adapter delegates calls.access
- the method's access flags (seeOpcodes
).name
- the method's name.descriptor
- the method's descriptor (seeType
).
-
-
Method Details
-
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 classMethodVisitor
-
visitLabel
Description copied from class:MethodVisitor
Visits a label. A label designates the instruction that will be visited just after it.- Overrides:
visitLabel
in classMethodVisitor
- Parameters:
label
- aLabel
object.
-
visitInsn
public void visitInsn(int opcode) Description copied from class:MethodVisitor
Visits a zero operand instruction.- Overrides:
visitInsn
in classMethodVisitor
- 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 varIndex) 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 classLocalVariablesSorter
- 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.varIndex
- the operand of the instruction to be visited. This operand is the index of a local variable.
-
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
).
-
visitIntInsn
public void visitIntInsn(int opcode, int operand) Description copied from class:MethodVisitor
Visits an instruction with a single int operand.- Overrides:
visitIntInsn
in classMethodVisitor
- Parameters:
opcode
- the opcode of the instruction to be visited. This opcode is either BIPUSH, SIPUSH or NEWARRAY.operand
- the operand of the instruction to be visited.
When opcode is BIPUSH, operand value should be between Byte.MIN_VALUE and Byte.MAX_VALUE.
When opcode is SIPUSH, operand value should be between Short.MIN_VALUE and Short.MAX_VALUE.
When opcode is NEWARRAY, operand value should be one ofOpcodes.T_BOOLEAN
,Opcodes.T_CHAR
,Opcodes.T_FLOAT
,Opcodes.T_DOUBLE
,Opcodes.T_BYTE
,Opcodes.T_SHORT
,Opcodes.T_INT
orOpcodes.T_LONG
.
-
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.
-
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()
).
-
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.
-
visitJumpInsn
Description copied from class:MethodVisitor
Visits a jump instruction. A jump instruction is an instruction that may jump to another instruction.- Overrides:
visitJumpInsn
in classMethodVisitor
- 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.
-
visitLookupSwitchInsn
Description copied from class:MethodVisitor
Visits a LOOKUPSWITCH instruction.- Overrides:
visitLookupSwitchInsn
in classMethodVisitor
- 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 thekeys[i]
key.
-
visitTableSwitchInsn
Description copied from class:MethodVisitor
Visits a TABLESWITCH instruction.- Overrides:
visitTableSwitchInsn
in classMethodVisitor
- 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 themin + i
key.
-
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).
-
onMethodEnter
protected void onMethodEnter()Generates the "before" advice for the visited method. The default implementation of this method does nothing. Subclasses can use or change all the local variables, but should not change state of the stack. This method is called at the beginning of the method or after super class constructor has been called (in constructors). -
onMethodExit
protected void onMethodExit(int opcode) Generates the "after" advice for the visited method. The default implementation of this method does nothing. Subclasses can use or change all the local variables, but should not change state of the stack. This method is called at the end of the method, just before return and athrow instructions. The top element on the stack contains the return value or the exception instance. For example:public void onMethodExit(final int opcode) { if (opcode == RETURN) { visitInsn(ACONST_NULL); } else if (opcode == ARETURN || opcode == ATHROW) { dup(); } else { if (opcode == LRETURN || opcode == DRETURN) { dup2(); } else { dup(); } box(Type.getReturnType(this.methodDesc)); } visitIntInsn(SIPUSH, opcode); visitMethodInsn(INVOKESTATIC, owner, "onExit", "(Ljava/lang/Object;I)V"); } // An actual call back method. public static void onExit(final Object exitValue, final int opcode) { ... }
- Parameters:
opcode
- one ofOpcodes.RETURN
,Opcodes.IRETURN
,Opcodes.FRETURN
,Opcodes.ARETURN
,Opcodes.LRETURN
,Opcodes.DRETURN
orOpcodes.ATHROW
.
-