| 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.
|
| Java Source File Name | Type | Comment |
| AbstractBugReporter.java | Class | An abstract class which provides much of the functionality
required of all BugReporter objects. |
| AddAnnotation.java | Class | Add an annotation string to every BugInstance in a BugCollection. |
| AddMessages.java | Class | Add human-readable messages to a dom4j tree containing
FindBugs XML output. |
| AnalysisCacheToRepositoryAdapter.java | Class | An implementation of org.apache.bcel.util.Repository that
uses the AnalysisCache as its backing store. |
| AnalysisError.java | Class | Object recording a recoverable error that occurred during analysis. |
| AnalysisLocal.java | Class | |
| Analyze.java | Class | |
| AppVersion.java | Class | A version of an analyzed application. |
| BugAccumulator.java | Class | Accumulate warnings that may occur at multiple source locations,
consolidating them into a single warning. |
| BugAnnotation.java | Interface | An object providing context information about a particular BugInstance. |
| BugAnnotationUtil.java | Class | Utility methods for BugAnnotation classes. |
| BugAnnotationVisitor.java | Interface | |
| BugCategory.java | Class | A BugCategory object collects all of the metadata
for a category of bugs. |
| BugCode.java | Class | A BugCode is an abbreviation that is shared among some number
of BugPatterns. |
| BugCollection.java | Interface | |
| BugCollectionBugReporter.java | Class | |
| BugDesignation.java | Class | |
| BugInstance.java | Class | An instance of a bug pattern.
A BugInstance consists of several parts:
- the type, which is a string indicating what kind of bug it is;
used as a key for the FindBugsMessages resource bundle
- the priority; how likely this instance is to actually be a bug
- a list of annotations
The annotations describe classes, methods, fields, source locations,
and other relevant context information about the bug instance.
Every BugInstance must have at least one ClassAnnotation, which
describes the class in which the instance was found. |
| BugInstanceTest.java | Class | |
| BugPattern.java | Class | A BugPattern object collects all of the metadata for a particular
species of BugInstance. |
| BugProperty.java | Class | Name/value metadata pair that may be attached to a BugInstance. |
| BugReporter.java | Interface | Generic interface for bug reporter objects. |
| BugReporterObserver.java | Interface | Observer to determine when a BugReporter reports a bug. |
| ByteCodePatternDetector.java | Class | A base class for bug detectors that are based on a ByteCodePattern. |
| BytecodeScanningDetector.java | Class | Base class for Detectors which want to extend DismantleBytecode. |
| CallGraph.java | Class | |
| CallGraphEdge.java | Class | |
| CallGraphNode.java | Class | |
| CallSite.java | Class | The site of a method call. |
| CategoryFilteringBugReporter.java | Class | Filter reported warnings by category. |
| ClassAnnotation.java | Class | A BugAnnotation object specifying a Java class involved in the bug. |
| ClassScreener.java | Class | Class to pre-screen class files, so that only a subset are
analyzed. |
| ClassScreenerTest.java | Class | |
| ClassWarningSuppressor.java | Class | |
| DeepSubtypeAnalysis.java | Class | |
| DelegatingBugReporter.java | Class | A BugReporter which delegates all method calls to another BugReporter. |
| Detector.java | Interface | The interface which all bug pattern detectors must implement. |
| Detector2.java | Interface | Detector interface for new bytecode-framework-neutral architecture. |
| DetectorFactory.java | Class | A DetectorFactory is responsible for creating instances of Detector objects
and for maintaining meta-information about the detector class. |
| DetectorFactoryChooser.java | Interface | Predicate for choosing DetectorFactory objects. |
| DetectorFactoryCollection.java | Class | The DetectorFactoryCollection stores all of the DetectorFactory objects
used to create the Detectors which implement the various analyses. |
| DetectorToDetector2Adapter.java | Class | An adapter allowing classes implementing the Detector interface
to support the new Detector2 interface. |
| EmacsBugReporter.java | Class | BugReporter to output warnings in Emacs format. |
| ErrorCountingBugReporter.java | Class | A delegating bug reporter which counts reported bug instances,
missing classes, and serious analysis errors. |
| ExcludingHashesBugReporter.java | Class | |
| ExitCodes.java | Interface | Flags returned in the process exit code returned when
the FindBugs text UI is invoked with the -exitcode
command line argument. |
| FatalException.java | Class | A fatal exception which should completely halt the FindBugs analysis. |
| FieldAnnotation.java | Class | A BugAnnotation specifying a particular field in particular class. |
| FieldWarningSuppressor.java | Class | |
| FilterBugReporter.java | Class | |
| FindBugs.java | Class | An instance of this class is used to apply the selected set of
analyses on some collection of Java classes. |
| FindBugs2.java | Class | FindBugs driver class. |
| FindBugsAnalysisFeatures.java | Class | Boolean-valued analysis properties for FindBugs. |
| FindBugsCommandLine.java | Class | Base class for FindBugs command line classes. |
| FindBugsDisplayFeatures.java | Class | |
| FindBugsMessageFormat.java | Class | Format the message for a BugInstance.
This class works in much the same way as java.text.MessageFormat;
however, each placeholder may have an optional "key" which specifies
how the object at that position should be formatted.
Example:
new FindBugsMessageFormat("BUG: {1} does something bad to field {2.fullField}")
In this example, the method annotation at position 1 is formatted using
the empty (default) key. |
| FindBugsProgress.java | Interface | A callback that may be installed in a FindBugs instance
to asynchronously keep track of its progress. |
| FindBugsTestCase.java | Class | Abstract base class for TestCase classes that need to
run in the context of a FindBugs2 object doing a full
execution. |
| Footprint.java | Class | Class to maintain a snapshot of a processes's time and memory usage. |
| FuzzyBugComparator.java | Class | A slightly more intellegent way of comparing BugInstances from two versions
to see if they are the "same". |
| HTMLBugReporter.java | Class | |
| I18N.java | Class | Singleton responsible for returning localized strings for information
returned to the user. |
| IClassScreener.java | Interface | Screen class files to decide which subset of them to analyze. |
| IFindBugsEngine.java | Interface | Interface for a FindBugs engine class. |
| InstructionScanner.java | Interface | A scanner for implementing a state machine over a sequence
of instructions and control edges. |
| InstructionScannerDriver.java | Class | Drive an InstructionScannerGenerator over the instructions of
a simple path. |
| InstructionScannerGenerator.java | Interface | Class for generating InstructionScanners at particular instructions of a path. |
| IntAnnotation.java | Class | Bug annotation class for integer values. |
| InterproceduralFirstPassDetector.java | Interface | Detector implementing a slow first pass to collect
interprocedural properties for a later detector pass.
We assign these a special interface because they are
probably too slow to be enabled by default. |
| JavaVersion.java | Class | Support for finding out what version of Java we're running on. |
| JavaVersionException.java | Class | Exception indicating that a Java version
string couldn't be parsed. |
| JUnitDetectorAdapter.java | Class | A special Detector2 class designed to run some JUnit test code. |
| L10N.java | Class | |
| LaunchAppropriateUI.java | Class | |
| LocalVariableAnnotation.java | Class | |
| Lookup.java | Class | |
| MethodAnnotation.java | Class | A BugAnnotation specifying a particular method in a particular class. |
| MethodWarningSuppressor.java | Class | |
| NewResults.java | Class | |
| NoClassesFoundToAnalyzeException.java | Class | Signals that FindBugs found no classes on the classpath it was invoked to
analyze. |
| NonReportingDetector.java | Interface | A Detector which does not report warnings. |
| NoOpFindBugsProgress.java | Class | |
| OpcodeStack.java | Class | tracks the types and numbers of objects that are currently on the operand stack
throughout the execution of method. |
| OpcodeStackItemTest.java | Class | |
| PackageMemberAnnotation.java | Class | Abstract base class for BugAnnotations describing constructs
which are contained in a Java package. |
| PackageStats.java | Class | Class to store package bug statistics. |
| PackageWarningSuppressor.java | Class | |
| Plugin.java | Class | A FindBugs plugin. |
| PluginException.java | Class | An exception to indicate that a plugin could not be loaded. |
| PluginLoader.java | Class | Loader for a FindBugs plugin.
A plugin is a jar file containing two metadata files,
"findbugs.xml" and "messages.xml". |
| PrintingBugReporter.java | Class | A simple BugReporter which simply prints the formatted message
to the output stream. |
| Priorities.java | Interface | |
| Project.java | Class | A project in the GUI. |
| ProjectStats.java | Class | Statistics resulting from analyzing a project. |
| QueryBugAnnotations.java | Class | Search for bug instances whose text annotations contain
one of a set of keywords. |
| RecursiveFileSearch.java | Class | Recursively search a directory, its subdirectories, etc. |
| ResourceCollection.java | Class | A ResourceCollection defines all of the resources created
and used in a particular method. |
| ResourceCreationPoint.java | Class | A resource creation point. |
| ResourceTrackingDetector.java | Class | Abstract implementation of a Detector to find methods where a
particular kind of created resource is not cleaned up
or closed properly. |
| RunnableWithExceptions.java | Interface | |
| SAXBugCollectionHandler.java | Class | Build a BugCollection based on SAX events. |
| SelfCalls.java | Class | Build a call graph of the self calls in a class. |
| ShowHelp.java | Class | Show command line help. |
| SloppyBugComparator.java | Class | 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.java | Class | 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). |
| SortingBugReporter.java | Class | A BugReporter which stores all of the reported bug instances,
and sorts them by class name before printing them. |
| SourceLineAnnotation.java | Class | A BugAnnotation that records a range of source lines
in a class. |
| StatelessDetector.java | Interface | is a marker interface for detectors that don't save state from one
class file to the next.
If a detector implements this interface, a clone will be generated for each element it is applied to.
The idea of using this interface is questionable. |
| StringAnnotation.java | Class | Bug annotation class for integer values. |
| SuppressionMatcher.java | Class | |
| SwitchHandler.java | Class | |
| SystemProperties.java | Class | |
| TextUIBugReporter.java | Class | Base class for BugReporters which provides convenient formatting
and reporting of warnings and analysis errors. |
| TextUICommandLine.java | Class | Helper class to parse the command line and configure
the IFindBugsEngine object. |
| TigerSubstitutes.java | Class | This class provides substitutes for 1.5 methods that we don't want to depend upon in
FindBugs. |
| TigerSubstitutesTest.java | Class | |
| Token.java | Class | Simple token class. |
| Tokenizer.java | Class | A simple tokenizer for Java source text. |
| TrainingDetector.java | Interface | Interface to mark Detector classes which are used only as
a training pass. |
| TypeAnnotation.java | Class | Bug annotation class for java types. |
| UseAnnotationDatabase.java | Interface | A marker interface for detectors which use an AnnotationDatabase. |
| Version.java | Class | Version number and release date information. |
| VersionInsensitiveBugComparator.java | Class | Compare bug instances by only those criteria which we would expect to
remain constant between versions. |
| WarningComparator.java | Interface | |
| WarningSuppressor.java | Class | |
| XDocsBugReporter.java | Class | BugReporter to output warnings in xdocs format for Maven. |
| XMLBugReporter.java | Class | Report warnings as an XML document. |
| XMLWriteableWithMessages.java | Interface | Write an object to XMLOutput while optionally adding
descriptive messages. |