Package edu.umd.cs.findbugs

Class BugCode

  • All Implemented Interfaces:
    java.lang.Comparable<BugCode>
    public class BugCode
extends java.lang.Object
implements java.lang.Comparable<BugCode>
    A BugCode is an abbreviation that is shared among some number of BugPatterns. For example, the code "HE" is shared by all of the BugPatterns that represent hashcode/equals violations.
    Author:
    David Hovemeyer
    See Also:
    BugPattern

    • Constructor Summary

      Constructors 
      Constructor Description
      BugCode​(java.lang.String abbrev, java.lang.String description)
      Constructor.
      BugCode​(java.lang.String abbrev, java.lang.String description, int cweid)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int compareTo​(BugCode o)  
      boolean equals​(java.lang.Object o)  
      java.lang.String getAbbrev()
      Get the abbreviation for this bug code.
      int getCWEid()  
      java.lang.String getDescription()
      Get the short textual description of the bug code.
      int hashCode()  
      java.lang.String toString()
      Get the abbreviation fo this bug code.

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • BugCode

        public BugCode​(java.lang.String abbrev,
               java.lang.String description)
        Constructor.
        Parameters:
        abbrev - the abbreviation for the bug code
        description - a short textual description of the class of bug pattern represented by this bug code

      • BugCode

        public BugCode​(java.lang.String abbrev,
               java.lang.String description,
               int cweid)

    • Method Detail

      • getAbbrev

        public java.lang.String getAbbrev()
        Get the abbreviation for this bug code.

      • getDescription

        public java.lang.String getDescription()
        Get the short textual description of the bug code.

      • toString

        public java.lang.String toString()
        Get the abbreviation fo this bug code.
        Overrides:
        toString in class java.lang.Object

      • getCWEid

        public int getCWEid()
        Returns:
        Returns the cweid.

      • compareTo

        public int compareTo​(BugCode o)
        Specified by:
        compareTo in interface java.lang.Comparable<BugCode>

      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object