Package edu.umd.cs.findbugs

Class BugCategory

java.lang.Object

edu.umd.cs.findbugs.BugCategory

All Implemented Interfaces:

Comparable<BugCategory>

public class BugCategory
extends Object
implements 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

Constructors

Constructor	Description
BugCategory(String category)	Constructor.
BugCategory(String category, String shortDescription)	Constructor.
BugCategory(String category, String shortDescription, String abbrev, String detailText)	Constructor.

Method Summary

Modifier and Type	Method	Description
int	compareTo(BugCategory other)
boolean	equals(Object o)
String	getAbbrev()	Get the abbreviation (usually a single capital letter).
String	getCategory()	Get the category.
String	getDetailText()	Get the detail text describing the category.
String	getShortDescription()	Get the short description (usually a word or three)
int	hashCode()
boolean	isHidden()
void	setAbbrev(String abbrev)	Set the abbreviation (typically a single capital letter)
void	setDetailText(String detailText)	Set the detail text describing the category.
void	setHidden(boolean hidden)
void	setShortDescription(String shortDescription)	Set the short description of the category
String	toString()	suitable for debugging.

Methods inherited from class java.lang.Object

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

Constructor Details

BugCategory

public BugCategory(String category,
 String shortDescription,
 String abbrev,
 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(String category,
 String shortDescription)

Constructor.

Parameters:

category - the category

shortDescription - short (a word or three) description of the bug species

BugCategory

public BugCategory(String category)

Constructor.

Parameters:

category - the category

Method Details

getCategory

public String getCategory()

Get the category.

getShortDescription

public String getShortDescription()

Get the short description (usually a word or three)

getAbbrev

public String getAbbrev()

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

getDetailText

public String getDetailText()

Get the detail text describing the category. note: no HTML markup allowed, may be null

setShortDescription

public void setShortDescription(String shortDescription)

Set the short description of the category

setAbbrev

public void setAbbrev(String abbrev)

Set the abbreviation (typically a single capital letter)

setDetailText

public void setDetailText(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 Comparable<BugCategory>

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

toString

public String toString()

suitable for debugging. will be ugly if detailText has multiple lines

Overrides:

toString in class Object

isHidden

public boolean isHidden()

Returns:

Returns the hidden.

setHidden

public void setHidden(boolean hidden)

Parameters:

hidden - The hidden to set.