edu.umd.cs.findbugs.config
public class ProjectFilterSettings extends Object implements Cloneable
See Also: BugInstance
Field Summary | |
---|---|
static String | DEFAULT_PRIORITY Default warning threshold priority. |
static String | EXPERIMENTAL_PRIORITY Text string for experimental priority. |
static String | HIGH_PRIORITY Text string for high priority. |
static String | LOW_PRIORITY Text string for low priority. |
static String | MEDIUM_PRIORITY Text string for medium priority. |
Method Summary | |
---|---|
void | addCategory(String category)
Add a bug category to the set of categories to be displayed.
|
void | clearAllCategories()
Clear all bug categories from the hidden list.
|
boolean | containsCategory(String category)
Returns false if the given category is hidden
in the project filter settings.
|
static ProjectFilterSettings | createDefault()
Factory method to create a default ProjectFilterSettings object.
|
boolean | displayFalseWarnings()
Get whether or not false warnings should be displayed.
|
boolean | displayWarning(BugInstance bugInstance)
Return whether or not a warning should be displayed,
according to the project filter settings.
|
static ProjectFilterSettings | fromEncodedString(String s)
Create ProjectFilterSettings from an encoded string.
|
Set<String> | getActiveCategorySet()
Return set of active (enabled) bug categories.
|
static String | getIntPriorityAsString(int prio)
Convert an integer warning priority threshold value to
a String. |
String | getMinPriority()
Get the minimum warning priority threshold.
|
int | getMinPriorityAsInt()
Return the minimum warning priority threshold as an integer.
|
static void | hiddenFromEncodedString(ProjectFilterSettings result, String s)
set the hidden bug categories on the specifed ProjectFilterSettings
from an encoded string
|
String | hiddenToEncodedString()
Create a string containing the encoded form of the hidden bug categories
|
void | removeCategory(String category)
Remove a bug category from the set of categories to be displayed.
|
void | setDisplayFalseWarnings(boolean displayFalseWarnings)
Set whether or not false warnings should be displayed.
|
void | setMinPriority(String minPriority)
Set minimum warning priority threshold.
|
String | toEncodedString()
Create a string containing the encoded form of the ProjectFilterSettings.
|
Parameters: category the bug category: e.g., "CORRECTNESS"
Parameters: category the category
Returns: false if the category is hidden, true if not
Returns: a default ProjectFilterSettings object
Returns: true if false warnings should be displayed, false if not
Parameters: bugInstance the warning
Returns: true if the warning should be displayed, false if not
Parameters: s the encoded string
Returns: the ProjectFilterSettings
Returns: the set of active categories
Returns: minimum warning priority threshold: one of "High", "Medium", or "Low"
Returns: the minimum warning priority threshold as an integer
Parameters: result the ProjectFilterSettings from which to remove bug categories s the encoded string
See Also: ProjectFilterSettings
Returns: an encoded string
Parameters: category the bug category: e.g., "CORRECTNESS"
Parameters: displayFalseWarnings true if false warnings should be displayed, false if not
Parameters: minPriority the priority threshold: one of "High", "Medium", or "Low"
Returns: an encoded string