Is there a way to ignore a single FindBugs warning

Question

With PMD  if you want to ignore a specific warning  you can use    NOPMD to have that line be ignored   Is there something similar for FindBugs

User · Answer

While other answers on here are valid  they re not a full recipe for solving this   In the spirit of completeness   You need to have the findbugs annotations in your pom file - they re only compile time  so you can use the provided scope    lt dependency gt     lt groupId gt com google code findbugs lt  groupId gt     lt artifactId gt findbugs-annotations lt  artifactId gt     lt version gt 3 0 1 lt  version gt     lt scope gt provided lt  scope gt   lt  dependency gt    This allows the use of  SuppressFBWarnings there is another dependency which provides  SuppressWarnings  However  the above is clearer   Then you add the annotation above your method   E g    SuppressFBWarnings value    RCN REDUNDANT NULLCHECK WOULD HAVE BEEN A NPE           justification    Scanning generated code of try-with-resources    Override public String get         try  InputStream resourceStream    owningType getClassLoader   getResourceAsStream resourcePath            BufferedReader reader   new BufferedReader new InputStreamReader resourceStream  UTF 8              This includes both the name of the bug and also a reason why you re disabling the scan for it

User · Answer

Here is a more complete example of an XML filter  the example above by itself will not work since it just shows a snippet and is missing the  lt FindBugsFilter gt  begin and end tags     lt FindBugsFilter gt       lt Match gt           lt Class name  com mycompany foo    gt           lt Method name  bar    gt           lt Bug pattern  NP BOOLEAN RETURN NULL    gt       lt  Match gt   lt  FindBugsFilter gt    If you are using the Android Studio FindBugs plugin  browse to your XML filter file using File- Other Settings- Default Settings- Other Settings- FindBugs-IDEA- Filter- Exclude filter files- Add

User · Answer

The FindBugs initial approach involves XML configuration files aka filters  This is really less convenient than the PMD solution but FindBugs works on bytecode  not on the source code  so comments are obviously not an option  Example    lt Match gt      lt Class name  com mycompany Foo    gt      lt Method name  bar    gt      lt Bug pattern  DLS DEAD STORE OF CLASS LITERAL    gt   lt  Match gt    However  to solve this issue  FindBugs later introduced another solution based on annotations  see SuppressFBWarnings  that you can use at the class or at the method level  more convenient than XML in my opinion   Example  maybe not the best one but  well  it s just an example     edu umd cs findbugs annotations SuppressFBWarnings      value  HE EQUALS USE HASHCODE        justification  I know what I m doing     Note that since FindBugs 3 0 0 SuppressWarnings has been deprecated in favor of  SuppressFBWarnings because of the name clash with Java s SuppressWarnings

User · Answer

As others Mentioned  you can use the  SuppressFBWarnings Annotation  If you don t want or can t add another Dependency to your code  you can add the Annotation to your Code yourself  Findbugs dosn t care in which Package the Annotation is    Retention RetentionPolicy CLASS  public  interface SuppressFBWarnings                  The set of FindBugs warnings that are to be suppressed in        annotated element  The value can be a bug category  kind or pattern                     String   value   default                     Optional documentation of the reason why the warning is suppressed             String justification   default         Source  https   sourceforge net p findbugs feature-requests 298  5e88

User · Answer

I m going to leave this one here  https   stackoverflow com a 14509697 1356953  Please note that this works with java lang SuppressWarningsso no need to use a separate annotation       SuppressWarnings on a field only suppresses findbugs warnings   reported for that field declaration  not every warning associated with   that field       For example  this suppresses the  Field only ever set to null    warning        SuppressWarnings  UWF NULL FIELD   String s   null  I think the best   you can do is isolate the code with the warning into the smallest   method you can  then suppress the warning on the whole method

User · Answer

Update Gradle   dependencies       compile group   findbugs   name   findbugs   version   1 0 0      Locate the FindBugs Report     file    Users your user IdeaProjects projectname build reports findbugs main html   Find the specific message     Import the correct version of the annotation  import edu umd cs findbugs annotations SuppressWarnings    Add the annotation directly above the offending code   SuppressWarnings  OUT OF RANGE ARRAY INDEX     See here for more info  findbugs Spring Annotation

User · Answer

At the time of writing this  May 2018   FindBugs seems to have been replaced by SpotBugs  Using the SuppressFBWarnings annotation requires your code to be compiled with Java 8 or later and introduces a compile time dependency on spotbugs-annotations jar   Using a filter file to filter SpotBugs rules has no such issues  The documentation is here

[java] Is there a way to ignore a single FindBugs warning?

Examples related to java

Examples related to warnings

Examples related to findbugs

Examples related to suppress-warnings