public abstract class AdviceAdapter extends GeneratorAdapter implements Opcodes
MethodVisitor to insert before, after and around
advices in methods and constructors.
The behavior for constructors is like this:
| Modifier and Type | Field and Description |
|---|---|
protected int |
methodAccess |
protected String |
methodDesc |
ADD, AND, DIV, EQ, GE, GT, LE, LT, MUL, NE, NEG, OR, REM, SHL, SHR, SUB, USHR, XORfirstLocal, nextLocalapi, mvAALOAD, AASTORE, ACC_ABSTRACT, ACC_ANNOTATION, ACC_BRIDGE, ACC_DEPRECATED, ACC_ENUM, ACC_FINAL, ACC_INTERFACE, ACC_MANDATED, ACC_NATIVE, ACC_PRIVATE, ACC_PROTECTED, ACC_PUBLIC, ACC_STATIC, ACC_STRICT, ACC_SUPER, ACC_SYNCHRONIZED, ACC_SYNTHETIC, ACC_TRANSIENT, ACC_VARARGS, ACC_VOLATILE, ACONST_NULL, ALOAD, ANEWARRAY, ARETURN, ARRAYLENGTH, ASM4, ASM5, 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, SWAP, T_BOOLEAN, T_BYTE, T_CHAR, T_DOUBLE, T_FLOAT, T_INT, T_LONG, T_SHORT, TABLESWITCH, TOP, UNINITIALIZED_THIS, V1_1, V1_2, V1_3, V1_4, V1_5, V1_6, V1_7, V1_8| Modifier | Constructor and Description |
|---|---|
protected |
AdviceAdapter(int api,
MethodVisitor mv,
int access,
String name,
String desc)
Creates a new
AdviceAdapter. |
| Modifier and Type | Method and Description |
|---|---|
protected void |
onMethodEnter()
Called at the beginning of the method or after super class call in
the constructor.
|
protected void |
onMethodExit(int opcode)
Called before explicit exit from the method using either return or throw.
|
void |
visitCode()
Starts the visit of the method's code, if any (i.e. non abstract method).
|
void |
visitFieldInsn(int opcode,
String owner,
String name,
String desc)
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 desc,
Handle bsm,
Object... bsmArgs)
Visits an invokedynamic instruction.
|
void |
visitJumpInsn(int opcode,
Label label)
Visits a jump instruction.
|
void |
visitLabel(Label label)
Visits a label.
|
void |
visitLdcInsn(Object cst)
Visits a LDC instruction.
|
void |
visitLookupSwitchInsn(Label dflt,
int[] keys,
Label[] labels)
Visits a LOOKUPSWITCH instruction.
|
void |
visitMethodInsn(int opcode,
String owner,
String name,
String desc)
Deprecated.
|
void |
visitMethodInsn(int opcode,
String owner,
String name,
String desc,
boolean itf)
Visits a method instruction.
|
void |
visitMultiANewArrayInsn(String desc,
int dims)
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 var)
Visits a local variable instruction.
|
arrayLength, arrayLoad, arrayStore, box, cast, catchException, checkCast, dup, dup2, dup2X1, dup2X2, dupX1, dupX2, endMethod, getField, getLocalType, 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, putField, putStatic, ret, returnValue, setLocalType, storeArg, storeLocal, storeLocal, swap, swap, tableSwitch, tableSwitch, throwException, throwException, unbox, valueOfnewLocal, newLocalMapping, updateNewLocals, visitFrame, visitIincInsn, visitLocalVariable, visitLocalVariableAnnotation, visitMaxsvisitAnnotation, visitAnnotationDefault, visitAttribute, visitEnd, visitInsnAnnotation, visitLineNumber, visitParameter, visitParameterAnnotation, visitTryCatchAnnotation, visitTypeAnnotationprotected int methodAccess
protected String methodDesc
protected AdviceAdapter(int api,
MethodVisitor mv,
int access,
String name,
String desc)
AdviceAdapter.api - the ASM API version implemented by this visitor. Must be one
of Opcodes.ASM4 or Opcodes.ASM5.mv - the method visitor to which this adapter delegates calls.access - the method's access flags (see Opcodes).name - the method's name.desc - the method's descriptor (see Type).public void visitCode()
MethodVisitorvisitCode in class MethodVisitorpublic void visitLabel(Label label)
MethodVisitorvisitLabel in class MethodVisitorlabel - a Label object.public void visitInsn(int opcode)
MethodVisitorvisitInsn in class MethodVisitoropcode - 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.public void visitVarInsn(int opcode,
int var)
MethodVisitorvisitVarInsn in class LocalVariablesSorteropcode - 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.public void visitFieldInsn(int opcode,
String owner,
String name,
String desc)
MethodVisitorvisitFieldInsn in class MethodVisitoropcode - 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
getInternalName).name - the field's name.desc - the field's descriptor (see Type).public void visitIntInsn(int opcode,
int operand)
MethodVisitorvisitIntInsn in class MethodVisitoropcode - 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.Opcodes.T_BOOLEAN, Opcodes.T_CHAR,
Opcodes.T_FLOAT, Opcodes.T_DOUBLE,
Opcodes.T_BYTE, Opcodes.T_SHORT,
Opcodes.T_INT or Opcodes.T_LONG.public void visitLdcInsn(Object cst)
MethodVisitor
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 {
// throw an exception
}
visitLdcInsn in class MethodVisitorcst - 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.0, a Type of METHOD sort or a
Handle for MethodType and MethodHandle constants, for
classes whose version is 51.0.public void visitMultiANewArrayInsn(String desc, int dims)
MethodVisitorvisitMultiANewArrayInsn in class MethodVisitordesc - an array type descriptor (see Type).dims - number of dimensions of the array to allocate.public void visitTypeInsn(int opcode,
String type)
MethodVisitorvisitTypeInsn in class MethodVisitoropcode - 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
getInternalName).@Deprecated public void visitMethodInsn(int opcode, String owner, String name, String desc)
MethodVisitorvisitMethodInsn in class MethodVisitoropcode - 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
getInternalName).name - the method's name.desc - the method's descriptor (see Type).public void visitMethodInsn(int opcode,
String owner,
String name,
String desc,
boolean itf)
MethodVisitorvisitMethodInsn in class MethodVisitoropcode - 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
getInternalName).name - the method's name.desc - the method's descriptor (see Type).itf - if the method's owner class is an interface.public void visitInvokeDynamicInsn(String name, String desc, Handle bsm, Object... bsmArgs)
MethodVisitorvisitInvokeDynamicInsn in class MethodVisitorname - the method's name.desc - the method's descriptor (see Type).bsm - the bootstrap method.bsmArgs - the bootstrap method constant arguments. Each argument must be
an Integer, Float, Long,
Double, String, Type or Handle
value. This method is allowed to modify the content of the
array so a caller should expect that this array may change.public void visitJumpInsn(int opcode,
Label label)
MethodVisitorvisitJumpInsn in class MethodVisitoropcode - 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.public void visitLookupSwitchInsn(Label dflt, int[] keys, Label[] labels)
MethodVisitorvisitLookupSwitchInsn in class MethodVisitordflt - 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.public void visitTableSwitchInsn(int min,
int max,
Label dflt,
Label... labels)
MethodVisitorvisitTableSwitchInsn in class MethodVisitormin - 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.public void visitTryCatchBlock(Label start, Label end, Label handler, String type)
MethodVisitorvisitTryCatchBlock in class MethodVisitorstart - beginning of the exception handler's scope (inclusive).end - end of the exception handler's scope (exclusive).handler - beginning of the exception handler's code.type - internal name of the type of exceptions handled by the
handler, or null to catch any exceptions (for
"finally" blocks).protected void onMethodEnter()
protected void onMethodExit(int opcode)
public void onMethodExit(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(Object param, int opcode) {
...
opcode - one of the RETURN, IRETURN, FRETURN, ARETURN, LRETURN, DRETURN
or ATHROW