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

Interface	Description
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.
Detector2	Detector interface for new bytecode-framework-neutral architecture.
DetectorFactoryChooser	Predicate for choosing DetectorFactory objects.
DiscoverSourceDirectories.Progress	Progress callback interface for reporting the progress of source directory discovery.
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.
FirstPassDetector	A Detector that can be run in the first pass.
GlobalOptions
IClassScreener	Screen class files to decide which subset of them to analyze.
IFindBugsEngine	Interface for a FindBugs engine class.
IGuiCallback	Interface for any kind of GUI attached to the current FindBug analysis
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.
Priorities
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.
UseAnnotationDatabase	A marker interface for detectors which use an AnnotationDatabase.
WarningComparator
XMLWriteableWithMessages	Write an object to XMLOutput while optionally adding descriptive messages.

Class Summary

Class	Description
AbstractBugReporter	An abstract class which provides much of the functionality required of all BugReporter objects.
AbstractBugReporter.Error
AddMessages	Add human-readable messages to a dom4j tree containing FindBugs XML output.
AnalysisCacheToRepositoryAdapter	An implementation of org.apache.bcel.util.Repository that uses the AnalysisCache as its backing store.
AnalysisError	Object recording a recoverable error that occurred during analysis.
AnalysisLocal<T>	Deprecated This class is not necessary to realize multi-thread model in SpotBugs 4.0.
AnalysisOptions
Analyze
AppVersion	A version of an analyzed application.
AWTEventQueueExecutor
BugAccumulator	Accumulate warnings that may occur at multiple source locations, consolidating them into a single warning.
BugAnnotationUtil	Utility methods for BugAnnotation classes.
BugAnnotationWithSourceLines
BugCategory	A BugCategory object collects all of the metadata for a category of bugs.
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.
BugRanker	Bug rankers are used to compute a bug rank for each bug instance.
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.
CategoryFilteringBugReporter	Filter reported warnings by category.
CheckBcel	Check that the BCEL classes present seem to be the right ones.
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
CommandLineUiCallback	Implementation of the UI callback for command line sessions.
ComponentPlugin<T>
DeepSubtypeAnalysis
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.
DetectorToDetector2Adapter	An adapter allowing classes implementing the Detector interface to support the new Detector2 interface.
DiscoverSourceDirectories	Based on the contents of the application directories/archives in a Project, and a "root" source directory (under which some number of "real" source directories may be located), scan to find the source directories containing the application's source files.
EmacsBugReporter	BugReporter to output warnings in Emacs format.
ErrorCountingBugReporter	A delegating bug reporter which counts reported bug instances, missing classes, and serious analysis errors.
ExcludingHashesBugReporter
FieldAnnotation	A BugAnnotation specifying a particular field in particular class.
FieldWarningSuppressor
FilterBugReporter
FindBugs	Static methods and fields useful for working with instances of IFindBugsEngine.
FindBugs2	FindBugs driver class.
FindBugsAnalysisFeatures	Boolean-valued analysis properties for FindBugs.
FindBugsCommandLine	Base class for FindBugs command line classes.
FindBugsDisplayFeatures
FindBugsMain
FindBugsMessageFormat	Format the message for a BugInstance.
Footprint	Class to maintain a snapshot of a processes's time and memory usage.
Footprint.CollectionBeanWrapper	Wrapper so that possible NoClassDefFoundError can be caught.
Footprint.MemoryBeanWrapper	Wrapper so that possible NoClassDefFoundError can be caught.
Footprint.OperatingSystemBeanWrapper	Wrapper so that possible 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.
IGuiCallback.FormItem
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.
L10N
LaunchAppropriateUI	Class to launch the appropriate textUI or GUI.
LocalVariableAnnotation	Bug annotation class for local variable names
Lookup
MethodAnnotation	A BugAnnotation specifying a particular method in a particular class.
MethodWarningSuppressor
NewResults	Deprecated
NonReportingDetectorToDetector2Adapter
NoOpFindBugsProgress
Obfuscate
OpcodeStack	tracks the types and numbers of objects that are currently on the operand stack throughout the execution of method.
OpcodeStack.Item
OpcodeStack.JumpInfo
OpcodeStack.JumpInfoFactory
PackageMemberAnnotation	Abstract base class for BugAnnotations describing constructs which are contained in a Java package.
PackageStats
PackageStats.ClassStats
PackageWarningSuppressor
ParameterWarningSuppressor
Plugin	A FindBugs plugin.
PluginLoader	Loader for a FindBugs plugin.
PluginLoader.Summary
PrintingBugReporter	A simple BugReporter which simply prints the formatted message to the output stream.
ProgramPoint
Project	A project in the GUI.
ProjectPackagePrefixes
ProjectPackagePrefixes.PrefixFilter
ProjectStats	Statistics resulting from analyzing a project.
PropertyBundle
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.
StackMapAnalyzer
StackMapAnalyzer.StackMapAnalysisFactory
StartTime
StringAnnotation	Bug annotation class for string values.
SuppressionMatcher
SwitchHandler
SwitchHandler.SwitchDetails
SystemProperties
TextUIBugReporter	Base class for BugReporters which provides convenient formatting and reporting of warnings and analysis errors.
TextUICommandLine	Helper class to parse the command line and configure the IFindBugsEngine object.
TextUIProgressCallback	Display FindBugs progress in the terminal window using ASCII codes.
Token	Simple token class.
Tokenizer	A simple tokenizer for Java source text.
TypeAnnotation	Bug annotation class for java types.
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.

Enum Summary

Enum	Description
BugRankCategory	Smaller value is scarier

Exception Summary

Exception	Description
BugInstance.NoSuchBugPattern
FatalException	A fatal exception which should completely halt the FindBugs analysis.
JavaVersionException	Exception indicating that a Java version string couldn't be parsed.
NoClassesFoundToAnalyzeException	Signals that FindBugs found no classes on the classpath it was invoked to analyze.
PluginDoesntContainMetadataException
PluginException	An exception to indicate that a plugin could not be loaded.

Annotation Types Summary

Annotation Type	Description
OpcodeStack.CustomUserValue	You can put this annotation on a OpcodeStack detector to indicate that it uses OpcodeStack.Item.userValue, and thus should not reuse generic OpcodeStack information from an iterative evaluation of the opcode stack.
OpcodeStack.Item.SpecialKind	A type qualifier to mark int value as SpecialKind type.

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.