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  
BugReporter Generic interface for bug reporter objects.
BugReporterObserver Observer to determine when a BugReporter reports a bug.
CountBugs.Key  
CountBugs.KeyFactory  
Detector The interface which all bug pattern detectors must implement.
ExitCodes Flags returned in the process exit code returned when the FindBugs text UI is invoked with the -exitcode command line argument.
FindBugs.Chooser Handling callback for choose() method, used to implement the -chooseVisitors and -choosePlugins options.
FindBugs.ClassProducer Interface for an object representing a source of class files to analyze.
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.
Matcher  
Plugin.FactoryChooser  
URLClassPath.Entry Interface describing a single classpath entry.
 

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.
AnalysisLocal<T>  
AndMatcher  
BugCode A BugCode is an abbreviation that is shared among some number of BugPatterns.
BugCodeMatcher  
BugCollection Abstract base class for collections of BugInstance objects and error messages associated with analysis.
BugCollectionBugReporter  
BugHistory Analyze bug results to find new, fixed, and retained bugs between versions of the same program.
BugInstance An instance of a bug pattern.
BugPattern A BugPattern object collects all of the metadata for a particular species of 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.
CategorizeBugs  
CategorizeBugs.Stats  
ClassAnnotation A BugAnnotation object specifying a Java class involved in the bug.
ClassMatcher  
ClassRegexMatcher  
ClassScreener Class to pre-screen class files, so that only a subset are analyzed.
ClassWarningSuppressor  
CommandLine Helper class for parsing command line arguments.
CompoundMatcher  
CountBugs Count bugs in a result file by category.
CountBugs.CategoryKey  
CountBugs.CategoryKeyFactory  
CountBugs.KingdomAndPriorityKey  
CountBugs.KingdomAndPriorityKeyFactory  
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.
DetectorOrderingConstraint An ordering constraint which must be taken into account when Detectors are run.
EmacsBugReporter BugReporter to output warnings in Emacs format.
FieldAnnotation A BugAnnotation specifying a particular field in particular class.
FieldWarningSuppressor  
Filter  
FilterBugReporter  
FindBugs An instance of this class is used to apply the selected set of analyses on some collection of Java classes.
FindBugs.ArchiveWorkListItem Work list item specifying a file/directory/URL containing class files to analyze.
FindBugs.CategoryFilteringBugReporter  
FindBugs.ErrorCountingBugReporter A delegating bug reporter which counts reported bug instances, missing classes, and serious analysis errors.
FindBugs.FindBugsCommandLine Helper class to parse the command line and create the FindBugs engine object.
FindBugs.NoCloseInputStream Delegating InputStream wrapper that never closes the underlying input stream.
FindBugsMessageFormat Format the message for a BugInstance.
FindExamples Find bug instances annotated with "GOOD_EXAMPLE" or "EXCELLENT_EXAMPLE".
GraphIS2FalsePositives Graph IS2 (inconsistent synchronization) false positive rate as a function of cutoff percent for number of unsynchronized accesses.
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.
Lookup  
MergeResults Merge a saved results file (containing annotations) with a new results file.
MethodAnnotation A BugAnnotation specifying a particular method in a particular class.
MethodMatcher  
MethodWarningSuppressor  
NewResults  
OpcodeStack tracks the types and numbers of objects that are currently on the operand stack throughout the execution of method.
OpcodeStack.Item  
OrMatcher  
PackageMemberAnnotation Abstract base class for BugAnnotations describing constructs which are contained in a Java package.
PackageStats Class to store package bug statistics.
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.
Project.WorkList Worklist for finding implicit classpath entries.
Project.WorkListItem Worklist item for finding implicit classpath entries.
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.
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  
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.
SuppressionMatcher  
TextUIBugReporter  
Token Simple token class.
Tokenizer A simple tokenizer for Java source text.
UnionResults Compute the union of two sets of bug results, preserving annotations.
URLClassPath A work-alike class to use instead of BCEL's ClassPath class.
URLClassPath.LocalArchiveEntry Classpath entry class to load files from a zip/jar file in the local filesystem.
URLClassPath.LocalDirectoryEntry Classpath entry class to load files from a directory in the local filesystem.
URLClassPath.RemoteArchiveEntry Classpath entry class to load files from a remote archive URL.
URLClassPath.RemoteDirectoryEntry Classpath entry class to load files from a remote directory URL.
URLClassPathRepository BCEL Repository implementation that uses an URLClassPath to find classes.
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
FilterException  
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.