CSHARP.IDEF.EQUALS.NONOBJ : equals Parameter Should Be Object (C#)

JavaScript is not currently enabled, but is required for full CodeSonar manual search and browse functionality.

If you are viewing this file in your hub's Web GUI, enable JavaScript in your browser: you will also need it for GUI functionality.

If you opened this file directly from disk, your browser may be directly suppressing JavaScript functionality: certain browsers perform this suppression on local files (but not files delivered by web servers) for security reasons.

If you access the manual through the hub's Web GUI, the functionality will not be suppressed because the hub is a web server.
Alternatively, your browser may allow you to explicitly disable the security setting that suppresses functionality. See the CodeSonar FAQ for more information.

CodeSonar^® 9.2p0

CONFIDENTIAL

CodeSecure Inc

CSHARP.IDEF.EQUALS.NONOBJ : equals Parameter Should Be Object (C#)

Summary

Equals() is defined against a class other than Object.

Redefinitions of the Equals()/GetHashCode() methods from System.Object must be consistent in the sense that, for instance, if two objects are Equals() then GetHashCode() must yield the same value on both. The validity of such a property is in general undecidable, but most incorrect definitions amount to simple cases, where one of the two methods is missing. However, it is often correct to redefine only one of those methods and the analyzer is aware of many such situations.

Inconsistent definitions of Equals()/GetHashCode() induce unexpected behaviors when objects are put inside most collection classes of the standard .NET library.

Properties

Class Name

equals Parameter Should Be Object (C#)

Significance

reliability

Mnemonic

CSHARP.IDEF.EQUALS.NONOBJ

Example

public class Foo {
    private string f;
    
    public Foo(string f) 
    {
        this.f = f;
    }

    public bool Equals(Foo other) // "equals Parameter Should Be Object (C#)" warning issued here
    {
        return f.Equals(other.f);
    }
}

The Equals method should be rewritten as follows.

 public bool Equals(Object obj) {
    
      Foo other = obj as Foo;
      if (other == null)
         return false;
      else
         return f.Equals(other.f);

    }

Resolution

Use Object type as type parameter of Equals method declaration.

Relevant Configuration File Parameters

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

To report problems with this documentation, please visit https://support.codesecure.com/.