Package com.mebigfatguy.fbcontrib.detect

Class UseCharacterParameterizedMethod

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.UseCharacterParameterizedMethod
All Implemented Interfaces:
edu.umd.cs.findbugs.Detector, edu.umd.cs.findbugs.Priorities, org.apache.bcel.classfile.Visitor
@CustomUserValue public class UseCharacterParameterizedMethod extends edu.umd.cs.findbugs.BytecodeScanningDetector
looks for methods that pass single character string Const as parameters to methods that alternatively have an overridden method that accepts a character instead. It is more performant for the method to handle a single character than a String.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    private static class 
    UseCharacterParameterizedMethod.IntPair
     
    (package private) static enum 
    UseCharacterParameterizedMethod.UCPMUserValue
    holds a user value for a StringBuilder or StringBuffer on the stack that is an online append ideally there would be an UNKNOWN option, rather than null, but findbugs seems to have a nasty bug with static fields holding onto uservalues across detectors

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private final edu.umd.cs.findbugs.BugReporter
    bugReporter
     
    private static final Map<FQMethod,Object>
    characterMethods
     
    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
    UseCharacterParameterizedMethod(edu.umd.cs.findbugs.BugReporter bugReporter)
    constructs a UCPM detector given the reporter to report bugs on

  • Method Summary

    Modifier and Type
    Method
    Description
    private UseCharacterParameterizedMethod.UCPMUserValue
    callHasInline(int seen)
    checks to see if the current opcode is an INVOKEVIRTUAL call that has a INLINE userValue on the caller and a return value.
    private boolean
    checkDoubleParamMethod(UseCharacterParameterizedMethod.IntPair posObject)
     
    private boolean
    checkSingleParamMethod(int paramPos)
     
    private boolean
    isInlineAppend(FQMethod fqm)
    looks to see if we are in a inline string append like "(" + a + ")";
    private boolean
    prescreen(org.apache.bcel.classfile.Method obj)
    looks for methods that contain a LDC opcode
    private void
    reportBug()
     
    void
    sawOpcode(int seen)
    implements the visitor to look for method calls that pass a constant string as a parameter when the string is only one character long, and there is an alternate method passing a character.
    void
    visitClassContext(edu.umd.cs.findbugs.ba.ClassContext context)
    overrides the visitor to create and clear the opcode stack
    void
    visitCode(org.apache.bcel.classfile.Code obj)
    prescreens the method, and reset the 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

    • characterMethods

      private static final Map<FQMethod,Object> characterMethods

    • bugReporter

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

    • stack

      private edu.umd.cs.findbugs.OpcodeStack stack

  • Constructor Details

    • UseCharacterParameterizedMethod

      public UseCharacterParameterizedMethod(edu.umd.cs.findbugs.BugReporter bugReporter)
      constructs a UCPM 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 context)
      overrides the visitor to create and clear the opcode stack
      Specified by:
      visitClassContext in interface edu.umd.cs.findbugs.Detector
      Overrides:
      visitClassContext in class edu.umd.cs.findbugs.BytecodeScanningDetector
      Parameters:
      context - the context object for the currently parsed class

    • prescreen

      private boolean prescreen(org.apache.bcel.classfile.Method obj)
      looks for methods that contain a LDC opcode
      Parameters:
      obj - the context object of the current method
      Returns:
      if the class uses LDC instructions

    • visitCode

      public void visitCode(org.apache.bcel.classfile.Code obj)
      prescreens the method, and reset the stack
      Specified by:
      visitCode in interface org.apache.bcel.classfile.Visitor
      Overrides:
      visitCode in class edu.umd.cs.findbugs.visitclass.PreorderVisitor
      Parameters:
      obj - the context object for the currently parsed method

    • sawOpcode

      public void sawOpcode(int seen)
      implements the visitor to look for method calls that pass a constant string as a parameter when the string is only one character long, and there is an alternate method passing a character.
      Overrides:
      sawOpcode in class edu.umd.cs.findbugs.visitclass.DismantleBytecode

    • reportBug

      private void reportBug()

    • checkDoubleParamMethod

      private boolean checkDoubleParamMethod(UseCharacterParameterizedMethod.IntPair posObject)

    • checkSingleParamMethod

      private boolean checkSingleParamMethod(int paramPos)

    • isInlineAppend

      private boolean isInlineAppend(FQMethod fqm)
      looks to see if we are in a inline string append like "(" + a + ")";
      Parameters:
      fqm - the method that is being called
      Returns:
      whether we are in an inline string append

    • callHasInline

      @Nullable private UseCharacterParameterizedMethod.UCPMUserValue callHasInline(int seen)
      checks to see if the current opcode is an INVOKEVIRTUAL call that has a INLINE userValue on the caller and a return value. If so, return it.
      Parameters:
      seen - the currently parsed opcode
      Returns:
      whether the caller has an INLINE tag on it