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
intcompareTo(BugPattern other)
StringgetAbbrev()
Get the abbreviation or "bug code".
StringgetCategory()
Get the category.
StringgetCategoryAbbrev()
StringgetDetailHTML()
Get the detail text as a complete HTML document.
StringgetDetailText()
Get the HTML detail text describing the bug.
StringgetLongDescription()
Get the long description.
StringgetShortDescription()
Get the short description.
StringgetType()
Get the type (species).
booleanisExperimental()
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

Method Detail

compareTo

public int compareTo(BugPattern other)

getAbbrev

public String getAbbrev()
Get the abbreviation or "bug code".

getCategory

public String getCategory()
Get the category.

getCategoryAbbrev

public String getCategoryAbbrev()

getDetailHTML

public String getDetailHTML()
Get the detail text as a complete HTML document.

getDetailText

public String getDetailText()
Get the HTML detail text describing the bug.

getLongDescription

public String getLongDescription()
Get the long description.

getShortDescription

public String getShortDescription()
Get the short description.

getType

public String getType()
Get the type (species).

isExperimental

public boolean isExperimental()
Is the bug pattern experimental?
FindBugs™ is licenced under the LGPL. Copyright © 2006 University of Maryland.