Package com.mebigfatguy.fbcontrib.detect

Class DubiousSetOfCollections

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
com.mebigfatguy.fbcontrib.detect.DubiousSetOfCollections
All Implemented Interfaces:
edu.umd.cs.findbugs.Detector, edu.umd.cs.findbugs.Priorities, org.apache.bcel.classfile.Visitor
public class DubiousSetOfCollections extends edu.umd.cs.findbugs.BytecodeScanningDetector
looks for uses of sets or keySets of maps that contain other collections. As collection typically implement hashCode, equals and compareTo by iterating the contents of the collection this can be costly from a performance point of view.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private final edu.umd.cs.findbugs.BugReporter
    bugReporter
     
    private static org.apache.bcel.classfile.JavaClass
    collectionCls
     
    private static org.apache.bcel.classfile.JavaClass
    mapCls
     
    private static org.apache.bcel.classfile.JavaClass
    setCls
     
    private edu.umd.cs.findbugs.OpcodeStack
    stack
     

    Fields inherited from class edu.umd.cs.findbugs.visitclass.DismantleBytecode

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

    Fields inherited from interface edu.umd.cs.findbugs.Priorities

    EXP_PRIORITY, HIGH_PRIORITY, IGNORE_PRIORITY, LOW_PRIORITY, NORMAL_PRIORITY

  • Constructor Summary

    Constructors
    Constructor
    Description
    DubiousSetOfCollections(edu.umd.cs.findbugs.BugReporter bugReporter)
    constructs a DSOC detector given the reporter to report bugs on

  • Method Summary

    Modifier and Type
    Method
    Description
    private boolean
    isImplementationOf(String clsName, org.apache.bcel.classfile.JavaClass inf)
    returns whether the class implements the interface
    private boolean
    isImplementationOf(org.apache.bcel.classfile.JavaClass cls, org.apache.bcel.classfile.JavaClass inf)
    returns whether the class implements the interface
    void
    sawOpcode(int seen)
    implements the visitor look for adds to sets or puts to maps where the element to be added is a collection.
    void
    visitClassContext(edu.umd.cs.findbugs.ba.ClassContext clsContext)
    implement the visitor to set up the opcode stack, and make sure that collection, set and map classes could be loaded.
    void
    visitCode(org.apache.bcel.classfile.Code code)
    implements the visitor to reset the opcode stack

    Methods inherited from class edu.umd.cs.findbugs.BytecodeScanningDetector

    getClassContext, report, shouldVisitCode

    Methods inherited from class edu.umd.cs.findbugs.visitclass.DismantleBytecode

    afterOpcode, areOppositeBranches, atCatchBlock, beforeOpcode, 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 edu.umd.cs.findbugs.visitclass.AnnotationVisitor

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

    Methods inherited from class edu.umd.cs.findbugs.visitclass.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, visitAfter, visitAnnotationDefault, visitAnnotationEntry, visitBootstrapMethods, visitConstantInvokeDynamic, visitConstantMethodHandle, visitConstantMethodType, visitConstantModule, visitConstantPackage, visitConstantPool, visitEnclosingMethod, visitingField, visitingMethod, visitInnerClasses, visitJavaClass, visitLineNumberTable, visitLocalVariableTable, visitMethodParameters, visitParameterAnnotationEntry, visitStackMap, visitStackMapEntry

    Methods inherited from class edu.umd.cs.findbugs.visitclass.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, 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 java.lang.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

    • collectionCls

      private static org.apache.bcel.classfile.JavaClass collectionCls

    • setCls

      private static org.apache.bcel.classfile.JavaClass setCls

    • mapCls

      private static org.apache.bcel.classfile.JavaClass mapCls

    • bugReporter

      private final edu.umd.cs.findbugs.BugReporter bugReporter

    • stack

      private edu.umd.cs.findbugs.OpcodeStack stack

  • Constructor Details

    • DubiousSetOfCollections

      public DubiousSetOfCollections(edu.umd.cs.findbugs.BugReporter bugReporter)
      constructs a DSOC detector given the reporter to report bugs on
      Parameters:
      bugReporter - the sync of bug reports

  • Method Details

    • visitClassContext

      public void visitClassContext(edu.umd.cs.findbugs.ba.ClassContext clsContext)
      implement the visitor to set up the opcode stack, and make sure that collection, set and map classes could be loaded.
      Specified by:
      visitClassContext in interface edu.umd.cs.findbugs.Detector
      Overrides:
      visitClassContext in class edu.umd.cs.findbugs.BytecodeScanningDetector
      Parameters:
      clsContext - the context object of the currently parsed class

    • visitCode

      public void visitCode(org.apache.bcel.classfile.Code code)
      implements the visitor to reset the opcode stack
      Specified by:
      visitCode in interface org.apache.bcel.classfile.Visitor
      Overrides:
      visitCode in class edu.umd.cs.findbugs.visitclass.PreorderVisitor
      Parameters:
      code - the context object of the currently parsed code block

    • sawOpcode

      public void sawOpcode(int seen)
      implements the visitor look for adds to sets or puts to maps where the element to be added is a collection.
      Overrides:
      sawOpcode in class edu.umd.cs.findbugs.visitclass.DismantleBytecode
      Parameters:
      seen - the opcode of the currently parsed instruction

    • isImplementationOf

      private boolean isImplementationOf(@SlashedClassName String clsName, org.apache.bcel.classfile.JavaClass inf)
      returns whether the class implements the interface
      Parameters:
      clsName - the name of the class
      inf - the interface to check
      Returns:
      if the class implements the interface

    • isImplementationOf

      private boolean isImplementationOf(org.apache.bcel.classfile.JavaClass cls, org.apache.bcel.classfile.JavaClass inf)
      returns whether the class implements the interface
      Parameters:
      cls - the class
      inf - the interface to check
      Returns:
      if the class implements the interface