|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectedu.umd.cs.findbugs.BugPattern
public class 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.
BugInstance
Constructor Summary | |
---|---|
BugPattern(java.lang.String type,
java.lang.String abbrev,
java.lang.String category,
boolean experimental,
java.lang.String shortDescription,
java.lang.String longDescription,
java.lang.String detailText)
Constructor. |
Method Summary | |
---|---|
int |
compareTo(java.lang.Object o)
|
boolean |
equals(java.lang.Object o)
|
java.lang.String |
getAbbrev()
Get the abbreviation or "bug code". |
java.lang.String |
getCategory()
Get the category. |
java.lang.String |
getDetailHTML()
Get the detail text as a complete HTML document. |
java.lang.String |
getDetailText()
Get the HTML detail text describing the bug. |
java.lang.String |
getLongDescription()
Get the long description. |
java.lang.String |
getShortDescription()
Get the short description. |
java.lang.String |
getType()
Get the type (species). |
int |
hashCode()
|
boolean |
isExperimental()
Is the bug pattern experimental? |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public BugPattern(java.lang.String type, java.lang.String abbrev, java.lang.String category, boolean experimental, java.lang.String shortDescription, java.lang.String longDescription, java.lang.String detailText)
type
- the type (species) of BugInstanceabbrev
- the abbreviation or "bug code"; see BugCode
category
- the categoryexperimental
- true if the bug pattern is experimentalshortDescription
- short one-line description of the bug specieslongDescription
- longer one-line description; may contain placeholders
for use by FindBugsMessageFormat
to format BugAnnotationsdetailText
- HTML text containing a full description of the bug speciesMethod Detail |
---|
public java.lang.String getType()
public java.lang.String getAbbrev()
public java.lang.String getCategory()
public boolean isExperimental()
public java.lang.String getShortDescription()
public java.lang.String getLongDescription()
public java.lang.String getDetailText()
public java.lang.String getDetailHTML()
public int compareTo(java.lang.Object o)
compareTo
in interface java.lang.Comparable
public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object o)
equals
in class java.lang.Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |