SpotBugs manual

This manual is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike License. To view a copy of this license, visit creativecommons.org or send a letter to Creative Commons, 559 Nathan Abbott Way, Stanford, California 94305, USA.

The name FindBugs and the FindBugs logo are trademarked by the University of Maryland.

Indices and tables

• Search Page

Contents

• Introduction
• Requirements
  • Supported Java version
• Installing
  • Extracting the Distribution
• Running SpotBugs
  • Quick Start
  • Executing SpotBugs
  • Command-line Options
• Using the SpotBugs GUI
  • Creating a Project
  • Running the Analysis
  • Browsing Results
  • Saving and Opening
• Using the SpotBugs Eclipse plugin
  • Requirements
  • Installation
  • Using the Plugin
  • Extending the Eclipse Plugin (since 2.0.0)
  • Troubleshooting
• Using the SpotBugs Ant task
  • Installing the Ant task
  • Modifying build.xml
  • Executing the task
  • Parameters
• Using the SpotBugs Maven Plugin
  • Add spotbugs-maven-plugin to your pom.xml
  • Integrate Find Security Bugs into spotbugs-maven-plugin
  • Goals of spotbugs-maven-plugin
• Using the SpotBugs Gradle Plugin
  • Use SpotBugs Gradle Plugin
  • Tasks introduced by this Gradle Plugin
  • Configure Gradle Plugin
  • Introduce SpotBugs Plugin
  • Other usage
• Filter file
  • Introduction to Filter Files
  • Types of Match clauses
  • Java element name matching
  • Caveats
  • Examples
  • Complete Example
• Analysis Properties
• Effort
• Implement SpotBugs plugin
  • Create Maven project
  • Write java code to represent bug to find
  • Write test case to ensure your detector can find bug
  • Write java code to avoid false-positive
  • Update detector to pass all unit tests
  • Update findbugs.xml
  • Update messages.xml
• Use SpotBugs Plugin on SonarQube
  • Create Maven Project
  • Generate rules.xml
  • Update RulesDefinition.java
  • Update Plugin.java
  • Deploy onto SonarQube
• SpotBugs FAQ
  • Q1: I’m getting java.lang.UnsupportedClassVersionError when I try to run SpotBugs
  • Q2: SpotBugs is running out of memory, or is taking a long time to finish
  • Q3: What is the “auxiliary classpath”? Why should I specify it?
  • Q4: The Eclipse plugin doesn’t load
  • Q5: I’m getting a lot of false “OS” and “ODR” warnings
  • Q6: The Eclipse plugin loads, but doesn’t work correctly
  • Q7: Where is the Maven plugin for SpotBugs?
• SpotBugs Links
  • IDE Integration
  • SpotBugs Plugins
  • Similar/Related Tools
• Bug descriptions
  • Bad practice (BAD_PRACTICE)
  • Correctness (CORRECTNESS)
  • Experimental (EXPERIMENTAL)
  • Internationalization (I18N)
  • Malicious code vulnerability (MALICIOUS_CODE)
  • Multithreaded correctness (MT_CORRECTNESS)
  • Bogus random noise (NOISE)
  • Performance (PERFORMANCE)
  • Security (SECURITY)
  • Dodgy code (STYLE)
• Detectors
  • Standard detectors
  • Disabled detectors
• Guide for migration from SpotBugs 3.1 to 4.0
  • for SpotBugs Users
  • for Plugin Developers
• Guide for migration from FindBugs 3.0 to SpotBugs 3.1
  • com.google.code.findbugs:findbugs
  • com.google.code.findbugs:jsr305
  • com.google.code.findbugs:findbugs-annotations
  • com.google.code.findbugs:annotations
  • FindBugs Ant task
  • FindBugs Maven plugin
  • FindBugs Gradle plugin
  • FindBugs Eclipse plugin
• Annotations
  • edu.umd.cs.findbugs.annotations.CheckForNull
  • edu.umd.cs.findbugs.annotations.CheckReturnValue
  • edu.umd.cs.findbugs.annotations.CleanupObligation
  • edu.umd.cs.findbugs.annotations.CreatesObligation
  • edu.umd.cs.findbugs.annotations.DefaultAnnotation
  • edu.umd.cs.findbugs.annotations.DefaultAnnotationForFields
  • edu.umd.cs.findbugs.annotations.DefaultAnnotationForMethods
  • edu.umd.cs.findbugs.annotations.DefaultAnnotationForParameters
  • edu.umd.cs.findbugs.annotations.DesireNoWarning (Deprecated)
  • edu.umd.cs.findbugs.annotations.DesireWarning (Deprecated)
  • edu.umd.cs.findbugs.annotations.DischargesObligation
  • edu.umd.cs.findbugs.annotations.ExpectWarning (Deprecated)
  • edu.umd.cs.findbugs.annotations.NonNull
  • edu.umd.cs.findbugs.annotations.NoWarning (Deprecated)
  • edu.umd.cs.findbugs.annotations.Nullable
  • edu.umd.cs.findbugs.annotations.OverrideMustInvoke
  • edu.umd.cs.findbugs.annotations.PossiblyNull (Deprecated)
  • edu.umd.cs.findbugs.annotations.ReturnValuesAreNonnullByDefault
  • edu.umd.cs.findbugs.annotations.SuppressFBWarnings
  • edu.umd.cs.findbugs.annotations.SuppressWarnings (Deprecated)
  • edu.umd.cs.findbugs.annotations.UnknownNullness
  • edu.umd.cs.findbugs.annotations.CleanupObligation (Deprecated)
  • edu.umd.cs.findbugs.annotations.CreatesObligation (Deprecated)
  • edu.umd.cs.findbugs.annotations.DischargesObligation (Deprecated)