| java.lang.Object edu.umd.cs.findbugs.BugPattern
BugPattern | public class BugPattern implements Comparable<BugPattern>(Code) | | 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 | |
public | BugPattern(String type, String abbrev, String category, boolean experimental, String shortDescription, String longDescription, String detailText) Constructor. | public | BugPattern(String type, String abbrev, String category, boolean experimental, String shortDescription, String longDescription, String detailText, int cweid) Constructor. |
BugPattern | public BugPattern(String type, String abbrev, String category, boolean experimental, String shortDescription, String longDescription, String detailText)(Code) | | Constructor.
Parameters: type - the type (species) of BugInstance Parameters: abbrev - the abbreviation or "bug code"; see BugCode Parameters: category - the category Parameters: experimental - true if the bug pattern is experimental Parameters: shortDescription - short one-line description of the bug species Parameters: longDescription - longer one-line description; may contain placeholdersfor use by FindBugsMessageFormat to format BugAnnotations Parameters: detailText - HTML text containing a full description of the bug species |
BugPattern | public BugPattern(String type, String abbrev, String category, boolean experimental, String shortDescription, String longDescription, String detailText, int cweid)(Code) | | Constructor.
Parameters: type - the type (species) of BugInstance Parameters: abbrev - the abbreviation or "bug code"; see BugCode Parameters: category - the category Parameters: experimental - true if the bug pattern is experimental Parameters: shortDescription - short one-line description of the bug species Parameters: longDescription - longer one-line description; may contain placeholdersfor use by FindBugsMessageFormat to format BugAnnotations Parameters: detailText - HTML text containing a full description of the bug species |
getAbbrev | public String getAbbrev()(Code) | | Get the abbreviation or "bug code".
|
getCWEid | public int getCWEid()(Code) | | Returns the cweid. |
getCategory | public String getCategory()(Code) | | Get the category.
|
getDetailHTML | public String getDetailHTML()(Code) | | Get the detail text as a complete HTML document.
|
getDetailText | public String getDetailText()(Code) | | Get the HTML detail text describing the bug.
|
getLongDescription | public String getLongDescription()(Code) | | Get the long description.
|
getShortDescription | public String getShortDescription()(Code) | | Get the short description.
|
getType | public String getType()(Code) | | Get the type (species).
|
hashCode | public int hashCode()(Code) | | |
isExperimental | public boolean isExperimental()(Code) | | Is the bug pattern experimental?
|
|
|