Class BugInstance

java.lang.Object
edu.umd.cs.findbugs.BugInstance
All Implemented Interfaces:
XMLWriteable, Cloneable, Comparable<BugInstance>
public class BugInstance extends Object implements Comparable<BugInstance>, XMLWriteable, Cloneable

An instance of a bug pattern. A BugInstance consists of several parts:

  • the type, which is a string indicating what kind of bug it is; used as a key for the FindBugsMessages resource bundle
  • the priority; how likely this instance is to actually be a bug
  • a list of annotations

The annotations describe classes, methods, fields, source locations, and other relevant context information about the bug instance. Every BugInstance must have at least one ClassAnnotation, which describes the class in which the instance was found. This is the "primary class annotation".

BugInstance objects are built up by calling a string of add methods. (These methods all "return this", so they can be chained). Some of the add methods are specialized to get information automatically from a BetterVisitor or DismantleBytecode object.

See Also:

  • Field Details

    • LOG

      private static final org.slf4j.Logger LOG

    • type

      private final String type

    • priority

      private int priority

    • annotationList

      private final List<BugAnnotation> annotationList

    • cachedHashCode

      private int cachedHashCode

    • propertyListHead

      private BugProperty propertyListHead

    • propertyListTail

      private BugProperty propertyListTail

    • oldInstanceHash

      private String oldInstanceHash

    • instanceHash

      private String instanceHash

    • instanceOccurrenceNum

      private int instanceOccurrenceNum

    • instanceOccurrenceMax

      private int instanceOccurrenceMax

    • detectorFactory

      private @Nullable DetectorFactory detectorFactory

    • firstVersion

      private long firstVersion

    • lastVersion

      private long lastVersion

    • introducedByChangeOfExistingClass

      private boolean introducedByChangeOfExistingClass

    • removedByChangeOfPersistingClass

      private boolean removedByChangeOfPersistingClass

    • INVALID_HASH_CODE

      private static final int INVALID_HASH_CODE
      This value is used to indicate that the cached hashcode is invalid, and should be recomputed.
      See Also:

    • ELEMENT_NAME

      private static final String ELEMENT_NAME
      See Also:

    • adjustExperimental

      private static boolean adjustExperimental
      This value is used to indicate whether BugInstances should be reprioritized very low, when the BugPattern is marked as experimental

    • missingBugTypes

      private static final Set<String> missingBugTypes

  • Constructor Details

    • BugInstance

      public BugInstance(String type, int priority)
      Constructor.
      Parameters:
      type - the bug type
      priority - the bug priority

    • BugInstance

      public BugInstance(Detector detector, String type, int priority)
      Create a new BugInstance. This is the constructor that should be used by Detectors.
      Parameters:
      detector - the Detector that is reporting the BugInstance
      type - the bug type
      priority - the bug priority

    • BugInstance

      public BugInstance(Detector2 detector, String type, int priority)
      Create a new BugInstance. This is the constructor that should be used by Detectors.
      Parameters:
      detector - the Detector2 that is reporting the BugInstance
      type - the bug type
      priority - the bug priority

  • Method Details

    • firstSeenXMLFormat

      public static DateFormat firstSeenXMLFormat()

    • boundPriority

      private void boundPriority()

    • clone

      public Object clone()
      Overrides:
      clone in class Object

    • adjustForDetector

      @Deprecated(forRemoval=true) public void adjustForDetector(String detectorName)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • rememberDetectorFactory

      public void rememberDetectorFactory(String detectorName)
      Parameters:
      detectorName -

    • setAdjustExperimental

      public static void setAdjustExperimental(boolean adjust)

    • getType

      public String getType()
      Get the bug pattern name (e.g., IL_INFINITE_RECURSIVE_LOOP)

    • getBugPattern

      public @NonNull BugPattern getBugPattern()
      Get the BugPattern.

    • getPriority

      public int getPriority()
      Get the bug priority.

    • getBugRank

      public int getBugRank()

    • getBugRankCategory

      public BugRankCategory getBugRankCategory()

    • getPriorityTypeString

      public String getPriorityTypeString()
      Get a string describing the bug priority and type. e.g. "High Priority Correctness"
      Returns:
      a string describing the bug priority and type

    • getPriorityTypeAbbreviation

      public String getPriorityTypeAbbreviation()

    • getCategoryAbbrev

      public String getCategoryAbbrev()

    • getPriorityString

      public String getPriorityString()

    • getPriorityAbbreviation

      public String getPriorityAbbreviation()

    • setPriority

      public void setPriority(int p)
      Set the bug priority.

    • boundedPriority

      public static int boundedPriority(int p)

    • raisePriority

      public void raisePriority()

    • lowerPriority

      public void lowerPriority()

    • lowerPriorityALot

      public void lowerPriorityALot()

    • isExperimental

      public boolean isExperimental()
      Is this bug instance the result of an experimental detector?

    • getPrimaryClass

      public ClassAnnotation getPrimaryClass()
      Get the primary class annotation, which indicates where the bug occurs.

    • getPrimaryType

      public @Nullable TypeAnnotation getPrimaryType()
      Get the primary type annotation, which indicates where the bug occurs.

    • getPrimaryMethod

      public @Nullable MethodAnnotation getPrimaryMethod()
      Get the primary method annotation, which indicates where the bug occurs.

    • getPrimaryField

      public @Nullable FieldAnnotation getPrimaryField()
      Get the primary field annotation, which indicates where the bug occurs.

    • lowerPriorityIfDeprecated

      public @NonNull BugInstance lowerPriorityIfDeprecated()

    • findPrimaryAnnotationOfType

      private <T extends BugAnnotation> @Nullable T findPrimaryAnnotationOfType(Class<T> cls)
      Find the first BugAnnotation in the list of annotations that is the same type or a subtype as the given Class parameter.
      Parameters:
      cls - the Class parameter
      Returns:
      the first matching BugAnnotation of the given type, or null if there is no such BugAnnotation

    • getPrimaryLocalVariableAnnotation

      public LocalVariableAnnotation getPrimaryLocalVariableAnnotation()

    • getPrimarySourceLineAnnotation

      public @NonNull SourceLineAnnotation getPrimarySourceLineAnnotation()
      Get the primary source line annotation. There is guaranteed to be one (unless some Detector constructed an invalid BugInstance).
      Returns:
      the source line annotation

    • getAnotherInstanceSourceLineAnnotations

      public Collection<SourceLineAnnotation> getAnotherInstanceSourceLineAnnotations()

    • getInstanceKey

      public String getInstanceKey()

    • getInstanceKeyNew

      private String getInstanceKeyNew()

    • inspectPackageMemberSourceLines

      private SourceLineAnnotation inspectPackageMemberSourceLines(PackageMemberAnnotation packageMember)
      If given PackageMemberAnnotation is non-null, return its SourceLineAnnotation.
      Parameters:
      packageMember - a PackageMemberAnnotation
      Returns:
      the PackageMemberAnnotation's SourceLineAnnotation, or null if there is no SourceLineAnnotation

    • annotationIterator

      public Iterator<BugAnnotation> annotationIterator()
      Get an Iterator over all bug annotations.

    • getAnnotations

      public List<BugAnnotation> getAnnotations()
      Get an Iterator over all bug annotations.

    • getAnnotationWithRole

      public <A extends BugAnnotation> @Nullable A getAnnotationWithRole(Class<A> c, String role)
      Get the first bug annotation with the specified class and role; return null if no such annotation exists;

    • getAbbrev

      public String getAbbrev()
      Get the abbreviation of this bug instance's BugPattern. This is the same abbreviation used by the BugCode which the BugPattern is a particular species of.

    • getProperty

      public String getProperty(String name)
      Get value of given property.
      Parameters:
      name - name of the property to get
      Returns:
      the value of the named property, or null if the property has not been set

    • getProperty

      public String getProperty(String name, String defaultValue)
      Get value of given property, returning given default value if the property has not been set.
      Parameters:
      name - name of the property to get
      defaultValue - default value to return if property is not set
      Returns:
      the value of the named property, or the default value if the property has not been set

    • propertyIterator

      public Iterator<BugProperty> propertyIterator()
      Get an Iterator over the properties defined in this BugInstance.
      Returns:
      Iterator over properties

    • setProperty

      public @NonNull BugInstance setProperty(String name, String value)
      Set value of given property.
      Parameters:
      name - name of the property to set
      value - the value of the property
      Returns:
      this object, so calls can be chained

    • lookupProperty

      public BugProperty lookupProperty(String name)
      Look up a property by name.
      Parameters:
      name - name of the property to look for
      Returns:
      the BugProperty with the given name, or null if the property has not been set

    • deleteProperty

      public boolean deleteProperty(String name)
      Delete property with given name.
      Parameters:
      name - name of the property to delete
      Returns:
      true if a property with that name was deleted, or false if there is no such property

    • addProperty

      private void addProperty(BugProperty prop)

    • addAnnotations

      public @NonNull BugInstance addAnnotations(Collection<? extends BugAnnotation> annotationCollection)
      Add a Collection of BugAnnotations.
      Parameters:
      annotationCollection - Collection of BugAnnotations

    • addClassAndMethod

      public @NonNull BugInstance addClassAndMethod(MethodDescriptor methodDescriptor)

    • addClassAndMethod

      public BugInstance addClassAndMethod(XMethod xMethod)

    • addClassAndMethod

      public @NonNull BugInstance addClassAndMethod(PreorderVisitor visitor)
      Add a class annotation and a method annotation for the class and method which the given visitor is currently visiting.
      Parameters:
      visitor - the BetterVisitor
      Returns:
      this object

    • foundInAutogeneratedMethod

      private void foundInAutogeneratedMethod()

    • addClassAndMethod

      public @NonNull BugInstance addClassAndMethod(MethodAnnotation methodAnnotation)
      Add class and method annotations for given method.
      Parameters:
      methodAnnotation - the method
      Returns:
      this object

    • addClassAndMethod

      public @NonNull BugInstance addClassAndMethod(org.apache.bcel.generic.MethodGen methodGen, String sourceFile)
      Add class and method annotations for given method.
      Parameters:
      methodGen - the method
      sourceFile - source file the method is defined in
      Returns:
      this object

    • addClassAndMethod

      public @NonNull BugInstance addClassAndMethod(org.apache.bcel.classfile.JavaClass javaClass, org.apache.bcel.classfile.Method method)
      Add class and method annotations for given class and method.
      Parameters:
      javaClass - the class
      method - the method
      Returns:
      this object

    • addClass

      public @NonNull BugInstance addClass(String className, String sourceFileName)
      Add a class annotation. If this is the first class annotation added, it becomes the primary class annotation.
      Parameters:
      className - the name of the class
      sourceFileName - the source file of the class
      Returns:
      this object

    • addClass

      public @NonNull BugInstance addClass(@SlashedClassName(when=UNKNOWN) String className)
      Add a class annotation. If this is the first class annotation added, it becomes the primary class annotation.
      Parameters:
      className - the name of the class
      Returns:
      this object

    • addClass

      public @NonNull BugInstance addClass(org.objectweb.asm.tree.ClassNode classNode)
      Add a class annotation for the classNode.
      Parameters:
      classNode - the ASM visitor
      Returns:
      this object

    • addClass

      public @NonNull BugInstance addClass(ClassDescriptor classDescriptor)
      Add a class annotation. If this is the first class annotation added, it becomes the primary class annotation.
      Parameters:
      classDescriptor - the class to add
      Returns:
      this object

    • addClass

      public @NonNull BugInstance addClass(org.apache.bcel.classfile.JavaClass jclass)
      Add a class annotation. If this is the first class annotation added, it becomes the primary class annotation.
      Parameters:
      jclass - the JavaClass object for the class
      Returns:
      this object

    • addClass

      public @NonNull BugInstance addClass(PreorderVisitor visitor)
      Add a class annotation for the class that the visitor is currently visiting.
      Parameters:
      visitor - the BetterVisitor
      Returns:
      this object

    • addSuperclass

      public @NonNull BugInstance addSuperclass(PreorderVisitor visitor)
      Add a class annotation for the superclass of the class the visitor is currently visiting.
      Parameters:
      visitor - the BetterVisitor
      Returns:
      this object

    • addType

      public @NonNull BugInstance addType(String typeDescriptor)
      Add a type annotation. Handy for referring to array types.

      For information on type descriptors,
      see TypeDescriptors.

      Parameters:
      typeDescriptor - a jvm type descriptor, such as "[I"
      Returns:
      this object

    • addType

      public @NonNull BugInstance addType(org.apache.bcel.generic.Type type)

    • addFoundAndExpectedType

      public @NonNull BugInstance addFoundAndExpectedType(org.apache.bcel.generic.Type foundType, org.apache.bcel.generic.Type expectedType)

    • addFoundAndExpectedType

      public @NonNull BugInstance addFoundAndExpectedType(String foundType, String expectedType)

    • addEqualsMethodUsed

      public @NonNull BugInstance addEqualsMethodUsed(ClassDescriptor expectedClass)

    • addEqualsMethodUsed

      public @NonNull BugInstance addEqualsMethodUsed(@Nullable Collection<XMethod> equalsMethods)

    • addTypeOfNamedClass

      public @NonNull BugInstance addTypeOfNamedClass(@DottedClassName String typeName)

    • addType

      public @NonNull BugInstance addType(ClassDescriptor c)

    • addField

      public @NonNull BugInstance addField(@DottedClassName String className, String fieldName, String fieldSig, boolean isStatic)
      Add a field annotation.
      Parameters:
      className - the dotted name of the class containing the field
      fieldName - the name of the field
      fieldSig - type signature of the field
      isStatic - whether the field is static
      Returns:
      this object

    • addField

      public @NonNull BugInstance addField(@DottedClassName String className, String fieldName, String fieldSig, int accessFlags)
      Add a field annotation.
      Parameters:
      className - the dotted name of the class containing the field
      fieldName - the name of the field
      fieldSig - type signature of the field
      accessFlags - access flags for the field
      Returns:
      this object

    • addField

      public @NonNull BugInstance addField(PreorderVisitor visitor)

    • addField

      public @NonNull BugInstance addField(FieldAnnotation fieldAnnotation)
      Add a field annotation
      Parameters:
      fieldAnnotation - the field annotation
      Returns:
      this object

    • addField

      public @NonNull BugInstance addField(FieldVariable field)
      Add a field annotation for a FieldVariable matched in a ByteCodePattern.
      Parameters:
      field - the FieldVariable
      Returns:
      this object

    • addOptionalField

      public @NonNull BugInstance addOptionalField(@Nullable XField xfield)
      Add a field annotation for an XField.
      Parameters:
      xfield - the XField
      Returns:
      this object

    • addField

      public @NonNull BugInstance addField(XField xfield)
      Add a field annotation for an XField.
      Parameters:
      xfield - the XField
      Returns:
      this object

    • addField

      public @NonNull BugInstance addField(FieldDescriptor fieldDescriptor)
      Add a field annotation for a FieldDescriptor.
      Parameters:
      fieldDescriptor - the FieldDescriptor
      Returns:
      this object

    • addReferencedField

      public @NonNull BugInstance addReferencedField(DismantleBytecode visitor)
      Add a field annotation for the field which has just been accessed by the method currently being visited by given visitor. Assumes that a getfield/putfield or getstatic/putstatic has just been seen.
      Parameters:
      visitor - the DismantleBytecode object
      Returns:
      this object

    • addReferencedField

      public @NonNull BugInstance addReferencedField(FieldAnnotation fa)
      Add a field annotation for the field referenced by the FieldAnnotation parameter

    • addVisitedField

      public @NonNull BugInstance addVisitedField(PreorderVisitor visitor)
      Add a field annotation for the field which is being visited by given visitor.
      Parameters:
      visitor - the visitor
      Returns:
      this object

    • addOptionalLocalVariable

      public @NonNull BugInstance addOptionalLocalVariable(DismantleBytecode dbc, OpcodeStack.Item item)
      Local variable adders

    • addMethod

      public @NonNull BugInstance addMethod(String className, String methodName, String methodSig, boolean isStatic)
      Add a method annotation. If this is the first method annotation added, it becomes the primary method annotation.
      Parameters:
      className - name of the class containing the method
      methodName - name of the method
      methodSig - type signature of the method
      isStatic - true if the method is static, false otherwise
      Returns:
      this object

    • addMethod

      public @NonNull BugInstance addMethod(@SlashedClassName String className, String methodName, String methodSig, int accessFlags)
      Add a method annotation. If this is the first method annotation added, it becomes the primary method annotation.
      Parameters:
      className - name of the class containing the method
      methodName - name of the method
      methodSig - type signature of the method
      accessFlags - accessFlags for the method
      Returns:
      this object

    • addMethod

      public @NonNull BugInstance addMethod(org.apache.bcel.generic.MethodGen methodGen, String sourceFile)
      Add a method annotation. If this is the first method annotation added, it becomes the primary method annotation. If the method has source line information, then a SourceLineAnnotation is added to the method.
      Parameters:
      methodGen - the MethodGen object for the method
      sourceFile - source file method is defined in
      Returns:
      this object

    • addMethod

      public @NonNull BugInstance addMethod(org.apache.bcel.classfile.JavaClass javaClass, org.apache.bcel.classfile.Method method)
      Add a method annotation. If this is the first method annotation added, it becomes the primary method annotation. If the method has source line information, then a SourceLineAnnotation is added to the method.
      Parameters:
      javaClass - the class the method is defined in
      method - the method
      Returns:
      this object

    • addMethod

      public @NonNull BugInstance addMethod(JavaClassAndMethod classAndMethod)
      Add a method annotation. If this is the first method annotation added, it becomes the primary method annotation. If the method has source line information, then a SourceLineAnnotation is added to the method.
      Parameters:
      classAndMethod - JavaClassAndMethod identifying the method to add
      Returns:
      this object

    • addMethod

      public @NonNull BugInstance addMethod(PreorderVisitor visitor)
      Add a method annotation for the method which the given visitor is currently visiting. If the method has source line information, then a SourceLineAnnotation is added to the method.
      Parameters:
      visitor - the BetterVisitor
      Returns:
      this object

    • addCalledMethod

      public @NonNull BugInstance addCalledMethod(DismantleBytecode visitor)
      Add a method annotation for the method which has been called by the method currently being visited by given visitor. Assumes that the visitor has just looked at an invoke instruction of some kind.
      Parameters:
      visitor - the DismantleBytecode object
      Returns:
      this object

    • addCalledMethod

      public @NonNull BugInstance addCalledMethod(XMethod m)

    • addCalledMethod

      public @NonNull BugInstance addCalledMethod(String className, String methodName, String methodSig, boolean isStatic)
      Add a method annotation.
      Parameters:
      className - name of class containing called method
      methodName - name of called method
      methodSig - signature of called method
      isStatic - true if called method is static, false if not
      Returns:
      this object

    • addCalledMethod

      public @NonNull BugInstance addCalledMethod(org.apache.bcel.generic.ConstantPoolGen cpg, org.apache.bcel.generic.InvokeInstruction inv)
      Add a method annotation for the method which is called by given instruction.
      Parameters:
      cpg - the constant pool for the method containing the call
      inv - the InvokeInstruction
      Returns:
      this object

    • addCalledMethod

      public @NonNull BugInstance addCalledMethod(org.apache.bcel.generic.MethodGen methodGen, org.apache.bcel.generic.InvokeInstruction inv)
      Add a method annotation for the method which is called by given instruction.
      Parameters:
      methodGen - the method containing the call
      inv - the InvokeInstruction
      Returns:
      this object

    • addMethod

      public @NonNull BugInstance addMethod(XMethod xmethod)
      Add a MethodAnnotation from an XMethod.
      Parameters:
      xmethod - the XMethod
      Returns:
      this object

    • addMethod

      public @NonNull BugInstance addMethod(MethodDescriptor method)
      Add a MethodAnnotation from an MethodDescriptor.
      Parameters:
      method - the method
      Returns:
      this object

    • addMethod

      public @NonNull BugInstance addMethod(MethodAnnotation methodAnnotation)
      Add a method annotation. If this is the first method annotation added, it becomes the primary method annotation.
      Parameters:
      methodAnnotation - the method annotation
      Returns:
      this object

    • addInt

      public @NonNull BugInstance addInt(int value)
      Add an integer annotation.
      Parameters:
      value - the integer value
      Returns:
      this object

    • addParameterAnnotation

      public @NonNull BugInstance addParameterAnnotation(int index, String role)
      Add an annotation about a parameter
      Parameters:
      index - parameter index, starting from 0
      role - the role used to describe the parameter

    • addString

      public @NonNull BugInstance addString(String value)
      Add a String annotation.
      Parameters:
      value - the String value
      Returns:
      this object

    • addString

      public @NonNull BugInstance addString(char c)
      Add a String annotation.
      Parameters:
      c - the char value
      Returns:
      this object

    • addSourceLine

      public @NonNull BugInstance addSourceLine(SourceLineAnnotation sourceLine)
      Add a source line annotation.
      Parameters:
      sourceLine - the source line annotation
      Returns:
      this object

    • addSourceLine

      public @NonNull BugInstance addSourceLine(BytecodeScanningDetector visitor, int pc)
      Add a source line annotation for instruction whose PC is given in the method that the given visitor is currently visiting. Note that if the method does not have line number information, then no source line annotation will be added.
      Parameters:
      visitor - a BytecodeScanningDetector that is currently visiting the method
      pc - bytecode offset of the instruction
      Returns:
      this object

    • addSourceLine

      public @NonNull BugInstance addSourceLine(ClassContext classContext, PreorderVisitor visitor, int pc)
      Add a source line annotation for instruction whose PC is given in the method that the given visitor is currently visiting. Note that if the method does not have line number information, then no source line annotation will be added.
      Parameters:
      classContext - the ClassContext
      visitor - a PreorderVisitor that is currently visiting the method
      pc - bytecode offset of the instruction
      Returns:
      this object

    • addSourceLine

      public @NonNull BugInstance addSourceLine(ClassContext classContext, org.apache.bcel.generic.MethodGen methodGen, String sourceFile, @NonNull org.apache.bcel.generic.InstructionHandle handle)
      Add a source line annotation for the given instruction in the given method. Note that if the method does not have line number information, then no source line annotation will be added.
      Parameters:
      classContext - the ClassContext
      methodGen - the method being visited
      sourceFile - source file the method is defined in
      handle - the InstructionHandle containing the visited instruction
      Returns:
      this object

    • addSourceLine

      public @NonNull BugInstance addSourceLine(ClassContext classContext, org.apache.bcel.generic.MethodGen methodGen, String sourceFile, org.apache.bcel.generic.InstructionHandle start, org.apache.bcel.generic.InstructionHandle end)
      Add a source line annotation describing a range of instructions.
      Parameters:
      classContext - the ClassContext
      methodGen - the method
      sourceFile - source file the method is defined in
      start - the start instruction in the range
      end - the end instruction in the range (inclusive)
      Returns:
      this object

    • addSourceLine

      public @NonNull BugInstance addSourceLine(ClassContext classContext, org.apache.bcel.classfile.Method method, Location location)
      Add source line annotation for given Location in a method.
      Parameters:
      classContext - the ClassContext
      method - the Method
      location - the Location in the method
      Returns:
      this BugInstance

    • addSourceLine

      public @NonNull BugInstance addSourceLine(MethodDescriptor methodDescriptor, Location location)
      Add source line annotation for given Location in a method.
      Parameters:
      methodDescriptor - the method
      location - the Location in the method
      Returns:
      this BugInstance

    • addSourceLine

      public @NonNull BugInstance addSourceLine(ClassContext classContext, org.apache.bcel.classfile.Method method, org.apache.bcel.generic.InstructionHandle handle)
      Add source line annotation for given Location in a method.
      Parameters:
      classContext - the ClassContext
      method - the Method
      handle - InstructionHandle of an instruction in the method
      Returns:
      this BugInstance

    • addSourceLineRange

      public @NonNull BugInstance addSourceLineRange(BytecodeScanningDetector visitor, int startPC, int endPC)
      Add a source line annotation describing the source line numbers for a range of instructions in the method being visited by the given visitor. Note that if the method does not have line number information, then no source line annotation will be added.
      Parameters:
      visitor - a BetterVisitor which is visiting the method
      startPC - the bytecode offset of the start instruction in the range
      endPC - the bytecode offset of the end instruction in the range
      Returns:
      this object

    • addSourceLineRange

      public @NonNull BugInstance addSourceLineRange(ClassContext classContext, PreorderVisitor visitor, int startPC, int endPC)
      Add a source line annotation describing the source line numbers for a range of instructions in the method being visited by the given visitor. Note that if the method does not have line number information, then no source line annotation will be added.
      Parameters:
      classContext - the ClassContext
      visitor - a BetterVisitor which is visiting the method
      startPC - the bytecode offset of the start instruction in the range
      endPC - the bytecode offset of the end instruction in the range
      Returns:
      this object

    • addSourceLine

      public @NonNull BugInstance addSourceLine(BytecodeScanningDetector visitor)
      Add a source line annotation for instruction currently being visited by given visitor. Note that if the method does not have line number information, then no source line annotation will be added.
      Parameters:
      visitor - a BytecodeScanningDetector visitor that is currently visiting the instruction
      Returns:
      this object

    • addUnknownSourceLine

      public @NonNull BugInstance addUnknownSourceLine(String className, String sourceFile)
      Add a non-specific source line annotation. This will result in the entire source file being displayed.
      Parameters:
      className - the class name
      sourceFile - the source file name
      Returns:
      this object

    • getMessageWithoutPrefix

      public @NonNull String getMessageWithoutPrefix()
      Format a string describing this bug instance.
      Returns:
      the description

    • getLongDescription

      String getLongDescription()

    • getAbridgedMessage

      public String getAbridgedMessage()

    • getMessage

      public String getMessage()
      Format a string describing this bug instance.
      Returns:
      the description

    • getMessageWithPriorityType

      public String getMessageWithPriorityType()
      Format a string describing this bug pattern, with the priority and type at the beginning. e.g. "(High Priority Correctness) Guaranteed null pointer dereference..."

    • getMessageWithPriorityTypeAbbreviation

      public String getMessageWithPriorityTypeAbbreviation()

    • describe

      public @NonNull BugInstance describe(String description)
      Add a description to the most recently added bug annotation.
      Parameters:
      description - the description to add
      Returns:
      this object

    • toString

      public String toString()
      Convert to String. This method returns the "short" message describing the bug, as opposed to the longer format returned by getMessage(). The short format is appropriate for the tree view in a GUI, where the annotations are listed separately as part of the overall bug instance.
      Overrides:
      toString in class Object

    • writeXML

      public void writeXML(XMLOutput xmlOutput) throws IOException
      Description copied from interface: XMLWriteable
      Write this object to given XMLOutput.
      Specified by:
      writeXML in interface XMLWriteable
      Parameters:
      xmlOutput - the XMLOutput for the document
      Throws:
      IOException

    • getCWEid

      public int getCWEid()

    • writeXML

      public void writeXML(XMLOutput xmlOutput, BugCollection bugCollection, boolean addMessages) throws IOException
      Throws:
      IOException

    • addOptionalAnnotation

      public BugInstance addOptionalAnnotation(@Nullable BugAnnotation annotation)

    • addOptionalAnnotation

      public BugInstance addOptionalAnnotation(@Nullable BugAnnotation annotation, String role)

    • addJavaAnnotationNames

      private void addJavaAnnotationNames(BugAnnotation annotation)

    • addAnnotationNames

      private static void addAnnotationNames(PackageMemberAnnotation pma, org.apache.bcel.classfile.AnnotationEntry[] annotationEntries)

    • add

      public BugInstance add(@NonNull BugAnnotation annotation)

    • addSomeSourceForTopTwoStackValues

      public BugInstance addSomeSourceForTopTwoStackValues(ClassContext classContext, org.apache.bcel.classfile.Method method, Location location)

    • addSourceForTopStackValue

      public BugInstance addSourceForTopStackValue(ClassContext classContext, org.apache.bcel.classfile.Method method, Location location)

    • getSourceForTopStackValue

      public static @Nullable BugAnnotation getSourceForTopStackValue(ClassContext classContext, org.apache.bcel.classfile.Method method, Location location)

    • getSourceForStackValue

      public static @Nullable BugAnnotation getSourceForStackValue(ClassContext classContext, org.apache.bcel.classfile.Method method, Location location, int depth)

    • getSomeSource

      public static @Nullable BugAnnotation getSomeSource(ClassContext classContext, org.apache.bcel.classfile.Method method, Location location, OpcodeStack stack, int stackPos)

    • getValueSource

      public static @Nullable BugAnnotation getValueSource(OpcodeStack.Item item, org.apache.bcel.classfile.Method method, int pc)

    • addValueSource

      public BugInstance addValueSource(@Nullable OpcodeStack.Item item, DismantleBytecode dbc)

    • addValueSource

      public BugInstance addValueSource(OpcodeStack.Item item, org.apache.bcel.classfile.Method method, int pc)

    • addFieldOrMethodValueSource

      public BugInstance addFieldOrMethodValueSource(OpcodeStack.Item item)

    • addOptionalUniqueAnnotations

      public BugInstance addOptionalUniqueAnnotations(BugAnnotation... annotations)

    • tryAddingOptionalUniqueAnnotations

      public boolean tryAddingOptionalUniqueAnnotations(BugAnnotation... annotations)

    • addOptionalUniqueAnnotationsWithFallback

      public BugInstance addOptionalUniqueAnnotationsWithFallback(BugAnnotation fallback, BugAnnotation... annotations)

    • getFieldOrMethodValueSource

      public static @Nullable BugAnnotation getFieldOrMethodValueSource(@Nullable OpcodeStack.Item item)

    • addSourceLinesForMethod

      private void addSourceLinesForMethod(MethodAnnotation methodAnnotation, SourceLineAnnotation sourceLineAnnotation)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • compareTo

      public int compareTo(BugInstance other)
      Specified by:
      compareTo in interface Comparable<BugInstance>

    • setFirstVersion

      public void setFirstVersion(long firstVersion)

    • clearHistory

      public void clearHistory()

    • getFirstVersion

      public long getFirstVersion()

    • setHistory

      public void setHistory(BugInstance from)

    • setLastVersion

      public void setLastVersion(long lastVersion)

    • setLive

      public void setLive()
      Mark the bug instance is being alive (still present in the last version)

    • getLastVersion

      public long getLastVersion()

    • isDead

      public boolean isDead()

    • setIntroducedByChangeOfExistingClass

      public void setIntroducedByChangeOfExistingClass(boolean introducedByChangeOfExistingClass)

    • isIntroducedByChangeOfExistingClass

      public boolean isIntroducedByChangeOfExistingClass()

    • setRemovedByChangeOfPersistingClass

      public void setRemovedByChangeOfPersistingClass(boolean removedByChangeOfPersistingClass)

    • isRemovedByChangeOfPersistingClass

      public boolean isRemovedByChangeOfPersistingClass()

    • setInstanceHash

      public void setInstanceHash(String instanceHash)

    • setOldInstanceHash

      public void setOldInstanceHash(String oldInstanceHash)

    • getInstanceHash

      public String getInstanceHash()

    • isInstanceHashConsistent

      public boolean isInstanceHashConsistent()

    • setInstanceOccurrenceNum

      public void setInstanceOccurrenceNum(int instanceOccurrenceNum)

    • getInstanceOccurrenceNum

      public int getInstanceOccurrenceNum()

    • setInstanceOccurrenceMax

      public void setInstanceOccurrenceMax(int instanceOccurrenceMax)

    • getInstanceOccurrenceMax

      public int getInstanceOccurrenceMax()

    • getDetectorFactory

      public @Nullable DetectorFactory getDetectorFactory()

    • optionalAdd

      private void optionalAdd(Collection<BugAnnotation> c, BugAnnotation a)

    • getAnnotationsForMessage

      public List<BugAnnotation> getAnnotationsForMessage(boolean showContext)