edu.umd.cs.findbugs.props

Class WarningPropertySet

public class WarningPropertySet extends Object implements Cloneable

A Set of WarningProperty objects, each with an optional attribute Object. A WarningPropertySet is useful for collecting heuristics to use in the determination of whether or not a warning is a false positive, or what the warning's priority should be.

Author: David Hovemeyer

Constructor Summary
WarningPropertySet()
Constructor Creates empty object.
Method Summary
WarningPropertySetaddProperty(WarningProperty prop)
Add a warning property to the set.
booleancheckProperty(WarningProperty prop, Object value)
Check whether or not the given WarningProperty has the given attribute value.
intcomputePriority(int basePriority)
Use the PriorityAdjustments specified by the set's WarningProperty elements to compute a warning priority from the given base priority.
booleancontainsProperty(WarningProperty prop)
Return whether or not the set contains the given WarningProperty.
voiddecorateBugInstance(BugInstance bugInstance)
Decorate given BugInstance with properties.
ObjectgetProperty(WarningProperty prop)
Get the value of the attribute for the given WarningProperty.
booleanisFalsePositive(int priority)
Determine whether or not a warning with given priority is expected to be a false positive.
WarningPropertySetremoveProperty(WarningProperty prop)
Remove a warning property from the set.
WarningPropertySetsetProperty(WarningProperty prop, String value)
Add a warning property and its attribute value.
voidsetProperty(WarningProperty prop, Boolean value)
Add a warning property and its attribute value.

Constructor Detail

WarningPropertySet

public WarningPropertySet()
Constructor Creates empty object.

Method Detail

addProperty

public WarningPropertySet addProperty(WarningProperty prop)
Add a warning property to the set. The warning implicitly has the boolean value "true" as its attribute.

Parameters: prop the WarningProperty

Returns: this object

checkProperty

public boolean checkProperty(WarningProperty prop, Object value)
Check whether or not the given WarningProperty has the given attribute value.

Parameters: prop the WarningProperty value the attribute value

Returns: true if the set contains the WarningProperty and has an attribute equal to the one given, false otherwise

computePriority

public int computePriority(int basePriority)
Use the PriorityAdjustments specified by the set's WarningProperty elements to compute a warning priority from the given base priority.

Parameters: basePriority the base priority

Returns: the computed warning priority

containsProperty

public boolean containsProperty(WarningProperty prop)
Return whether or not the set contains the given WarningProperty.

Parameters: prop the WarningProperty

Returns: true if the set contains the WarningProperty, false if not

decorateBugInstance

public void decorateBugInstance(BugInstance bugInstance)
Decorate given BugInstance with properties.

Parameters: bugInstance the BugInstance

getProperty

public Object getProperty(WarningProperty prop)
Get the value of the attribute for the given WarningProperty. Returns null if the set does not contain the WarningProperty.

Parameters: prop the WarningProperty

Returns: the WarningProperty's attribute value, or null if the set does not contain the WarningProperty

isFalsePositive

public boolean isFalsePositive(int priority)
Determine whether or not a warning with given priority is expected to be a false positive.

Parameters: priority the priority

Returns: true if the warning is expected to be a false positive, false if not

removeProperty

public WarningPropertySet removeProperty(WarningProperty prop)
Remove a warning property from the set.

Parameters: prop the WarningProperty

Returns: this object

setProperty

public WarningPropertySet setProperty(WarningProperty prop, String value)
Add a warning property and its attribute value.

Parameters: prop the WarningProperty value the attribute value

Returns: this object

setProperty

public void setProperty(WarningProperty prop, Boolean value)
Add a warning property and its attribute value.

Parameters: prop the WarningProperty value the attribute value

FindBugs™ is licenced under the LGPL. Copyright © 2006 University of Maryland.