Package edu.umd.cs.findbugs

Main package for the FindBugs application - contains the engine class (FindBugs), the object model classes for bug instances (BugInstance, BugAnnotation), and other miscellany.

See:
          Description

Interface Summary
BugAnnotation An object providing context information about a particular BugInstance.
BugAnnotationVisitor  
BugCollection  
BugReporter Generic interface for bug reporter objects.
BugReporterObserver Observer to determine when a BugReporter reports a bug.
Detector The interface which all bug pattern detectors must implement.
DetectorFactoryChooser Predicate for choosing DetectorFactory objects.
ExitCodes Flags returned in the process exit code returned when the FindBugs text UI is invoked with the -exitcode command line argument.
FindBugsProgress A callback that may be installed in a FindBugs instance to asynchronously keep track of its progress.
InstructionScanner A scanner for implementing a state machine over a sequence of instructions and control edges.
InstructionScannerGenerator Class for generating InstructionScanners at particular instructions of a path.
InterproceduralFirstPassDetector Detector implementing a slow first pass to collect interprocedural properties for a later detector pass.
NonReportingDetector A Detector which does not report warnings.
StatelessDetector is a marker interface for detectors that don't save state from one class file to the next.
TrainingDetector Interface to mark Detector classes which are used only as a training pass.
WarningComparator  
XMLWriteableWithMessages Write an object to XMLOutput while optionally adding descriptive messages.
 

Class Summary
AbstractBugReporter An abstract class which provides much of the functionality required of all BugReporter objects.
AddAnnotation Add an annotation string to every BugInstance in a BugCollection.
AddMessages Add human-readable messages to a dom4j tree containing FindBugs XML output.
AnalysisError Object recording a recoverable error that occurred during analysis.
AnalysisLocal<T>  
AppVersion A version of an analyzed application.
BugAnnotationUtil Utility methods for BugAnnotation classes.
BugCode A BugCode is an abbreviation that is shared among some number of BugPatterns.
BugCollectionBugReporter  
BugInstance An instance of a bug pattern.
BugPattern A BugPattern object collects all of the metadata for a particular species of BugInstance.
BugProperty Name/value metadata pair that may be attached to a BugInstance.
ByteCodePatternDetector A base class for bug detectors that are based on a ByteCodePattern.
BytecodeScanningDetector Base class for Detectors which want to extend DismantleBytecode.
CallGraph  
CallGraphEdge  
CallGraphNode  
CallSite The site of a method call.
ClassAnnotation A BugAnnotation object specifying a Java class involved in the bug.
ClassScreener Class to pre-screen class files, so that only a subset are analyzed.
ClassWarningSuppressor  
DelegatingBugReporter A BugReporter which delegates all method calls to another BugReporter.
DetectorFactory A DetectorFactory is responsible for creating instances of Detector objects and for maintaining meta-information about the detector class.
DetectorFactoryCollection The DetectorFactoryCollection stores all of the DetectorFactory objects used to create the Detectors which implement the various analyses.
EmacsBugReporter BugReporter to output warnings in Emacs format.
FieldAnnotation A BugAnnotation specifying a particular field in particular class.
FieldWarningSuppressor  
FilterBugReporter  
FindBugs An instance of this class is used to apply the selected set of analyses on some collection of Java classes.
FindBugsAnalysisFeatures Boolean-valued analysis properties for FindBugs.
FindBugsCommandLine Base class for FindBugs command line classes.
FindBugsMessageFormat Format the message for a BugInstance.
Footprint Class to maintain a snapshot of a processes's time and memory usage.
Footprint.MemoryBeanWrapper Wrapper so that possbile NoClassDefFoundError can be caught.
Footprint.OperatingSystemBeanWrapper Wrapper so that possbile NoClassDefFoundError can be caught.
FuzzyBugComparator A slightly more intellegent way of comparing BugInstances from two versions to see if they are the "same".
HTMLBugReporter  
I18N Singleton responsible for returning localized strings for information returned to the user.
InstructionScannerDriver Drive an InstructionScannerGenerator over the instructions of a simple path.
IntAnnotation Bug annotation class for integer values.
JavaVersion Support for finding out what version of Java we're running on.
LocalVariableAnnotation Bug annotation class for integer values.
Lookup  
MethodAnnotation A BugAnnotation specifying a particular method in a particular class.
MethodWarningSuppressor  
NewResults  
OpcodeStack tracks the types and numbers of objects that are currently on the operand stack throughout the execution of method.
OpcodeStack.Item  
PackageMemberAnnotation Abstract base class for BugAnnotations describing constructs which are contained in a Java package.
PackageStats Class to store package bug statistics.
PackageStats.ClassStats  
PackageWarningSuppressor  
Plugin A FindBugs plugin.
PluginLoader Loader for a FindBugs plugin.
PrintingBugReporter A simple BugReporter which simply prints the formatted message to the output stream.
Project A project in the GUI.
ProjectStats Statistics resulting from analyzing a project.
QueryBugAnnotations Search for bug instances whose text annotations contain one of a set of keywords.
RecursiveFileSearch Recursively search a directory, its subdirectories, etc.
ResourceCollection<Resource> A ResourceCollection defines all of the resources created and used in a particular method.
ResourceCreationPoint A resource creation point.
ResourceTrackingDetector<Resource,ResourceTrackerType extends ResourceTracker<Resource>> Abstract implementation of a Detector to find methods where a particular kind of created resource is not cleaned up or closed properly.
SAXBugCollectionHandler Build a BugCollection based on SAX events.
SelfCalls Build a call graph of the self calls in a class.
ShowHelp Show command line help.
SloppyBugComparator Very sloppy bug comparator: if the warnings are of the same type, and in the same class/method/field, assume they are the same.
SortedBugCollection An implementation of BugCollection that keeps the BugInstances sorted by class (using the native comparison ordering of BugInstance's compareTo() method as a tie-breaker).
SortedBugCollection.BugInstanceComparator  
SortedBugCollection.MultiversionBugInstanceComparator  
SortingBugReporter A BugReporter which stores all of the reported bug instances, and sorts them by class name before printing them.
SourceLineAnnotation A BugAnnotation that records a range of source lines in a class.
StringAnnotation Bug annotation class for integer values.
SuppressionMatcher  
SwitchHandler  
SwitchHandler.SwitchDetails  
TextUIBugReporter Base class for BugReporters which provides convenient formatting and reporting of warnings and analysis errors.
TigerSubstitutes This class provides substitutes for 1.5 methods that we don't want to depend upon in FindBugs.
Token Simple token class.
Tokenizer A simple tokenizer for Java source text.
Version Version number and release date information.
VersionInsensitiveBugComparator Compare bug instances by only those criteria which we would expect to remain constant between versions.
WarningSuppressor  
XDocsBugReporter BugReporter to output warnings in xdocs format for Maven.
XMLBugReporter Report warnings as an XML document.
 

Exception Summary
FatalException A fatal exception which should completely halt the FindBugs analysis.
JavaVersionException Exception indicating that a Java version string couldn't be parsed.
PluginException An exception to indicate that a plugin could not be loaded.
 

Package edu.umd.cs.findbugs Description

Main package for the FindBugs application - contains the engine class (FindBugs), the object model classes for bug instances (BugInstance, BugAnnotation), and other miscellany.