Class FindOverridableMethodCall

java.lang.Object

edu.umd.cs.findbugs.visitclass.BetterVisitor

edu.umd.cs.findbugs.visitclass.PreorderVisitor

edu.umd.cs.findbugs.visitclass.AnnotationVisitor

edu.umd.cs.findbugs.visitclass.DismantleBytecode

edu.umd.cs.findbugs.BytecodeScanningDetector

edu.umd.cs.findbugs.bcel.OpcodeStackDetector

edu.umd.cs.findbugs.detect.FindOverridableMethodCall

All Implemented Interfaces:

Detector, Priorities, org.apache.bcel.classfile.Visitor

public class FindOverridableMethodCall
extends OpcodeStackDetector

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	FindOverridableMethodCall.CallerInfo

Nested classes/interfaces inherited from class OpcodeStackDetector

OpcodeStackDetector.WithCustomJumpInfo

Field Summary

Fields

Modifier and Type	Field	Description
private final BugAccumulator	bugAccumulator
private final MultiMap<XMethod,XMethod>	calleeToCallerMap
private final Map<XMethod, FindOverridableMethodCall.CallerInfo>	callerClones
private final Map<XMethod, FindOverridableMethodCall.CallerInfo>	callerConstructors
private final Map<XMethod, FindOverridableMethodCall.CallerInfo>	callerReadObjects
private final MultiMap<XMethod,XMethod>	callerToCalleeMap
private final Map<XMethod,XMethod>	callsToOverridable
private static final String	CLONE_BUG
private static final String	CONSTRUCTOR_BUG
private static final String	READ_OBJECT_BUG
private final MultiMap<Integer,XMethod>	refCalleeToCallerMap
private final Map<Integer, FindOverridableMethodCall.CallerInfo>	refCallerClones
private final Map<Integer, FindOverridableMethodCall.CallerInfo>	refCallerConstructors
private final Map<Integer, FindOverridableMethodCall.CallerInfo>	refCallerReadObjects

Fields inherited from class OpcodeStackDetector

stack

Fields inherited from class DismantleBytecode

codeBytes, lineNumberTable, M_BR, M_CP, M_INT, M_PAD, M_R, M_UINT

Fields inherited from interface Priorities

EXP_PRIORITY, HIGH_PRIORITY, IGNORE_PRIORITY, LOW_PRIORITY, NORMAL_PRIORITY

Constructor Summary

Constructors

Constructor	Description
FindOverridableMethodCall(BugReporter bugReporter)

Method Summary

Modifier and Type	Method	Description
private void	checkAndRecordCallBetweenNonOverridableMethods(XMethod caller, XMethod callee)
private void	checkAndRecordCallFromClone(XMethod clone, XMethod callee, SourceLineAnnotation sourceLine)
private void	checkAndRecordCallFromConstructor(XMethod constructor, XMethod callee, SourceLineAnnotation sourceLine)
private void	checkAndRecordCallFromReadObject(XMethod readObject, XMethod callee, SourceLineAnnotation sourceLine)
private void	checkAndRecordCallToOverridable(XMethod caller, XMethod overridable)
(package private) boolean	checkAndRecordDirectCase(XMethod caller, XMethod method, String bugType, int priority, SourceLineAnnotation sourceLine)
private FindOverridableMethodCall.CallerInfo	getIndirectCallerClone(XMethod callee)
private FindOverridableMethodCall.CallerInfo	getIndirectCallerConstructor(XMethod callee)
private FindOverridableMethodCall.CallerInfo	getIndirectCallerReadObject(XMethod callee)
private FindOverridableMethodCall.CallerInfo	getIndirectCallerSpecial(XMethod callee, Map<XMethod, FindOverridableMethodCall.CallerInfo> map)
private FindOverridableMethodCall.CallerInfo	getIndirectCallerSpecial(XMethod callee, Map<XMethod, FindOverridableMethodCall.CallerInfo> map, Set<XMethod> visited)
private XMethod	getIndirectlyCalledOverridable(XMethod caller)
private XMethod	getIndirectlyCalledOverridable(XMethod caller, Set<XMethod> visited)
private boolean	isCurrentMethodReadObject()
private boolean	isSelfCall(XMethod method)
void	sawOpcode(int seen)	By default, this method will not be called when stack is TOP.
private XMethod	superClone(XClass clazz)
void	visit(org.apache.bcel.classfile.JavaClass obj)
void	visitAfter(org.apache.bcel.classfile.JavaClass obj)
void	visitBootstrapMethods(org.apache.bcel.classfile.BootstrapMethods obj)

Methods inherited from class OpcodeStackDetector

afterOpcode, beforeOpcode, getStack, isUsingCustomUserValue, visitCode

Methods inherited from class BytecodeScanningDetector

getClassContext, report, shouldVisitCode, visitClassContext

Methods inherited from class DismantleBytecode

areOppositeBranches, atCatchBlock, getBranchFallThrough, getBranchOffset, getBranchTarget, getClassConstantOperand, getClassDescriptorOperand, getCodeByte, getConstantRefOperand, getDefaultSwitchOffset, getDottedClassConstantOperand, getFieldDescriptorOperand, getIntConstant, getLongConstant, getMaxPC, getMethodDescriptorOperand, getNameConstantOperand, getNextCodeByte, getNextOpcode, getNextPC, getOpcode, getPC, getPrevOpcode, getRefConstantOperand, getRefFieldIsStatic, getRegisterOperand, getSigConstantOperand, getStringConstantOperand, getSwitchLabels, getSwitchOffsets, getXClassOperand, getXFieldOperand, getXMethodOperand, isBranch, isMethodCall, isRegisterLoad, isRegisterStore, isRegisterStore, isReturn, isShift, isSwitch, isWideOpcode, printOpCode, sawBranchTo, sawClass, sawDouble, sawField, sawFloat, sawIMethod, sawInt, sawLong, sawMethod, sawRegister, sawString, visit

Methods inherited from class AnnotationVisitor

getAnnotationParameterAsEnum, getAnnotationParameterAsString, getAnnotationParameterAsStringArray, visitAnnotation, visitAnnotation, visitParameterAnnotation, visitParameterAnnotation, visitSyntheticParameterAnnotation

Methods inherited from class PreorderVisitor

amVisitingMainMethod, asUnsignedByte, doVisitMethod, getClassDescriptor, getClassName, getCode, getConstantPool, getDottedClassName, getDottedFieldSig, getDottedMethodSig, getDottedSuperclassName, getField, getFieldDescriptor, getFieldIsStatic, getFieldName, getFieldSig, getFullyQualifiedFieldName, getFullyQualifiedMethodName, getMethod, getMethodDescriptor, getMethodName, getMethodSig, getMethodVisitOrder, getNumberArguments, getNumberMethodArguments, getPackageName, getSizeOfSurroundingTryBlock, getSizeOfSurroundingTryBlock, getSourceFile, getStringFromIndex, getSuperclassName, getSurroundingCaughtExceptions, getSurroundingCaughtExceptions, getSurroundingCaughtExceptionTypes, getSurroundingTryBlock, getSurroundingTryBlock, getThisClass, getXClass, getXField, getXMethod, hasInterestingClass, hasInterestingMethod, isVisitMethodsInCallOrder, setupVisitorForClass, setVisitMethodsInCallOrder, shouldVisit, toString, visitAfter, visitAnnotationDefault, visitAnnotationEntry, visitConstantInvokeDynamic, visitConstantMethodHandle, visitConstantMethodType, visitConstantModule, visitConstantPackage, visitConstantPool, visitEnclosingMethod, visitingField, visitingMethod, visitInnerClasses, visitJavaClass, visitLineNumberTable, visitLocalVariableTable, visitMethodParameters, visitParameterAnnotationEntry, visitStackMap, visitStackMapEntry

Methods inherited from class BetterVisitor

clone, report, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visitCodeException, visitConstantClass, visitConstantDouble, visitConstantFieldref, visitConstantFloat, visitConstantInteger, visitConstantInterfaceMethodref, visitConstantLong, visitConstantMethodref, visitConstantNameAndType, visitConstantString, visitConstantUtf8, visitConstantValue, visitDeprecated, visitExceptionTable, visitField, visitInnerClass, visitLineNumber, visitLocalVariable, visitLocalVariableTypeTable, visitMethod, visitSignature, visitSourceFile, visitSynthetic, visitUnknown

Methods inherited from class Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.bcel.classfile.Visitor

visitConstantDynamic, visitMethodParameter, visitModule, visitModuleExports, visitModuleMainClass, visitModuleOpens, visitModulePackages, visitModuleProvides, visitModuleRequires, visitNestHost, visitNestMembers, visitRecord, visitRecordComponent, visitStackMapType

Field Details

callerConstructors

private final Map<XMethod, FindOverridableMethodCall.CallerInfo> callerConstructors

callerClones

private final Map<XMethod, FindOverridableMethodCall.CallerInfo> callerClones

callerReadObjects

private final Map<XMethod, FindOverridableMethodCall.CallerInfo> callerReadObjects

callsToOverridable

private final Map<XMethod,XMethod> callsToOverridable

callerToCalleeMap

private final MultiMap<XMethod,XMethod> callerToCalleeMap

calleeToCallerMap

private final MultiMap<XMethod,XMethod> calleeToCallerMap

refCallerConstructors

private final Map<Integer, FindOverridableMethodCall.CallerInfo> refCallerConstructors

refCallerClones

private final Map<Integer, FindOverridableMethodCall.CallerInfo> refCallerClones

refCallerReadObjects

private final Map<Integer, FindOverridableMethodCall.CallerInfo> refCallerReadObjects

refCalleeToCallerMap

private final MultiMap<Integer,XMethod> refCalleeToCallerMap

CONSTRUCTOR_BUG

private static final String CONSTRUCTOR_BUG

See Also:

• Constant Field Values

CLONE_BUG

private static final String CLONE_BUG

See Also:

• Constant Field Values

READ_OBJECT_BUG

private static final String READ_OBJECT_BUG

See Also:

• Constant Field Values

bugAccumulator

private final BugAccumulator bugAccumulator

Constructor Details

FindOverridableMethodCall

public FindOverridableMethodCall(BugReporter bugReporter)

Method Details

visit

public void visit(org.apache.bcel.classfile.JavaClass obj)

Overrides:

visit in class BetterVisitor

visitBootstrapMethods

public void visitBootstrapMethods(org.apache.bcel.classfile.BootstrapMethods obj)

Specified by:

visitBootstrapMethods in interface org.apache.bcel.classfile.Visitor

Overrides:

visitBootstrapMethods in class PreorderVisitor

visitAfter

public void visitAfter(org.apache.bcel.classfile.JavaClass obj)

Overrides:

visitAfter in class PreorderVisitor

sawOpcode

public void sawOpcode(int seen)

Description copied from class: OpcodeStackDetector

By default, this method will not be called when stack is TOP. To change this behavior, override #beforeOpcode(int) and change to return true even if stack is TOP.

see Using FindBugs for Research to learn lattice and what TOP means.

Specified by:

sawOpcode in class OpcodeStackDetector

See Also:

• OpcodeStackDetector.beforeOpcode(int)

isCurrentMethodReadObject

private boolean isCurrentMethodReadObject()

superClone

private XMethod superClone(XClass clazz)

checkAndRecordDirectCase

boolean checkAndRecordDirectCase(XMethod caller,
 XMethod method,
 String bugType,
 int priority,
 SourceLineAnnotation sourceLine)

isSelfCall

private boolean isSelfCall(XMethod method)

checkAndRecordCallFromConstructor

private void checkAndRecordCallFromConstructor(XMethod constructor,
 XMethod callee,
 SourceLineAnnotation sourceLine)

checkAndRecordCallFromClone

private void checkAndRecordCallFromClone(XMethod clone,
 XMethod callee,
 SourceLineAnnotation sourceLine)

checkAndRecordCallFromReadObject

private void checkAndRecordCallFromReadObject(XMethod readObject,
 XMethod callee,
 SourceLineAnnotation sourceLine)

checkAndRecordCallToOverridable

private void checkAndRecordCallToOverridable(XMethod caller,
 XMethod overridable)

checkAndRecordCallBetweenNonOverridableMethods

private void checkAndRecordCallBetweenNonOverridableMethods(XMethod caller,
 XMethod callee)

getIndirectlyCalledOverridable

private XMethod getIndirectlyCalledOverridable(XMethod caller)

getIndirectlyCalledOverridable

private XMethod getIndirectlyCalledOverridable(XMethod caller,
 Set<XMethod> visited)

getIndirectCallerConstructor

private FindOverridableMethodCall.CallerInfo getIndirectCallerConstructor(XMethod callee)

getIndirectCallerClone

private FindOverridableMethodCall.CallerInfo getIndirectCallerClone(XMethod callee)

getIndirectCallerReadObject

private FindOverridableMethodCall.CallerInfo getIndirectCallerReadObject(XMethod callee)

getIndirectCallerSpecial

private FindOverridableMethodCall.CallerInfo getIndirectCallerSpecial(XMethod callee,
 Map<XMethod, FindOverridableMethodCall.CallerInfo> map)

getIndirectCallerSpecial

private FindOverridableMethodCall.CallerInfo getIndirectCallerSpecial(XMethod callee,
 Map<XMethod, FindOverridableMethodCall.CallerInfo> map,
 Set<XMethod> visited)