edu.umd.cs.findbugs
Class BugCode

java.lang.Object
  extended by edu.umd.cs.findbugs.BugCode

public class BugCode
extends java.lang.Object

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

Field Summary
private  java.lang.String abbrev
           
private  java.lang.String description
           
 
Constructor Summary
BugCode(java.lang.String abbrev, java.lang.String description)
          Constructor.
 
Method Summary
 java.lang.String getAbbrev()
          Get the abbreviation for this bug code.
 java.lang.String getDescription()
          Get the short textual description of the bug code.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

abbrev

private java.lang.String abbrev

description

private java.lang.String description
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
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.