|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectedu.umd.cs.findbugs.config.ProjectFilterSettings
public class ProjectFilterSettings
Settings for user filtering of warnings for a project. This includes selecting particular bug categories to view, as well as a minimum warning priority. Includes support for encoding these settings as a String, which can easily be stored as a persistent project property in Eclipse.
BugInstance
Field Summary | |
---|---|
private java.util.Set<java.lang.String> |
activeBugCategorySet
|
static java.lang.String |
DEFAULT_PRIORITY
Default warning threshold priority. |
static java.lang.String |
EXPERIMENTAL_PRIORITY
Text string for experimental priority. |
static java.lang.String |
HIGH_PRIORITY
Text string for high priority. |
static java.lang.String |
LOW_PRIORITY
Text string for low priority. |
static java.lang.String |
MEDIUM_PRIORITY
Text string for medium priority. |
private java.lang.String |
minPriority
|
private int |
minPriorityAsInt
|
private static java.util.Map<java.lang.String,java.lang.Integer> |
priorityNameToValueMap
Map of priority level names to their numeric values. |
Constructor Summary | |
---|---|
private |
ProjectFilterSettings()
Constructor. |
Method Summary | |
---|---|
void |
addCategory(java.lang.String category)
Add a bug category to the set of categories to be displayed. |
void |
clearAllCategories()
Clear all bug categories. |
boolean |
containsCategory(java.lang.String category)
Return whether or not the given category is enabled in the project filter settings. |
static ProjectFilterSettings |
createDefault()
Factory method to create a default ProjectFilterSettings object. |
boolean |
displayWarning(BugInstance bugInstance)
Return whether or not a warning should be displayed, according to the project filter settings. |
boolean |
equals(java.lang.Object obj)
|
static ProjectFilterSettings |
fromEncodedString(java.lang.String s)
Create ProjectFilterSettings from an encoded string. |
java.util.Set<java.lang.String> |
getActiveCategorySet()
Return set of active (enabled) bug categories. |
static java.lang.String |
getIntPriorityAsString(int prio)
Convert an integer warning priority threshold value to a String. |
java.lang.String |
getMinPriority()
Get the minimum warning priority threshold. |
int |
getMinPriorityAsInt()
Return the minimum warning priority threshold as an integer. |
int |
hashCode()
|
void |
removeCategory(java.lang.String category)
Remove a bug category from the set of categories to be displayed. |
void |
setMinPriority(java.lang.String minPriority)
Set minimum warning priority threshold. |
java.lang.String |
toEncodedString()
Create a string containing the encoded form of the ProjectFilterSettings. |
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String HIGH_PRIORITY
public static final java.lang.String MEDIUM_PRIORITY
public static final java.lang.String LOW_PRIORITY
public static final java.lang.String EXPERIMENTAL_PRIORITY
public static final java.lang.String DEFAULT_PRIORITY
private static java.util.Map<java.lang.String,java.lang.Integer> priorityNameToValueMap
private java.util.Set<java.lang.String> activeBugCategorySet
private java.lang.String minPriority
private int minPriorityAsInt
Constructor Detail |
---|
private ProjectFilterSettings()
Method Detail |
---|
public static ProjectFilterSettings createDefault()
public static ProjectFilterSettings fromEncodedString(java.lang.String s)
s
- the encoded string
public boolean displayWarning(BugInstance bugInstance)
bugInstance
- the warning
public void setMinPriority(java.lang.String minPriority)
value
- the priority: one of "High", "Medium", or "Low"public java.lang.String getMinPriority()
public int getMinPriorityAsInt()
public void addCategory(java.lang.String category)
category
- the bug category: e.g., "CORRECTNESS"public void removeCategory(java.lang.String category)
category
- the bug category: e.g., "CORRECTNESS"public void clearAllCategories()
public boolean containsCategory(java.lang.String category)
category
- the category
public java.util.Set<java.lang.String> getActiveCategorySet()
public java.lang.String toEncodedString()
public java.lang.String toString()
toString
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public static java.lang.String getIntPriorityAsString(int prio)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |