Java


JAVA.CLASS.IOF.BAD : Inappropriate Instanceof (Java)

Summary

The code contains an instanceof test that should not be used.

Properties

Class Name Inappropriate Instanceof (Java)
Significance reliability
Mnemonic JAVA.CLASS.IOF.BAD
Categories
CWE CWE:1076 Insufficient Adherence to Expected Conventions
Availability Available for Java only.
Enabling Checks for this warning class are enabled by default. To disable them, add the following WARNING_FILTER rule to the project configuration file.
WARNING_FILTER += discard class="Inappropriate Instanceof (Java)"

Example

Consider the following program:

public class Foo {

  public String s
  
  @Override
  public boolean equals(Object obj) {
      if(obj != null)
          if (obj instanceof String) /* "Inappropriate Instanceof (Java)" warning issued here
                                      * - should only check for Foo or a class derived from Foo.
                                      */
              return s.equals(obj);
      return false;
  }
}

In this example, the programmer should modify equals() as follows.

  @Override
  public boolean equals(Object obj) {
      if(obj != null)
          if (obj instanceof Foo)
              return s.equals(((Foo) obj).s);
    return false;
  } 

Resolution

Check if the instanceof operator can be actually removed and that it is not the sign of an actual programming bug.

Relevant Configuration File Parameters

The following configuration file parameters affect checks for this warning class.