edu.umd.cs.findbugs

Class BugPattern

public class BugPattern extends Object implements Comparable<BugPattern>

A BugPattern object collects all of the metadata for a particular species of BugInstance. Specifically, it stores the human-readable text for displaying a bug instance. BugPatterns derive from the BugPattern elements in the "findbugs.xml" and "messages.xml" found in a FindBugs plugin.

Author: David Hovemeyer

See Also: BugInstance

Constructor Summary
	BugPattern(String type, String abbrev, String category, boolean experimental, String shortDescription, String longDescription, String detailText) Constructor.

Method Summary
int	compareTo(BugPattern other)
String	getAbbrev() Get the abbreviation or "bug code".
String	getCategory() Get the category.
String	getCategoryAbbrev()
String	getDetailHTML() Get the detail text as a complete HTML document.
String	getDetailText() Get the HTML detail text describing the bug.
String	getLongDescription() Get the long description.
String	getShortDescription() Get the short description.
String	getType() Get the type (species).
boolean	isExperimental() Is the bug pattern experimental?

Constructor Detail

BugPattern

public BugPattern(String type, String abbrev, String category, boolean experimental, String shortDescription, String longDescription, String detailText)

Constructor.

Parameters: type the type (species) of BugInstance abbrev the abbreviation or "bug code"; see BugCode category the category experimental true if the bug pattern is experimental shortDescription short one-line description of the bug species longDescription longer one-line description; may contain placeholders for use by FindBugsMessageFormat to format BugAnnotations detailText HTML text containing a full description of the bug species