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 | Field and Description |
|---|---|
int |
version
The class version number.
|
api, mv| Modifier | Constructor and Description |
|---|---|
protected |
CheckMethodAdapter(int api,
MethodVisitor mv,
Map<Label,Integer> labels)
Constructs a new
CheckMethodAdapter object. |
|
CheckMethodAdapter(int access,
String name,
String desc,
MethodVisitor cmv,
Map<Label,Integer> labels)
Constructs a new
CheckMethodAdapter object. |
|
CheckMethodAdapter(MethodVisitor mv)
Constructs a new
CheckMethodAdapter object. |
|
CheckMethodAdapter(MethodVisitor mv,
Map<Label,Integer> labels)
Constructs a new
CheckMethodAdapter object. |
| Modifier and Type | Method and Description |
|---|---|
AnnotationVisitor |
visitAnnotation(String desc,
boolean visible)
Visits an annotation of this method.
|
AnnotationVisitor |
visitAnnotationDefault()
Visits the default value of this annotation interface method.
|
void |
visitAttribute(Attribute attr)
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 desc)
Visits a field instruction.
|
void |
visitFrame(int type,
int nLocal,
Object[] local,
int nStack,
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 desc,
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 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 |
visitLineNumber(int line,
Label start)
Visits a line number declaration.
|
void |
visitLocalVariable(String name,
String desc,
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 desc,
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 desc)
Visits a method instruction.
|
void |
visitMultiANewArrayInsn(String desc,
int dims)
Visits a MULTIANEWARRAY instruction.
|
void |
visitParameter(String name,
int access)
Visits a parameter of this method.
|
AnnotationVisitor |
visitParameterAnnotation(int parameter,
String desc,
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 desc,
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 desc,
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.
|
public CheckMethodAdapter(MethodVisitor mv)
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.mv - the method visitor to which this adapter must delegate calls.public CheckMethodAdapter(MethodVisitor mv, Map<Label,Integer> labels)
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.mv - the method visitor to which this adapter must delegate calls.labels - a map of already visited labels (in other methods).protected CheckMethodAdapter(int api,
MethodVisitor mv,
Map<Label,Integer> labels)
CheckMethodAdapter object. This method adapter
will not perform any data flow check (see
CheckMethodAdapter(int,String,String,MethodVisitor,Map)).mv - the method visitor to which this adapter must delegate calls.labels - a map of already visited labels (in other methods).public CheckMethodAdapter(int access,
String name,
String desc,
MethodVisitor cmv,
Map<Label,Integer> labels)
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.access - the method's access flags.name - the method's name.desc - the method's descriptor (see Type).cmv - the method visitor to which this adapter must delegate calls.labels - a map of already visited labels (in other methods).public void visitParameter(String name, int access)
MethodVisitorvisitParameter in class MethodVisitorname - 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(String desc, boolean visible)
MethodVisitorvisitAnnotation in class MethodVisitordesc - the class descriptor of the annotation class.visible - true if the annotation is visible at runtime.public AnnotationVisitor visitTypeAnnotation(int typeRef, TypePath typePath, String desc, boolean visible)
MethodVisitorvisitTypeAnnotation in class MethodVisitortypeRef - a reference to the annotated type. The sort of this type
reference must be METHOD_TYPE_PARAMETER,
METHOD_TYPE_PARAMETER_BOUND,
METHOD_RETURN,
METHOD_RECEIVER,
METHOD_FORMAL_PARAMETER or 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.desc - the class descriptor of the annotation class.visible - true if the annotation is visible at runtime.public AnnotationVisitor visitAnnotationDefault()
MethodVisitorvisitAnnotationDefault in class MethodVisitorpublic AnnotationVisitor visitParameterAnnotation(int parameter, String desc, boolean visible)
MethodVisitorvisitParameterAnnotation in class MethodVisitorparameter - the parameter index.desc - the class descriptor of the annotation class.visible - true if the annotation is visible at runtime.public void visitAttribute(Attribute attr)
MethodVisitorvisitAttribute in class MethodVisitorattr - an attribute.public void visitCode()
MethodVisitorvisitCode in class MethodVisitorpublic void visitFrame(int type,
int nLocal,
Object[] local,
int nStack,
Object[] stack)
MethodVisitorV1_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 MethodVisitortype - 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)
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 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 visitVarInsn(int opcode,
int var)
MethodVisitorvisitVarInsn in class MethodVisitoropcode - 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)
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).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 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 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 visitLabel(Label label)
MethodVisitorvisitLabel in class MethodVisitorlabel - a Label object.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 visitIincInsn(int var,
int increment)
MethodVisitorvisitIincInsn in class MethodVisitorvar - 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)
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 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 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 AnnotationVisitor visitInsnAnnotation(int typeRef, TypePath typePath, String desc, boolean visible)
MethodVisitorvisitInsnAnnotation in class MethodVisitortypeRef - a reference to the annotated type. The sort of this type
reference must be INSTANCEOF,
NEW,
CONSTRUCTOR_REFERENCE, METHOD_REFERENCE, CAST,
CONSTRUCTOR_INVOCATION_TYPE_ARGUMENT,
METHOD_INVOCATION_TYPE_ARGUMENT,
CONSTRUCTOR_REFERENCE_TYPE_ARGUMENT, or
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.desc - 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)
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).public AnnotationVisitor visitTryCatchAnnotation(int typeRef, TypePath typePath, String desc, boolean visible)
MethodVisitorMethodVisitor.visitTryCatchBlock(org.glassfish.hk2.external.org.objectweb.asm.Label, org.glassfish.hk2.external.org.objectweb.asm.Label, org.glassfish.hk2.external.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 MethodVisitortypeRef - a reference to the annotated type. The sort of this type
reference must be 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.desc - the class descriptor of the annotation class.visible - true if the annotation is visible at runtime.public void visitLocalVariable(String name, String desc, String signature, Label start, Label end, int index)
MethodVisitorvisitLocalVariable in class MethodVisitorname - the name of a local variable.desc - 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, String desc, boolean visible)
MethodVisitorvisitLocalVariableAnnotation in class MethodVisitortypeRef - a reference to the annotated type. The sort of this type
reference must be LOCAL_VARIABLE or 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.desc - the class descriptor of the annotation class.visible - true if the annotation is visible at runtime.public void visitLineNumber(int line,
Label start)
MethodVisitorvisitLineNumber in class MethodVisitorline - 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)
MethodVisitorvisitMaxs in class MethodVisitormaxStack - maximum stack size of the method.maxLocals - maximum number of local variables for the method.public void visitEnd()
MethodVisitorvisitEnd in class MethodVisitorCopyright © 2009–2014 Oracle Corporation. All rights reserved.