C#


CSHARP.CLASS.IOF.BAD : Inappropriate Instanceof (C#)

Summary

The code contains type-testing that should not be used.

Properties

Class Name Inappropriate Instanceof (C#)
Significance reliability
Mnemonic CSHARP.CLASS.IOF.BAD
Categories
CWE CWE:1076 Insufficient Adherence to Expected Conventions
Availability Available for C# 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 (C#)"

Example

public class MyClass 
{

  public string s
  
  public override boolean Equals(Object obj) 
  {
    if(obj != null )
      if (obj is string)    // "Inappropriate Instanceof (C#)" warning issued here 
                            // - expect instance check inside MyClass.Equals() to check MyClass (or a subclass of MyClass, if any) 
        return s.equals(obj);
      
    return false;
  }
}

In this example, the programmer should modify the Equals as follows:

  public override boolean Equals(Object obj) 
  {
    if(obj != null )
      if (obj is MyClass)
        return s.equals(((MyClass) obj).s);
      
    return false;
  }

Resolution

Check if the is 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.