edu.umd.cs.findbugs

Class 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
	BugCategory(String category, String shortDescription, String abbrev, String detailText) Constructor.
	BugCategory(String category, String shortDescription) Constructor.

Method Summary
int	compareTo(BugCategory other)
String	getAbbrev() Get the abbreviation (usually a single capital letter).
String	getCategory() Get the category.
String	getDetailText() Get the detail text describing the category. note: no HTML markup allowed, may be null
String	getShortDescription() Get the short description (usually a word or three)
void	setAbbrev(String abbrev) Set the abbreviation (typically a single capital letter)
void	setDetailText(String detailText) Set the detail text describing the category. note: no HTML markup allowed, may be null

Constructor Detail

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

Method Detail

compareTo

public int compareTo(BugCategory other)

getAbbrev

public String getAbbrev()

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

getCategory

public String getCategory()

Get the category.

getDetailText

public String getDetailText()

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

getShortDescription

public String getShortDescription()

Get the short description (usually a word or three)

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