Package edu.umd.cs.findbugs.ba.obl

Interface ObligationPolicyDatabaseEntry

All Known Implementing Classes:

MatchMethodEntry

public interface ObligationPolicyDatabaseEntry

Interface defining an entry in the ObligationPolicyDatabase. Checks called methods to see what actions they apply.

Author:

David Hovemeyer

Method Summary

Modifier and Type	Method	Description
boolean	getActions(org.apache.bcel.generic.ReferenceType receiverType, java.lang.String methodName, java.lang.String signature, boolean isStatic, java.util.Collection<ObligationPolicyDatabaseAction> actionList)	Get the ObligationPolicyDatabaseActions that should be applied when the method described by the parameters is called.
java.util.Collection<Obligation>	getAllObligations()
ObligationPolicyDatabaseEntryType	getEntryType()	Get the type of entry (STRONG or WEAK).

Method Detail

getEntryType

ObligationPolicyDatabaseEntryType getEntryType()

Get the type of entry (STRONG or WEAK).

getActions

boolean getActions(org.apache.bcel.generic.ReferenceType receiverType,
                   java.lang.String methodName,
                   java.lang.String signature,
                   boolean isStatic,
                   java.util.Collection<ObligationPolicyDatabaseAction> actionList)

Get the ObligationPolicyDatabaseActions that should be applied when the method described by the parameters is called.

Parameters:

receiverType - receiver type of called method

methodName - name of called method

signature - signature of called method

isStatic - true if called method is static, false otherwise

actionList - List of ObligationPolicyDatabaseActions to be applied when a called method is matched by this entry

Returns:

true if one or more actions were added, false if no actions were added

getAllObligations

java.util.Collection<Obligation> getAllObligations()