public abstract class MethodVisitor extends Object
visitParameter
)* [ visitAnnotationDefault
] ( visitAnnotation
|
visitAnnotableParameterCount
| visitParameterAnnotation
visitTypeAnnotation
| visitAttribute
)* [ visitCode
( visitFrame
|
visit<i>X</i>Insn
| visitLabel
| visitInsnAnnotation
| visitTryCatchBlock
| visitTryCatchAnnotation
| visitLocalVariable
| visitLocalVariableAnnotation
| visitLineNumber
)* visitMaxs
] visitEnd
.
In addition, the visit<i>X</i>Insn
and visitLabel
methods must be called in the
sequential order of the bytecode instructions of the visited code, visitInsnAnnotation
must be called after the annotated instruction, visitTryCatchBlock
must be called
before the labels passed as arguments have been visited, visitTryCatchBlockAnnotation
must be called after the corresponding try catch block has
been visited, and the visitLocalVariable
, visitLocalVariableAnnotation
and visitLineNumber
methods must be called after the labels passed as arguments have been
visited.Modifier and Type | Field and Description |
---|---|
protected int |
api
The ASM API version implemented by this visitor.
|
protected MethodVisitor |
mv
The method visitor to which this visitor must delegate method calls.
|
Constructor and Description |
---|
MethodVisitor(int api)
Constructs a new
MethodVisitor . |
MethodVisitor(int api,
MethodVisitor methodVisitor)
Constructs a new
MethodVisitor . |
Modifier and Type | Method and Description |
---|---|
void |
visitAnnotableParameterCount(int parameterCount,
boolean visible)
Visits the number of method parameters that can have annotations.
|
AnnotationVisitor |
visitAnnotation(String descriptor,
boolean visible)
Visits an annotation of this method.
|
AnnotationVisitor |
visitAnnotationDefault()
Visits the default value of this annotation interface method.
|
void |
visitAttribute(Attribute attribute)
Visits a non standard attribute of this method.
|
void |
visitCode()
Starts the visit of the method's code, if any (i.e.
|
void |
visitEnd()
Visits the end of the 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.
|
void |
visitIincInsn(int var,
int increment)
Visits an IINC instruction.
|
void |
visitInsn(int opcode)
Visits a zero operand instruction.
|
AnnotationVisitor |
visitInsnAnnotation(int typeRef,
TypePath typePath,
String descriptor,
boolean visible)
Visits an annotation on an 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 |
visitLineNumber(int line,
Label start)
Visits a line number declaration.
|
void |
visitLocalVariable(String name,
String descriptor,
String signature,
Label start,
Label end,
int index)
Visits a local variable declaration.
|
AnnotationVisitor |
visitLocalVariableAnnotation(int typeRef,
TypePath typePath,
Label[] start,
Label[] end,
int[] index,
String descriptor,
boolean visible)
Visits an annotation on a local variable type.
|
void |
visitLookupSwitchInsn(Label dflt,
int[] keys,
Label[] labels)
Visits a LOOKUPSWITCH instruction.
|
void |
visitMaxs(int maxStack,
int maxLocals)
Visits the maximum stack size and the maximum number of local variables of the method.
|
void |
visitMethodInsn(int opcode,
String owner,
String name,
String descriptor)
Deprecated.
|
void |
visitMethodInsn(int opcode,
String owner,
String name,
String descriptor,
boolean isInterface)
Visits a method instruction.
|
void |
visitMultiANewArrayInsn(String descriptor,
int numDimensions)
Visits a MULTIANEWARRAY instruction.
|
void |
visitParameter(String name,
int access)
Visits a parameter of this method.
|
AnnotationVisitor |
visitParameterAnnotation(int parameter,
String descriptor,
boolean visible)
Visits an annotation of a parameter this method.
|
void |
visitTableSwitchInsn(int min,
int max,
Label dflt,
Label... labels)
Visits a TABLESWITCH instruction.
|
AnnotationVisitor |
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.
|
AnnotationVisitor |
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.
|
void |
visitVarInsn(int opcode,
int var)
Visits a local variable instruction.
|
protected final int api
Opcodes.ASM4
, Opcodes.ASM5
, Opcodes.ASM6
or Opcodes.ASM7
.protected MethodVisitor mv
public MethodVisitor(int api)
MethodVisitor
.api
- the ASM API version implemented by this visitor. Must be one of Opcodes.ASM4
, Opcodes.ASM5
, Opcodes.ASM6
or Opcodes.ASM7
.public MethodVisitor(int api, MethodVisitor methodVisitor)
MethodVisitor
.api
- the ASM API version implemented by this visitor. Must be one of Opcodes.ASM4
, Opcodes.ASM5
, Opcodes.ASM6
or Opcodes.ASM7
.methodVisitor
- the method visitor to which this visitor must delegate method calls. May
be null.public void visitParameter(String name, int access)
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
).public AnnotationVisitor visitAnnotationDefault()
public AnnotationVisitor visitAnnotation(String descriptor, boolean visible)
descriptor
- the class descriptor of the annotation class.visible
- true if the annotation is visible at runtime.public AnnotationVisitor visitTypeAnnotation(int typeRef, TypePath typePath, String descriptor, boolean visible)
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.public void visitAnnotableParameterCount(int parameterCount, boolean visible)
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.public AnnotationVisitor visitParameterAnnotation(int parameter, String descriptor, boolean visible)
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 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.public void visitAttribute(Attribute attribute)
attribute
- an attribute.public void visitCode()
public void visitFrame(int type, int numLocal, Object[] local, int numStack, Object[] stack)
Opcodes.V1_6
. 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.
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.IllegalStateException
- if a frame is visited just after another one, without any
instruction between the two (unless this frame is a Opcodes#F_SAME frame, in which case it
is silently ignored).public void visitInsn(int opcode)
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.public void visitIntInsn(int opcode, int operand)
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.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 visitVarInsn(int opcode, int var)
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.public void visitTypeInsn(int opcode, String type)
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()
).public void visitFieldInsn(int opcode, String owner, String name, String descriptor)
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
).@Deprecated public void visitMethodInsn(int opcode, String owner, String name, String descriptor)
visitMethodInsn(int, String, String, String, boolean)
instead.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
).public void visitMethodInsn(int opcode, String owner, String name, String descriptor, boolean isInterface)
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.public void visitInvokeDynamicInsn(String name, String descriptor, Handle bootstrapMethodHandle, Object... bootstrapMethodArguments)
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.public void visitJumpInsn(int opcode, Label label)
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.public void visitLabel(Label label)
label
- a Label
object.public void visitLdcInsn(Object value)
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 }
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.public void visitIincInsn(int var, int increment)
var
- index of the local variable to be incremented.increment
- amount to increment the local variable by.public void visitTableSwitchInsn(int min, int max, Label dflt, Label... labels)
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.public void visitLookupSwitchInsn(Label dflt, int[] keys, Label[] labels)
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.public void visitMultiANewArrayInsn(String descriptor, int numDimensions)
descriptor
- an array type descriptor (see Type
).numDimensions
- the number of dimensions of the array to allocate.public AnnotationVisitor visitInsnAnnotation(int typeRef, TypePath typePath, String descriptor, boolean visible)
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.public void visitTryCatchBlock(Label start, Label end, Label handler, String type)
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).IllegalArgumentException
- if one of the labels has already been visited by this visitor
(by the visitLabel(org.springframework.asm.Label)
method).public AnnotationVisitor visitTryCatchAnnotation(int typeRef, TypePath typePath, String descriptor, boolean visible)
visitTryCatchBlock(org.springframework.asm.Label, org.springframework.asm.Label, org.springframework.asm.Label, java.lang.String)
for the annotated exception handler. It can be called several times
for the same exception handler.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.public void visitLocalVariable(String name, String descriptor, String signature, Label start, Label end, int index)
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.IllegalArgumentException
- if one of the labels has not already been visited by this
visitor (by the visitLabel(org.springframework.asm.Label)
method).public AnnotationVisitor visitLocalVariableAnnotation(int typeRef, TypePath typePath, Label[] start, Label[] end, int[] index, String descriptor, boolean visible)
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.public void visitLineNumber(int line, Label start)
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.IllegalArgumentException
- if start
has not already been visited by this visitor
(by the visitLabel(org.springframework.asm.Label)
method).public void visitMaxs(int maxStack, int maxLocals)
maxStack
- maximum stack size of the method.maxLocals
- maximum number of local variables for the method.public void visitEnd()