Class FindUnsatisfiedObligation

java.lang.Object

edu.umd.cs.findbugs.bcel.CFGDetector

edu.umd.cs.findbugs.detect.FindUnsatisfiedObligation

All Implemented Interfaces:

Detector2, Priorities

public class FindUnsatisfiedObligation
extends CFGDetector

Find unsatisfied obligations in Java methods. Examples: open streams, open database connections, etc.

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private class	FindUnsatisfiedObligation.MethodChecker	A helper class to check a single method for unsatisfied obligations.
private static class	FindUnsatisfiedObligation.PossibleObligationTransfer	Helper class to keep track of possible obligation transfers observed along paths where an obligation appears to be leaked.

Field Summary

Fields

Modifier and Type	Field	Description
private final BugReporter	bugReporter
private static final boolean	COMPUTE_TRANSFERS	Compute possible obligation transfers as a way of suppressing false positives due to "wrapper" objects.
private final ObligationPolicyDatabase	database
private static final boolean	DEBUG
private static final boolean	DEBUG_FP
private static final String	DEBUG_METHOD
private static final boolean	REPORT_OBLIGATION_SET	Report the final obligation set as part of the BugInstance.
private static final boolean	REPORT_PATH	Report path information from point of resource creation to CFG exit.
private static final boolean	REPORT_PATH_DEBUG

Fields inherited from class CFGDetector

classContext, method

Fields inherited from interface Priorities

EXP_PRIORITY, HIGH_PRIORITY, IGNORE_PRIORITY, LOW_PRIORITY, NORMAL_PRIORITY

Constructor Summary

Constructors

Constructor	Description
FindUnsatisfiedObligation(BugReporter bugReporter)

Method Summary

Modifier and Type	Method	Description
void	report()
void	visitClass(ClassDescriptor classDescriptor)	Visit a class.
protected void	visitMethodCFG(MethodDescriptor methodDescriptor, CFG cfg)	Visit the CFG (control flow graph) of a method to be analyzed.

Methods inherited from class CFGDetector

finishPass

Methods inherited from class Object

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

Methods inherited from interface Detector2

getDetectorClassName

Field Details

DEBUG

private static final boolean DEBUG

DEBUG_METHOD

private static final String DEBUG_METHOD

DEBUG_FP

private static final boolean DEBUG_FP

COMPUTE_TRANSFERS

private static final boolean COMPUTE_TRANSFERS

Compute possible obligation transfers as a way of suppressing false positives due to "wrapper" objects. Not quite ready for prime time.

REPORT_PATH

private static final boolean REPORT_PATH

Report path information from point of resource creation to CFG exit. This makes the reported warning a lot easier to understand.

REPORT_PATH_DEBUG

private static final boolean REPORT_PATH_DEBUG

REPORT_OBLIGATION_SET

private static final boolean REPORT_OBLIGATION_SET

Report the final obligation set as part of the BugInstance.

bugReporter

private final BugReporter bugReporter

database

private final ObligationPolicyDatabase database

Constructor Details

FindUnsatisfiedObligation

public FindUnsatisfiedObligation(BugReporter bugReporter)

Method Details

visitClass

public void visitClass(ClassDescriptor classDescriptor)
                throws CheckedAnalysisException

Description copied from interface: Detector2

Visit a class.

Specified by:

visitClass in interface Detector2

Overrides:

visitClass in class CFGDetector

Parameters:

classDescriptor - descriptor naming the class to visit

Throws:

CheckedAnalysisException - if an exception occurs during analysis

visitMethodCFG

protected void visitMethodCFG(MethodDescriptor methodDescriptor,
 CFG cfg)
                       throws CheckedAnalysisException

Description copied from class: CFGDetector

Visit the CFG (control flow graph) of a method to be analyzed. Should be overridden by subclasses.

Specified by:

visitMethodCFG in class CFGDetector

Parameters:

methodDescriptor -

cfg -

Throws:

CheckedAnalysisException

report

public void report()