edu.umd.cs.findbugs.ba.obl

Class ObligationPolicyDatabase

java.lang.Object

edu.umd.cs.findbugs.ba.obl.ObligationPolicyDatabase

public class ObligationPolicyDatabase
extends Object

Policy database which defines which methods create and remove obligations.

See Weimer and Necula, Finding and preventing run-time error handling mistakes, OOPSLA 2004.

Author:

David Hovemeyer

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEBUG

Constructor Summary

Constructors

Constructor and Description
ObligationPolicyDatabase()

Method Summary

Methods

Modifier and Type	Method and Description
void	addEntry(ObligationPolicyDatabaseEntry entry)
ObligationPolicyDatabaseEntry	addParameterDeletesObligationDatabaseEntry(XMethod xmethod, Obligation obligation, ObligationPolicyDatabaseEntryType entryType) Add an appropriate policy database entry for parameters marked with the WillClose annotation.
void	getActions(org.apache.bcel.generic.ReferenceType receiverType, String methodName, String signature, boolean isStatic, Collection<ObligationPolicyDatabaseAction> actionList)
Set<Obligation>	getAllObligations()
List<ObligationPolicyDatabaseEntry>	getEntries()
ObligationFactory	getFactory()
boolean	isStrictChecking()
void	setStrictChecking(boolean strictChecking)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEBUG

public static final boolean DEBUG

Constructor Detail

ObligationPolicyDatabase

public ObligationPolicyDatabase()

Method Detail

getFactory

public ObligationFactory getFactory()

getAllObligations

public Set<Obligation> getAllObligations()

addEntry

public void addEntry(ObligationPolicyDatabaseEntry entry)

addParameterDeletesObligationDatabaseEntry

public ObligationPolicyDatabaseEntry addParameterDeletesObligationDatabaseEntry(XMethod xmethod,
                                                                       Obligation obligation,
                                                                       ObligationPolicyDatabaseEntryType entryType)

Add an appropriate policy database entry for parameters marked with the WillClose annotation.

Parameters:

xmethod - a method

obligation - the Obligation deleted by the method

entryType - type of entry (STRONG or WEAK)

setStrictChecking

public void setStrictChecking(boolean strictChecking)

isStrictChecking

public boolean isStrictChecking()

getActions

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

getEntries

public List<ObligationPolicyDatabaseEntry> getEntries()