public class CheckMethodAdapter extends MethodVisitor
MethodVisitor
that checks that its methods are properly used. More precisely this
method adapter checks each instruction individually, i.e., each visit method checks some
preconditions based only on its arguments - such as the fact that the given opcode is
correct for a given visit method. This adapter can also perform some basic data flow checks (more
precisely those that can be performed without the full class hierarchy - see BasicVerifier
). For instance in a method whose signature is
void m (), the invalid instruction IRETURN, or the invalid sequence IADD L2I will be
detected if the data flow checks are enabled. These checks are enabled by using the CheckMethodAdapter(int,String,String,MethodVisitor,Map)
constructor. They are not performed if
any other constructor is used.Modifier and Type | Class and Description |
---|---|
private static class |
CheckMethodAdapter.Method
The 'generic' instruction visit methods (i.e.
|
Modifier and Type | Field and Description |
---|---|
private int |
access
The access flags of the visited method.
|
private static java.lang.String |
END_LABEL |
private java.util.List<Label> |
handlers
The exception handler ranges.
|
private int |
insnCount
The number of visited instructions so far.
|
private static java.lang.String |
INVALID |
private static java.lang.String |
INVALID_DESCRIPTOR |
private static java.lang.String |
INVALID_LOCAL_VARIABLE_INDEX |
private static java.lang.String |
INVALID_TYPE_REFERENCE |
private int |
invisibleAnnotableParameterCount
The number of method parameters that can have runtime invisible annotations.
|
private java.util.Map<Label,java.lang.Integer> |
labelInsnIndices
The index of the instruction designated by each visited label.
|
private int |
lastFrameInsnIndex
The index of the instruction corresponding to the last visited stack map frame.
|
private static java.lang.String |
MUST_NOT_BE_NULL_OR_EMPTY |
private int |
numCompressedFrames
The number of visited frames in compressed form.
|
private int |
numExpandedFrames
The number of visited frames in expanded form.
|
private static CheckMethodAdapter.Method[] |
OPCODE_METHODS
The method to use to visit each instruction.
|
private java.util.Set<Label> |
referencedLabels
The labels referenced by the visited method.
|
private static java.lang.String |
START_LABEL |
int |
version
The class version number.
|
private int |
visibleAnnotableParameterCount
The number of method parameters that can have runtime visible annotations.
|
private boolean |
visitCodeCalled
Whether the
visitCode() method has been called. |
private boolean |
visitEndCalled
Whether the
visitEnd() method has been called. |
private boolean |
visitMaxCalled
Whether the
visitMaxs(int, int) method has been called. |
api, mv
Modifier | Constructor and Description |
---|---|
protected |
CheckMethodAdapter(int api,
int access,
java.lang.String name,
java.lang.String descriptor,
MethodVisitor methodVisitor,
java.util.Map<Label,java.lang.Integer> labelInsnIndices)
Constructs a new
CheckMethodAdapter object. |
protected |
CheckMethodAdapter(int api,
MethodVisitor methodVisitor,
java.util.Map<Label,java.lang.Integer> labelInsnIndices)
Constructs a new
CheckMethodAdapter object. |
|
CheckMethodAdapter(int access,
java.lang.String name,
java.lang.String descriptor,
MethodVisitor methodVisitor,
java.util.Map<Label,java.lang.Integer> labelInsnIndices)
Constructs a new
CheckMethodAdapter object. |
|
CheckMethodAdapter(MethodVisitor methodvisitor)
Constructs a new
CheckMethodAdapter object. |
|
CheckMethodAdapter(MethodVisitor methodVisitor,
java.util.Map<Label,java.lang.Integer> labelInsnIndices)
Constructs a new
CheckMethodAdapter object. |
Modifier and Type | Method and Description |
---|---|
(package private) static void |
checkConstant(java.lang.Object value)
Checks that the given value is an
Integer , Float , Long , Double
or String value. |
(package private) static void |
checkDescriptor(int version,
java.lang.String descriptor,
boolean canBeVoid)
Checks that the given string is a valid type descriptor.
|
private static int |
checkDescriptor(int version,
java.lang.String descriptor,
int startPos,
boolean canBeVoid)
Checks that a the given substring is a valid type descriptor.
|
private void |
checkFrameValue(java.lang.Object value)
Checks a stack frame value.
|
(package private) static void |
checkIdentifier(int version,
java.lang.String name,
int startPos,
int endPos,
java.lang.String message)
Checks that the given substring is a valid Java identifier.
|
private static void |
checkInternalClassName(int version,
java.lang.String name,
java.lang.String message)
Checks that the given string is a valid internal class name.
|
(package private) static void |
checkInternalName(int version,
java.lang.String name,
java.lang.String message)
Checks that the given string is a valid internal class name or array type descriptor.
|
private void |
checkLabel(Label label,
boolean checkVisited,
java.lang.String message)
Checks that the given label is not null.
|
private void |
checkLdcConstant(java.lang.Object value)
Checks that the given value is a valid operand for the LDC instruction.
|
(package private) static void |
checkMethodDescriptor(int version,
java.lang.String descriptor)
Checks that the given string is a valid method descriptor.
|
(package private) static void |
checkMethodIdentifier(int version,
java.lang.String name,
java.lang.String message)
Checks that the given string is a valid Java identifier.
|
private static void |
checkOpcodeMethod(int opcode,
CheckMethodAdapter.Method method)
Checks that the method to visit the given opcode is equal to the given method.
|
private static void |
checkSignedByte(int value,
java.lang.String message)
Checks that the given value is a signed byte.
|
private static void |
checkSignedShort(int value,
java.lang.String message)
Checks that the given value is a signed short.
|
(package private) static void |
checkUnqualifiedName(int version,
java.lang.String name,
java.lang.String message)
Checks that the given string is a valid unqualified name.
|
private static void |
checkUnsignedShort(int value,
java.lang.String message)
Checks that the given value is an unsigned short.
|
private void |
checkVisitCodeCalled()
Checks that the
visitCode() method has been called. |
private void |
checkVisitEndNotCalled()
Checks that the
visitEnd() method has not been called. |
private void |
checkVisitMaxsNotCalled()
Checks that the
visitMaxs(int, int) method has not been called. |
private void |
doVisitMethodInsn(int opcode,
java.lang.String owner,
java.lang.String name,
java.lang.String descriptor,
boolean isInterface) |
void |
visitAnnotableParameterCount(int parameterCount,
boolean visible)
Visits the number of method parameters that can have annotations.
|
AnnotationVisitor |
visitAnnotation(java.lang.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,
java.lang.String owner,
java.lang.String name,
java.lang.String descriptor)
Visits a field instruction.
|
void |
visitFrame(int type,
int nLocal,
java.lang.Object[] local,
int nStack,
java.lang.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,
java.lang.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(java.lang.String name,
java.lang.String descriptor,
Handle bootstrapMethodHandle,
java.lang.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(java.lang.Object value)
Visits a LDC instruction.
|
void |
visitLineNumber(int line,
Label start)
Visits a line number declaration.
|
void |
visitLocalVariable(java.lang.String name,
java.lang.String descriptor,
java.lang.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,
java.lang.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,
java.lang.String owner,
java.lang.String name,
java.lang.String descriptor)
Deprecated.
|
void |
visitMethodInsn(int opcode,
java.lang.String owner,
java.lang.String name,
java.lang.String descriptor,
boolean isInterface)
Visits a method instruction.
|
void |
visitMultiANewArrayInsn(java.lang.String descriptor,
int numDimensions)
Visits a MULTIANEWARRAY instruction.
|
void |
visitParameter(java.lang.String name,
int access)
Visits a parameter of this method.
|
AnnotationVisitor |
visitParameterAnnotation(int parameter,
java.lang.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,
java.lang.String descriptor,
boolean visible)
Visits an annotation on an exception handler type.
|
void |
visitTryCatchBlock(Label start,
Label end,
Label handler,
java.lang.String type)
Visits a try catch block.
|
AnnotationVisitor |
visitTypeAnnotation(int typeRef,
TypePath typePath,
java.lang.String descriptor,
boolean visible)
Visits an annotation on a type in the method signature.
|
void |
visitTypeInsn(int opcode,
java.lang.String type)
Visits a type instruction.
|
void |
visitVarInsn(int opcode,
int var)
Visits a local variable instruction.
|
private static final CheckMethodAdapter.Method[] OPCODE_METHODS
private static final java.lang.String INVALID
private static final java.lang.String INVALID_DESCRIPTOR
private static final java.lang.String INVALID_TYPE_REFERENCE
private static final java.lang.String INVALID_LOCAL_VARIABLE_INDEX
private static final java.lang.String MUST_NOT_BE_NULL_OR_EMPTY
private static final java.lang.String START_LABEL
private static final java.lang.String END_LABEL
public int version
private int access
private int visibleAnnotableParameterCount
private int invisibleAnnotableParameterCount
private boolean visitCodeCalled
visitCode()
method has been called.private boolean visitMaxCalled
visitMaxs(int, int)
method has been called.private boolean visitEndCalled
visitEnd()
method has been called.private int insnCount
private final java.util.Map<Label,java.lang.Integer> labelInsnIndices
private java.util.Set<Label> referencedLabels
private int lastFrameInsnIndex
private int numExpandedFrames
private int numCompressedFrames
private java.util.List<Label> handlers
public CheckMethodAdapter(MethodVisitor methodvisitor)
CheckMethodAdapter
object. This method adapter will not perform any
data flow check (see CheckMethodAdapter(int,String,String,MethodVisitor,Map)
).
Subclasses must not use this constructor. Instead, they must use the CheckMethodAdapter(int, MethodVisitor, Map)
version.methodvisitor
- the method visitor to which this adapter must delegate calls.public CheckMethodAdapter(MethodVisitor methodVisitor, java.util.Map<Label,java.lang.Integer> labelInsnIndices)
CheckMethodAdapter
object. This method adapter will not perform any
data flow check (see CheckMethodAdapter(int,String,String,MethodVisitor,Map)
).
Subclasses must not use this constructor. Instead, they must use the CheckMethodAdapter(int, MethodVisitor, Map)
version.methodVisitor
- the method visitor to which this adapter must delegate calls.labelInsnIndices
- the index of the instruction designated by each visited label so far
(in other methods). This map is updated with the labels from the visited method.java.lang.IllegalStateException
- If a subclass calls this constructor.protected CheckMethodAdapter(int api, MethodVisitor methodVisitor, java.util.Map<Label,java.lang.Integer> labelInsnIndices)
CheckMethodAdapter
object. This method adapter will not perform any
data flow check (see CheckMethodAdapter(int,String,String,MethodVisitor,Map)
).api
- the ASM API version implemented by this CheckMethodAdapter. Must be one of Opcodes.ASM4
, Opcodes.ASM5
, Opcodes.ASM6
or Opcodes.ASM7_EXPERIMENTAL
.methodVisitor
- the method visitor to which this adapter must delegate calls.labelInsnIndices
- the index of the instruction designated by each visited label so far
(in other methods). This map is updated with the labels from the visited method.public CheckMethodAdapter(int access, java.lang.String name, java.lang.String descriptor, MethodVisitor methodVisitor, java.util.Map<Label,java.lang.Integer> labelInsnIndices)
CheckMethodAdapter
object. This method adapter will perform basic data
flow checks. For instance in a method whose signature is void m (), the invalid
instruction IRETURN, or the invalid sequence IADD L2I will be detected. Subclasses must not
use this constructor. Instead, they must use the CheckMethodAdapter(int,int,String,String,MethodVisitor,Map)
version.access
- the method's access flags.name
- the method's name.descriptor
- the method's descriptor (see Type
).methodVisitor
- the method visitor to which this adapter must delegate calls.labelInsnIndices
- the index of the instruction designated by each visited label so far
(in other methods). This map is updated with the labels from the visited method.protected CheckMethodAdapter(int api, int access, java.lang.String name, java.lang.String descriptor, MethodVisitor methodVisitor, java.util.Map<Label,java.lang.Integer> labelInsnIndices)
CheckMethodAdapter
object. This method adapter will perform basic data
flow checks. For instance in a method whose signature is void m (), the invalid
instruction IRETURN, or the invalid sequence IADD L2I will be detected.api
- the ASM API version implemented by this CheckMethodAdapter. Must be one of Opcodes.ASM4
, Opcodes.ASM5
, Opcodes.ASM6
or Opcodes.ASM7_EXPERIMENTAL
.access
- the method's access flags.name
- the method's name.descriptor
- the method's descriptor (see Type
).methodVisitor
- the method visitor to which this adapter must delegate calls.labelInsnIndices
- the index of the instruction designated by each visited label so far
(in other methods). This map is updated with the labels from the visited method.public void visitParameter(java.lang.String name, int access)
MethodVisitor
visitParameter
in class MethodVisitor
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 visitAnnotation(java.lang.String descriptor, boolean visible)
MethodVisitor
visitAnnotation
in class MethodVisitor
descriptor
- the class descriptor of the annotation class.visible
- true if the annotation is visible at runtime.public AnnotationVisitor visitTypeAnnotation(int typeRef, TypePath typePath, java.lang.String descriptor, boolean visible)
MethodVisitor
visitTypeAnnotation
in class MethodVisitor
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 AnnotationVisitor visitAnnotationDefault()
MethodVisitor
visitAnnotationDefault
in class MethodVisitor
public void visitAnnotableParameterCount(int parameterCount, boolean visible)
MethodVisitor
visitAnnotableParameterCount
in class MethodVisitor
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, java.lang.String descriptor, boolean visible)
MethodVisitor
visitParameterAnnotation
in class MethodVisitor
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.public void visitAttribute(Attribute attribute)
MethodVisitor
visitAttribute
in class MethodVisitor
attribute
- an attribute.public void visitCode()
MethodVisitor
visitCode
in class MethodVisitor
public void visitFrame(int type, int nLocal, java.lang.Object[] local, int nStack, java.lang.Object[] stack)
MethodVisitor
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 ( nStack
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 (
nLocal
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 (nLocals
is 1, 2 or 3).
Opcodes.F_FULL
representing complete frame data.
visitFrame
in class MethodVisitor
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.nLocal
- 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).nStack
- 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.public void visitInsn(int opcode)
MethodVisitor
visitInsn
in class MethodVisitor
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)
MethodVisitor
visitIntInsn
in class MethodVisitor
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)
MethodVisitor
visitVarInsn
in class MethodVisitor
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, java.lang.String type)
MethodVisitor
visitTypeInsn
in class MethodVisitor
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, java.lang.String owner, java.lang.String name, java.lang.String descriptor)
MethodVisitor
visitFieldInsn
in class MethodVisitor
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, java.lang.String owner, java.lang.String name, java.lang.String descriptor)
MethodVisitor
visitMethodInsn
in class MethodVisitor
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, java.lang.String owner, java.lang.String name, java.lang.String descriptor, boolean isInterface)
MethodVisitor
visitMethodInsn
in class MethodVisitor
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.private void doVisitMethodInsn(int opcode, java.lang.String owner, java.lang.String name, java.lang.String descriptor, boolean isInterface)
public void visitInvokeDynamicInsn(java.lang.String name, java.lang.String descriptor, Handle bootstrapMethodHandle, java.lang.Object... bootstrapMethodArguments)
MethodVisitor
visitInvokeDynamicInsn
in class MethodVisitor
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)
MethodVisitor
visitJumpInsn
in class MethodVisitor
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)
MethodVisitor
visitLabel
in class MethodVisitor
label
- a Label
object.public void visitLdcInsn(java.lang.Object value)
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 if (cst instanceof Condy) { // ... } else { // throw an exception }
visitLdcInsn
in class MethodVisitor
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)
MethodVisitor
visitIincInsn
in class MethodVisitor
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)
MethodVisitor
visitTableSwitchInsn
in class MethodVisitor
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)
MethodVisitor
visitLookupSwitchInsn
in class MethodVisitor
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(java.lang.String descriptor, int numDimensions)
MethodVisitor
visitMultiANewArrayInsn
in class MethodVisitor
descriptor
- an array type descriptor (see Type
).numDimensions
- the number of dimensions of the array to allocate.public AnnotationVisitor visitInsnAnnotation(int typeRef, TypePath typePath, java.lang.String descriptor, boolean visible)
MethodVisitor
visitInsnAnnotation
in class MethodVisitor
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, java.lang.String type)
MethodVisitor
visitTryCatchBlock
in class MethodVisitor
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).public AnnotationVisitor visitTryCatchAnnotation(int typeRef, TypePath typePath, java.lang.String descriptor, boolean visible)
MethodVisitor
MethodVisitor.visitTryCatchBlock(org.objectweb.asm.Label, org.objectweb.asm.Label, org.objectweb.asm.Label, java.lang.String)
for the annotated exception handler. It can be called several times
for the same exception handler.visitTryCatchAnnotation
in class MethodVisitor
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(java.lang.String name, java.lang.String descriptor, java.lang.String signature, Label start, Label end, int index)
MethodVisitor
visitLocalVariable
in class MethodVisitor
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.public AnnotationVisitor visitLocalVariableAnnotation(int typeRef, TypePath typePath, Label[] start, Label[] end, int[] index, java.lang.String descriptor, boolean visible)
MethodVisitor
visitLocalVariableAnnotation
in class MethodVisitor
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)
MethodVisitor
visitLineNumber
in class MethodVisitor
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.public void visitMaxs(int maxStack, int maxLocals)
MethodVisitor
visitMaxs
in class MethodVisitor
maxStack
- maximum stack size of the method.maxLocals
- maximum number of local variables for the method.public void visitEnd()
MethodVisitor
visitEnd
in class MethodVisitor
private void checkVisitCodeCalled()
visitCode()
method has been called.private void checkVisitMaxsNotCalled()
visitMaxs(int, int)
method has not been called.private void checkVisitEndNotCalled()
visitEnd()
method has not been called.private void checkFrameValue(java.lang.Object value)
value
- the value to be checked.private static void checkOpcodeMethod(int opcode, CheckMethodAdapter.Method method)
opcode
- the opcode to be checked.method
- the expected visit method.private static void checkSignedByte(int value, java.lang.String message)
value
- the value to be checked.message
- the message to use in case of error.private static void checkSignedShort(int value, java.lang.String message)
value
- the value to be checked.message
- the message to use in case of error.private static void checkUnsignedShort(int value, java.lang.String message)
value
- the value to be checked.message
- the message to use in case of error.static void checkConstant(java.lang.Object value)
Integer
, Float
, Long
, Double
or String
value.value
- the value to be checked.private void checkLdcConstant(java.lang.Object value)
value
- the value to be checked.static void checkUnqualifiedName(int version, java.lang.String name, java.lang.String message)
version
- the class version.name
- the string to be checked.message
- the message to use in case of error.static void checkIdentifier(int version, java.lang.String name, int startPos, int endPos, java.lang.String message)
version
- the class version.name
- the string to be checked.startPos
- the index of the first character of the identifier (inclusive).endPos
- the index of the last character of the identifier (exclusive). -1 is equivalent
to name.length() if name is not null.message
- the message to use in case of error.static void checkMethodIdentifier(int version, java.lang.String name, java.lang.String message)
version
- the class version.name
- the string to be checked.message
- the message to use in case of error.static void checkInternalName(int version, java.lang.String name, java.lang.String message)
version
- the class version.name
- the string to be checked.message
- the message to use in case of error.private static void checkInternalClassName(int version, java.lang.String name, java.lang.String message)
version
- the class version.name
- the string to be checked.message
- the message to use in case of error.static void checkDescriptor(int version, java.lang.String descriptor, boolean canBeVoid)
version
- the class version.descriptor
- the string to be checked.canBeVoid
- true if V can be considered valid.private static int checkDescriptor(int version, java.lang.String descriptor, int startPos, boolean canBeVoid)
version
- the class version.descriptor
- the string to be checked.startPos
- the index of the first character of the type descriptor (inclusive).canBeVoid
- whether V can be considered valid.static void checkMethodDescriptor(int version, java.lang.String descriptor)
version
- the class version.descriptor
- the string to be checked.private void checkLabel(Label label, boolean checkVisited, java.lang.String message)
label
- the label to be checked.checkVisited
- whether to check that the label has been visited.message
- the message to use in case of error.