FindBugs™ 1.3.9

edu.umd.cs.findbugs
Class BugCategory

java.lang.Object
  extended by edu.umd.cs.findbugs.BugCategory
All Implemented Interfaces:
java.lang.Comparable<BugCategory>

public class BugCategory
extends java.lang.Object
implements java.lang.Comparable<BugCategory>

A BugCategory object collects all of the metadata for a category of bugs. BugCategories derive from the BugCategory elements in messages*.xml files.


Constructor Summary
BugCategory(java.lang.String category, java.lang.String shortDescription)
          Constructor.
BugCategory(java.lang.String category, java.lang.String shortDescription, java.lang.String abbrev, java.lang.String detailText)
          Constructor.
 
Method Summary
 int compareTo(BugCategory other)
           
 boolean equals(java.lang.Object o)
           
 java.lang.String getAbbrev()
          Get the abbreviation (usually a single capital letter).
 java.lang.String getCategory()
          Get the category.
 java.lang.String getDetailText()
          Get the detail text describing the category.
 java.lang.String getShortDescription()
          Get the short description (usually a word or three)
 int hashCode()
           
 void setAbbrev(java.lang.String abbrev)
          Set the abbreviation (typically a single capital letter)
 void setDetailText(java.lang.String detailText)
          Set the detail text describing the category.
 java.lang.String toString()
          suitable for debugging.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

BugCategory

public BugCategory(java.lang.String category,
                   java.lang.String shortDescription,
                   java.lang.String abbrev,
                   java.lang.String detailText)
Constructor.

Parameters:
category - the category
shortDescription - short (a word or three) description of the bug species
abbrev - the abbreviation (typically a single capital letter)
detailText - full description of the bug category (no HTML markup, may be null)

BugCategory

public BugCategory(java.lang.String category,
                   java.lang.String shortDescription)
Constructor.

Parameters:
category - the category
shortDescription - short (a word or three) description of the bug species
Method Detail

getCategory

public java.lang.String getCategory()
Get the category.


getShortDescription

public java.lang.String getShortDescription()
Get the short description (usually a word or three)


getAbbrev

public java.lang.String getAbbrev()
Get the abbreviation (usually a single capital letter). May be null, but shouldn't be if the XML is correct.


getDetailText

public java.lang.String getDetailText()
Get the detail text describing the category. note: no HTML markup allowed, may be null


setAbbrev

public void setAbbrev(java.lang.String abbrev)
Set the abbreviation (typically a single capital letter)


setDetailText

public void setDetailText(java.lang.String detailText)
Set the detail text describing the category. note: no HTML markup allowed, may be null


compareTo

public int compareTo(BugCategory other)
Specified by:
compareTo in interface java.lang.Comparable<BugCategory>

hashCode

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

equals

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

toString

public java.lang.String toString()
suitable for debugging. will be ugly if detailText has multiple lines

Overrides:
toString in class java.lang.Object

FindBugs™ 1.3.9

FindBugs™ is licenced under the LGPL. Copyright © 2006 University of Maryland.