Método System.Object.Equals

Observação

Este artigo fornece observações complementares à documentação de referência para esta API.

Este artigo refere-se ao Object.Equals(Object) método.

O tipo de comparação entre a instância atual e o obj parâmetro depende se a instância atual é um tipo de referência ou um tipo de valor.

Se a instância atual for um tipo de referência, o método testa a Equals(Object) igualdade de referência e uma chamada para o Equals(Object) método é equivalente a uma chamada para o ReferenceEquals método. Igualdade de referência significa que as variáveis de objeto que são comparadas referem-se ao mesmo objeto. O exemplo a seguir ilustra o resultado dessa comparação. Ele define uma Person classe, que é um tipo de referência, e chama o construtor de Person classe para instanciar dois novos Person objetos person1a e person2, que têm o mesmo valor. Ele também atribui person1a a outra variável de objeto, person1b. Como mostra a saída do exemplo, person1a e person1b são iguais porque fazem referência ao mesmo objeto. No entanto, person1a e person2 não são iguais, embora tenham o mesmo valor.

using System;

// Define a reference type that does not override Equals.
public class Person
{
   private string personName;

   public Person(string name)
   {
      this.personName = name;
   }

   public override string ToString()
   {
      return this.personName;
   }
}

public class Example1
{
   public static void Main()
   {
      Person person1a = new Person("John");
      Person person1b = person1a;
      Person person2 = new Person(person1a.ToString());

      Console.WriteLine("Calling Equals:");
      Console.WriteLine($"person1a and person1b: {person1a.Equals(person1b)}");
      Console.WriteLine($"person1a and person2: {person1a.Equals(person2)}");

      Console.WriteLine("\nCasting to an Object and calling Equals:");
      Console.WriteLine($"person1a and person1b: {((object) person1a).Equals((object) person1b)}");
      Console.WriteLine($"person1a and person2: {((object) person1a).Equals((object) person2)}");
   }
}
// The example displays the following output:
//       person1a and person1b: True
//       person1a and person2: False
//
//       Casting to an Object and calling Equals:
//       person1a and person1b: True
//       person1a and person2: False

// Define a reference type that does not override Equals.
type Person(name) =
    override _.ToString() =
        name

let person1a = Person "John"
let person1b = person1a
let person2 = Person(string person1a)

printfn "Calling Equals:"
printfn $"person1a and person1b: {person1a.Equals person1b}"
printfn $"person1a and person2: {person1a.Equals person2}"

printfn "\nCasting to an Object and calling Equals:"
printfn $"person1a and person1b: {(person1a :> obj).Equals(person1b :> obj)}"
printfn $"person1a and person2: {(person1a :> obj).Equals(person2 :> obj)}"
// The example displays the following output:
//       person1a and person1b: True
//       person1a and person2: False
//
//       Casting to an Object and calling Equals:
//       person1a and person1b: True
//       person1a and person2: False

' Define a reference type that does not override Equals.
Public Class Person1
    Private personName As String

    Public Sub New(name As String)
        Me.personName = name
    End Sub

    Public Overrides Function ToString() As String
        Return Me.personName
    End Function
End Class

Module Example0
    Public Sub Main()
        Dim person1a As New Person1("John")
        Dim person1b As Person1 = person1a
        Dim person2 As New Person1(person1a.ToString())

        Console.WriteLine("Calling Equals:")
        Console.WriteLine("person1a and person1b: {0}", person1a.Equals(person1b))
        Console.WriteLine("person1a and person2: {0}", person1a.Equals(person2))
        Console.WriteLine()

        Console.WriteLine("Casting to an Object and calling Equals:")
        Console.WriteLine("person1a and person1b: {0}", CObj(person1a).Equals(CObj(person1b)))
        Console.WriteLine("person1a and person2: {0}", CObj(person1a).Equals(CObj(person2)))
    End Sub
End Module
' The example displays the following output:
'       Calling Equals:
'       person1a and person1b: True
'       person1a and person2: False
'       
'       Casting to an Object and calling Equals:
'       person1a and person1b: True
'       person1a and person2: False

Se a instância atual for um tipo de valor, o método testa a Equals(Object) igualdade de valor. Igualdade de valor significa o seguinte:

Os dois objetos são do mesmo tipo. Como mostra o exemplo seguinte, um Byte objeto com valor 12 não é igual a um Int32 objeto com valor 12, porque os dois objetos têm tipos de tempo de execução diferentes.

byte value1 = 12;
int value2 = 12;

object object1 = value1;
object object2 = value2;

Console.WriteLine($"{object1} ({object1.GetType().Name}) = {object2} ({object2.GetType().Name}): {object1.Equals(object2)}");

// The example displays the following output:
//        12 (Byte) = 12 (Int32): False

let value1 = 12uy
let value2 = 12

let object1 = value1 :> obj
let object2 = value2 :> obj

printfn $"{object1} ({object1.GetType().Name}) = {object2} ({object2.GetType().Name}): {object1.Equals object2}"

// The example displays the following output:
//        12 (Byte) = 12 (Int32): False

Module Example2
    Public Sub Main()
        Dim value1 As Byte = 12
        Dim value2 As Integer = 12

        Dim object1 As Object = value1
        Dim object2 As Object = value2

        Console.WriteLine("{0} ({1}) = {2} ({3}): {4}",
                        object1, object1.GetType().Name,
                        object2, object2.GetType().Name,
                        object1.Equals(object2))
    End Sub
End Module
' The example displays the following output:
'       12 (Byte) = 12 (Int32): False

Os valores dos campos público e privado dos dois objetos são iguais. O exemplo a seguir testa a igualdade de valor. Ele define uma Person estrutura, que é um tipo de valor, e chama o construtor de Person classe para instanciar dois novos Person objetos person1 e person2, que têm o mesmo valor. Como mostra a saída do exemplo, embora as duas variáveis de objeto se refiram a objetos diferentes, person1 e person2 são iguais porque têm o mesmo valor para o campo privado personName .

using System;

// Define a value type that does not override Equals.
public struct Person3
{
   private string personName;

   public Person3(string name)
   {
      this.personName = name;
   }

   public override string ToString()
   {
      return this.personName;
   }
}

public struct Example3
{
   public static void Main()
   {
      Person3 person1 = new Person3("John");
      Person3 person2 = new Person3("John");

      Console.WriteLine("Calling Equals:");
      Console.WriteLine(person1.Equals(person2));

      Console.WriteLine("\nCasting to an Object and calling Equals:");
      Console.WriteLine(((object) person1).Equals((object) person2));
   }
}
// The example displays the following output:
//       Calling Equals:
//       True
//
//       Casting to an Object and calling Equals:
//       True

// Define a value type that does not override Equals.
[<Struct>]
type Person(personName: string) =
    override _.ToString() =
        personName

let person1 = Person "John"
let person2 = Person "John"

printfn "Calling Equals:"
printfn $"{person1.Equals person2}"

printfn $"\nCasting to an Object and calling Equals:"
printfn $"{(person1 :> obj).Equals(person2 :> obj)}"
// The example displays the following output:
//       Calling Equals:
//       True
//
//       Casting to an Object and calling Equals:
//       True

' Define a value type that does not override Equals.
Public Structure Person4
    Private personName As String

    Public Sub New(name As String)
        Me.personName = name
    End Sub

    Public Overrides Function ToString() As String
        Return Me.personName
    End Function
End Structure

Module Example4
    Public Sub Main()
        Dim p1 As New Person4("John")
        Dim p2 As New Person4("John")

        Console.WriteLine("Calling Equals:")
        Console.WriteLine(p1.Equals(p2))
        Console.WriteLine()

        Console.WriteLine("Casting to an Object and calling Equals:")
        Console.WriteLine(CObj(p1).Equals(p2))
    End Sub
End Module
' The example displays the following output:
'       Calling Equals:
'       True
'       
'       Casting to an Object and calling Equals:
'       True

Como a Object classe é a classe base para todos os tipos no .NET, o Object.Equals(Object) método fornece a comparação de igualdade padrão para todos os outros tipos. No entanto, os tipos muitas vezes substituem o método para implementar a Equals igualdade de valor. Para obter mais informações, consulte as seções Notas para chamadores e Notas para herdeiros.

Notas para o Tempo de Execução do Windows

Quando você chama a sobrecarga de Equals(Object) método em uma classe no Tempo de Execução do Windows, ela fornece o comportamento padrão para classes que não substituem Equals(Object). Isso faz parte do suporte que o .NET fornece para o Windows Runtime (consulte Suporte do .NET para aplicações da Windows Store epara o Windows Runtime). As classes no Tempo de Execução do Windows não herdam Object e, atualmente, não implementam o método Equals(Object). No entanto, eles parecem ter ToString, Equals(Object)e GetHashCode métodos quando você usá-los em seu código C# ou Visual Basic, e .NET fornece o comportamento padrão para esses métodos.

Observação

As classes do Tempo de Execução do Windows, escritas em C# ou Visual Basic, podem substituir a sobrecarga de método Equals(Object).

Notas para quem telefona

As classes derivadas frequentemente substituem o método Object.Equals(Object) para implementar a igualdade de valor. Além disso, os tipos frequentemente também fornecem uma sobrecarga fortemente tipada adicional para o método Equals, normalmente implementando a interface IEquatable<T>. Ao chamar o método Equals para testar igualdade, deve-se saber se a instância atual sobrescreve Object.Equals e entender como uma chamada específica de um método Equals é resolvida. Caso contrário, você pode estar executando um teste de igualdade que é diferente do que você pretendia, e o método pode retornar um valor inesperado.

O exemplo a seguir fornece uma ilustração. Ele instancia três StringBuilder objetos com cadeias de caracteres idênticas e, em seguida, faz quatro chamadas para Equals métodos. A primeira chamada de método retorna true, e as três restantes retornam false.

using System;
using System.Text;

public class Example5
{
   public static void Main()
   {
      StringBuilder sb1 = new StringBuilder("building a string...");
      StringBuilder sb2 = new StringBuilder("building a string...");

      Console.WriteLine($"sb1.Equals(sb2): {sb1.Equals(sb2)}");
      Console.WriteLine($"((Object) sb1).Equals(sb2): {((Object) sb1).Equals(sb2)}");
      Console.WriteLine($"Object.Equals(sb1, sb2): {Object.Equals(sb1, sb2)}");

      Object sb3 = new StringBuilder("building a string...");
      Console.WriteLine($"\nsb3.Equals(sb2): {sb3.Equals(sb2)}");
   }
}
// The example displays the following output:
//       sb1.Equals(sb2): True
//       ((Object) sb1).Equals(sb2): False
//       Object.Equals(sb1, sb2): False
//
//       sb3.Equals(sb2): False

open System
open System.Text

let sb1 = StringBuilder "building a string..."
let sb2 = StringBuilder "building a string..."

printfn $"sb1.Equals(sb2): {sb1.Equals sb2}"
printfn $"((Object) sb1).Equals(sb2): {(sb1 :> obj).Equals sb2}"
                  
printfn $"Object.Equals(sb1, sb2): {Object.Equals(sb1, sb2)}"

let sb3 = StringBuilder "building a string..."
printfn $"\nsb3.Equals(sb2): {sb3.Equals sb2}"
// The example displays the following output:
//       sb1.Equals(sb2): True
//       ((Object) sb1).Equals(sb2): False
//       Object.Equals(sb1, sb2): False
//
//       sb3.Equals(sb2): False

Imports System.Text

Module Example5
    Public Sub Main()
        Dim sb1 As New StringBuilder("building a string...")
        Dim sb2 As New StringBuilder("building a string...")

        Console.WriteLine("sb1.Equals(sb2): {0}", sb1.Equals(sb2))
        Console.WriteLine("CObj(sb1).Equals(sb2): {0}",
                        CObj(sb1).Equals(sb2))
        Console.WriteLine("Object.Equals(sb1, sb2): {0}",
                        Object.Equals(sb1, sb2))

        Console.WriteLine()
        Dim sb3 As Object = New StringBuilder("building a string...")
        Console.WriteLine("sb3.Equals(sb2): {0}", sb3.Equals(sb2))
    End Sub
End Module
' The example displays the following output:
'       sb1.Equals(sb2): True
'       CObj(sb1).Equals(sb2): False
'       Object.Equals(sb1, sb2): False
'
'       sb3.Equals(sb2): False

No primeiro caso, a sobrecarga de método fortemente tipada StringBuilder.Equals(StringBuilder) , que testa a igualdade de valor, é chamada. Como as cadeias de caracteres atribuídas aos dois StringBuilder objetos são iguais, o método retorna true. No entanto, StringBuilder não substitui Object.Equals(Object). Devido a isso, quando o StringBuilder objeto é convertido em um Object, quando uma StringBuilder instância é atribuída a uma variável do tipo Object, e quando o Object.Equals(Object, Object) método recebe dois StringBuilder objetos, o método padrão Object.Equals(Object) é chamado. Como StringBuilder é um tipo de referência, isso equivale a passar os dois StringBuilder objetos para o ReferenceEquals método. Embora todos os três StringBuilder objetos contenham cadeias de caracteres idênticas, eles se referem a três objetos distintos. Como resultado, essas três chamadas de método retornam false.

Você pode comparar o objeto atual com outro objeto para igualdade de referência chamando o ReferenceEquals método. No Visual Basic, você também pode usar a is palavra-chave (por exemplo, If Me Is otherObject Then ...).

Notas para herdeiros

Quando você define seu próprio tipo, esse tipo herda a funcionalidade definida pelo Equals método de seu tipo base. A tabela a seguir lista a implementação padrão do método para as Equals principais categorias de tipos no .NET.

Categoria de tipo	Igualdade definida por	Observações
Classe derivada diretamente de Object	Object.Equals(Object)	Igualdade de referência; equivalente a chamar Object.ReferenceEquals.
Estrutura	ValueType.Equals	Igualdade de valores; comparação direta byte a byte ou comparação campo a campo usando reflexão.
Enumeração	Enum.Equals	Os valores devem ter o mesmo tipo de enumeração e o mesmo valor subjacente.
Delegado	MulticastDelegate.Equals	Os delegados devem ter o mesmo tipo com listas de invocação idênticas.
Interfaz	Object.Equals(Object)	Igualdade de referência.

Para um tipo de valor, deve-se sempre sobrescrever Equals, porque os testes de igualdade que dependem de reflexão resultam em um desempenho inadequado. Você também pode substituir a implementação padrão de Equals para tipos de referência, a fim de testar a igualdade de valor em vez da igualdade de referência e definir com precisão o significado de igualdade de valor. Tais implementações de Equals retornam true se os dois objetos tiverem o mesmo valor, mesmo que não sejam a mesma instância. O implementador do tipo decide o que constitui o valor de um objeto, mas normalmente são alguns ou todos os dados armazenados nas variáveis de instância do objeto. Por exemplo, o valor de um String objeto é baseado nos caracteres da cadeia de caracteres, o String.Equals(Object) método substitui o Object.Equals(Object) método para retornar true para quaisquer duas instâncias de cadeia de caracteres que contenham os mesmos caracteres na mesma ordem.

O exemplo a seguir mostra como sobrepor o método Object.Equals(Object) para testar a igualdade de valor. Ele substitui o Equals método para a Person classe. Se Person aceitasse sua implementação de classe base de igualdade, dois Person objetos seriam iguais apenas se fizessem referência a um único objeto. No entanto, neste caso, dois Person objetos são iguais se tiverem o mesmo valor para a Person.Id propriedade.

public class Person6
{
   private string idNumber;
   private string personName;

   public Person6(string name, string id)
   {
      this.personName = name;
      this.idNumber = id;
   }

   public override bool Equals(Object obj)
   {
      Person6 personObj = obj as Person6;
      if (personObj == null)
         return false;
      else
         return idNumber.Equals(personObj.idNumber);
   }

   public override int GetHashCode()
   {
      return this.idNumber.GetHashCode();
   }
}

public class Example6
{
   public static void Main()
   {
      Person6 p1 = new Person6("John", "63412895");
      Person6 p2 = new Person6("Jack", "63412895");
      Console.WriteLine(p1.Equals(p2));
      Console.WriteLine(Object.Equals(p1, p2));
   }
}
// The example displays the following output:
//       True
//       True

open System

type Person(name, id) =
    member _.Name = name
    member _.Id = id

    override _.Equals(obj) =
        match obj with
        | :? Person as personObj ->
            id.Equals personObj.Id
        | _ -> 
            false

    override _.GetHashCode() =
        id.GetHashCode()

let p1 = Person("John", "63412895")
let p2 = Person("Jack", "63412895")
printfn $"{p1.Equals p2}"
printfn $"{Object.Equals(p1, p2)}"
// The example displays the following output:
//       True
//       True

Public Class Person
   Private idNumber As String
   Private personName As String
   
   Public Sub New(name As String, id As String)
      Me.personName = name
      Me.idNumber = id
   End Sub
   
   Public Overrides Function Equals(obj As Object) As Boolean
      Dim personObj As Person = TryCast(obj, Person) 
      If personObj Is Nothing Then
         Return False
      Else
         Return idNumber.Equals(personObj.idNumber)
      End If   
   End Function
   
   Public Overrides Function GetHashCode() As Integer
      Return Me.idNumber.GetHashCode() 
   End Function
End Class

Module Example6
    Public Sub Main()
        Dim p1 As New Person("John", "63412895")
        Dim p2 As New Person("Jack", "63412895")
        Console.WriteLine(p1.Equals(p2))
        Console.WriteLine(Object.Equals(p1, p2))
    End Sub
End Module
' The example displays the following output:
'       True
'       True

Além de substituir Equals, pode implementar a interface IEquatable<T> para fornecer um teste fortemente tipado para igualdade.

As instruções a seguir devem ser verdadeiras para todas as implementações do Equals(Object) método. Na lista, x, y, e z representam referências de objeto que não são nulas.

x.Equals(x) retorna true.
x.Equals(y) Devolve o mesmo valor que y.Equals(x).
x.Equals(y) retorna true se ambos x e y são NaN.
Se (x.Equals(y) && y.Equals(z)) retorna true, então x.Equals(z) retorna true.
Chamadas sucessivas para x.Equals(y) retornar o mesmo valor, desde que os objetos referenciados por x e y não sejam modificados.
x.Equals(null) retorna false.

Implementações de Equals não devem lançar exceções, elas devem sempre retornar um valor. Por exemplo, se obj for null, o método Equals deve retornar false em vez de lançar uma ArgumentNullException.

Siga estas diretrizes ao substituir Equals(Object):

Os tipos que implementam IComparable devem sobrescrever Equals(Object).
Os tipos que substituem Equals(Object) também devem substituir GetHashCode, caso contrário, as tabelas de hash podem não funcionar corretamente.
Considere implementar a interface IEquatable<T> para suportar testes de igualdade fortemente tipados. Sua IEquatable<T>.Equals implementação deve retornar resultados consistentes com Equals.
Se sua linguagem de programação suporta sobrecarga de operador e você sobrecarrega o operador de igualdade para um determinado tipo, você também deve substituir o Equals(Object) método para retornar o mesmo resultado que o operador de igualdade. Isso ajuda a garantir que o código da biblioteca de classes que usa Equals (como ArrayList e Hashtable) se comporte de maneira consistente com a maneira como o operador de igualdade é usado pelo código do aplicativo.

Orientações para os tipos de referência

As seguintes diretrizes aplicam-se à substituição Equals(Object) de um tipo de referência:

Considere substituir Equals se a semântica do tipo for baseada no fato de que o tipo representa alguns(s) valor(es).
A maioria dos tipos de referência não deve sobrecarregar o operador de igualdade, mesmo que substituam Equals. No entanto, se você estiver implementando um tipo de referência que se destina a ter semântica de valor, como um tipo de número complexo, deverá substituir o operador de igualdade.
Você não deve sobrescrever Equals em um tipo de referência mutável. Isso ocorre porque a substituição Equals requer que você também substitua o GetHashCode método, conforme discutido na seção anterior. Isso significa que o código hash de uma instância de um tipo de referência mutável pode mudar durante seu tempo de vida, o que pode fazer com que o objeto seja perdido em uma tabela de hash.

Diretrizes para tipos de valor

As diretrizes a seguir se aplicam à substituição Equals(Object) de um tipo de valor:

Se você estiver definindo um tipo de valor que inclua um ou mais campos cujos valores são tipos de referência, deverá substituir Equals(Object). A Equals(Object) implementação fornecida por ValueType executa uma comparação byte por byte para tipos de valor cujos campos são todos tipos de valor, mas usa reflexão para executar uma comparação campo por campo de tipos de valor cujos campos incluem tipos de referência.
Caso substitua Equals e sua linguagem de desenvolvimento suporte sobrecarga de operadores, precisará sobrecarregar o operador de igualdade.
Você deve implementar a IEquatable<T> interface. Chamar o método fortemente tipado IEquatable<T>.Equals evita empacotar o argumento obj.

Exemplos

O exemplo a seguir mostra uma Point classe que substitui o Equals método para fornecer igualdade de valor e uma Point3D classe que é derivada de Point. Como Point substitui Object.Equals(Object) para testar a igualdade de valor, o método Object.Equals(Object) não é chamado. No entanto, Point3D.Equals chama Point.Equals porque Point implementa Object.Equals(Object) de uma maneira que proporciona igualdade de valor.

using System;

class Point2
{
    protected int x, y;

    public Point2() : this(0, 0)
    { }

    public Point2(int x, int y)
    {
        this.x = x;
        this.y = y;
    }

    public override bool Equals(Object obj)
    {
        //Check for null and compare run-time types.
        if ((obj == null) || !this.GetType().Equals(obj.GetType()))
        {
            return false;
        }
        else
        {
            Point2 p = (Point2)obj;
            return (x == p.x) && (y == p.y);
        }
    }

    public override int GetHashCode()
    {
        return HashCode.Combine(x, y);
    }

    public override string ToString()
    {
        return String.Format("Point2({0}, {1})", x, y);
    }
}

sealed class Point3D : Point2
{
    int z;

    public Point3D(int x, int y, int z) : base(x, y)
    {
        this.z = z;
    }

    public override bool Equals(Object obj)
    {
        Point3D pt3 = obj as Point3D;
        if (pt3 == null)
            return false;
        else
            return base.Equals((Point2)obj) && z == pt3.z;
    }

    public override int GetHashCode()
    {
        return HashCode.Combine(base.GetHashCode(), z);
    }

    public override String ToString()
    {
        return String.Format("Point2({0}, {1}, {2})", x, y, z);
    }
}

class Example7
{
    public static void Main()
    {
        Point2 point2D = new Point2(5, 5);
        Point3D point3Da = new Point3D(5, 5, 2);
        Point3D point3Db = new Point3D(5, 5, 2);
        Point3D point3Dc = new Point3D(5, 5, -1);

        Console.WriteLine($"{point2D} = {point3Da}: {point2D.Equals(point3Da)}");
        Console.WriteLine($"{point2D} = {point3Db}: {point2D.Equals(point3Db)}");
        Console.WriteLine($"{point3Da} = {point3Db}: {point3Da.Equals(point3Db)}");
        Console.WriteLine($"{point3Da} = {point3Dc}: {point3Da.Equals(point3Dc)}");
    }
}
// The example displays the following output:
//       Point2(5, 5) = Point2(5, 5, 2): False
//       Point2(5, 5) = Point2(5, 5, 2): False
//       Point2(5, 5, 2) = Point2(5, 5, 2): True
//       Point2(5, 5, 2) = Point2(5, 5, -1): False

type Point(x, y) =
    new () = Point(0, 0)
    member _.X = x
    member _.Y = y

    override _.Equals(obj) =
        //Check for null and compare run-time types.
        match obj with
        | :? Point as p ->
            x = p.X && y = p.Y
        | _ -> 
            false

    override _.GetHashCode() =
        System.HashCode.Combine(x, y)

    override _.ToString() =
        $"Point({x}, {y})"

type Point3D(x, y, z) =
    inherit Point(x, y)
    member _.Z = z

    override _.Equals(obj) =
        match obj with
        | :? Point3D as pt3 ->
            base.Equals(pt3 :> Point) && z = pt3.Z
        | _ -> 
            false

    override _.GetHashCode() =
        System.HashCode.Combine(base.GetHashCode(), z)

    override _.ToString() =
        $"Point({x}, {y}, {z})"

let point2D = Point(5, 5)
let point3Da = Point3D(5, 5, 2)
let point3Db = Point3D(5, 5, 2)
let point3Dc = Point3D(5, 5, -1)

printfn $"{point2D} = {point3Da}: {point2D.Equals point3Da}"
printfn $"{point2D} = {point3Db}: {point2D.Equals point3Db}"
printfn $"{point3Da} = {point3Db}: {point3Da.Equals point3Db}"
printfn $"{point3Da} = {point3Dc}: {point3Da.Equals point3Dc}"
// The example displays the following output:
//       Point(5, 5) = Point(5, 5, 2): False
//       Point(5, 5) = Point(5, 5, 2): False
//       Point(5, 5, 2) = Point(5, 5, 2): True
//       Point(5, 5, 2) = Point(5, 5, -1): False

Class Point1
    Protected x, y As Integer

    Public Sub New()
        Me.x = 0
        Me.y = 0
    End Sub

    Public Sub New(x As Integer, y As Integer)
        Me.x = x
        Me.y = y
    End Sub

    Public Overrides Function Equals(obj As Object) As Boolean
        ' Check for null and compare run-time types.
        If obj Is Nothing OrElse Not Me.GetType().Equals(obj.GetType()) Then
            Return False
        Else
            Dim p As Point1 = DirectCast(obj, Point1)
            Return x = p.x AndAlso y = p.y
        End If
    End Function

    Public Overrides Function GetHashCode() As Integer
        Return HashCode.Combine(x, y)
    End Function

    Public Overrides Function ToString() As String
        Return String.Format("Point1({0}, {1})", x, y)
    End Function
End Class

Class Point3D : Inherits Point1
    Private z As Integer

    Public Sub New(ByVal x As Integer, ByVal y As Integer, ByVal z As Integer)
        MyBase.New(x, y)
        Me.z = z
    End Sub

    Public Overrides Function Equals(ByVal obj As Object) As Boolean
        Dim pt3 As Point3D = TryCast(obj, Point3D)
        If pt3 Is Nothing Then
            Return False
        Else
            Return MyBase.Equals(CType(pt3, Point1)) AndAlso z = pt3.z
        End If
    End Function

    Public Overrides Function GetHashCode() As Integer
        Return HashCode.Combine(MyBase.GetHashCode(), z)
    End Function

    Public Overrides Function ToString() As String
        Return String.Format("Point1({0}, {1}, {2})", x, y, z)
    End Function
End Class

Module Example1
    Public Sub Main()
        Dim point2D As New Point1(5, 5)
        Dim point3Da As New Point3D(5, 5, 2)
        Dim point3Db As New Point3D(5, 5, 2)
        Dim point3Dc As New Point3D(5, 5, -1)

        Console.WriteLine("{0} = {1}: {2}",
                          point2D, point3Da, point2D.Equals(point3Da))
        Console.WriteLine("{0} = {1}: {2}",
                          point2D, point3Db, point2D.Equals(point3Db))
        Console.WriteLine("{0} = {1}: {2}",
                          point3Da, point3Db, point3Da.Equals(point3Db))
        Console.WriteLine("{0} = {1}: {2}",
                          point3Da, point3Dc, point3Da.Equals(point3Dc))
    End Sub
End Module
' The example displays the following output
'       Point1(5, 5) = Point1(5, 5, 2): False
'       Point1(5, 5) = Point1(5, 5, 2): False
'       Point1(5, 5, 2) = Point1(5, 5, 2): True
'       Point1(5, 5, 2) = Point1(5, 5, -1): False

O Point.Equals método verifica se o obj argumento não é nulo e se ele faz referência a uma instância do mesmo tipo que esse objeto. Se qualquer verificação falhar, o método retornará false.

O Point.Equals método chama o GetType método para determinar se os tipos de tempo de execução dos dois objetos são idênticos. Se o método usasse uma verificação da forma obj is Point em C# ou TryCast(obj, Point) no Visual Basic, a verificação retornaria true nos casos em que obj é uma instância de uma classe derivada de Point, embora obj e a instância atual não sejam do mesmo tipo de runtime. Tendo verificado que ambos os objetos são do mesmo tipo, o método converte obj para digitar Point e retorna o resultado da comparação dos campos de instância dos dois objetos.

No Point3D.Equals, o método herdado Point.Equals, que substitui Object.Equals(Object), é invocado antes que qualquer outra coisa seja feita. Como Point3D é uma classe selada (NotInheritable no Visual Basic), uma verificação no formulário obj is Point em C# ou TryCast(obj, Point) no Visual Basic é adequada para garantir que obj é um Point3D objeto. Se for um Point3D objeto, ele é convertido em um Point objeto e passado para a implementação da classe base do Equals. Somente quando o método herdado Point.Equals retorna true o método compara os campos de z instância introduzidos na classe derivada.

O exemplo a seguir define uma Rectangle classe que implementa internamente um retângulo como dois Point objetos. A Rectangle classe também substitui Object.Equals(Object) para proporcionar igualdade de valor.

using System;

class Rectangle
{
   private Point a, b;

   public Rectangle(int upLeftX, int upLeftY, int downRightX, int downRightY)
   {
      this.a = new Point(upLeftX, upLeftY);
      this.b = new Point(downRightX, downRightY);
   }

   public override bool Equals(Object obj)
   {
      // Perform an equality check on two rectangles (Point object pairs).
      if (obj == null || GetType() != obj.GetType())
          return false;
      Rectangle r = (Rectangle)obj;
      return a.Equals(r.a) && b.Equals(r.b);
   }

   public override int GetHashCode()
   {
      return Tuple.Create(a, b).GetHashCode();
   }

    public override String ToString()
    {
       return String.Format("Rectangle({0}, {1}, {2}, {3})",
                            a.x, a.y, b.x, b.y);
    }
}

class Point
{
  internal int x;
  internal int y;

  public Point(int X, int Y)
  {
     this.x = X;
     this.y = Y;
  }

  public override bool Equals (Object obj)
  {
     // Performs an equality check on two points (integer pairs).
     if (obj == null || GetType() != obj.GetType()) return false;
     Point p = (Point)obj;
     return (x == p.x) && (y == p.y);
  }

  public override int GetHashCode()
  {
     return Tuple.Create(x, y).GetHashCode();
  }
}

class Example
{
   public static void Main()
   {
      Rectangle r1 = new Rectangle(0, 0, 100, 200);
      Rectangle r2 = new Rectangle(0, 0, 100, 200);
      Rectangle r3 = new Rectangle(0, 0, 150, 200);

      Console.WriteLine($"{r1} = {r2}: {r1.Equals(r2)}");
      Console.WriteLine($"{r1} = {r3}: {r1.Equals(r3)}");
      Console.WriteLine($"{r2} = {r3}: {r2.Equals(r3)}");
   }
}
// The example displays the following output:
//    Rectangle(0, 0, 100, 200) = Rectangle(0, 0, 100, 200): True
//    Rectangle(0, 0, 100, 200) = Rectangle(0, 0, 150, 200): False
//    Rectangle(0, 0, 100, 200) = Rectangle(0, 0, 150, 200): False

type Point(x, y) =
    member _.X = x
    member _.Y = y

    override _.Equals(obj) =
        // Performs an equality check on two points (integer pairs).
        match obj with
        | :? Point as p ->
            x = p.X && y = p.Y
        | _ ->
            false
    
    override _.GetHashCode() =
        (x, y).GetHashCode()

type Rectangle(upLeftX, upLeftY, downRightX, downRightY) =
    let a = Point(upLeftX, upLeftY)
    let b = Point(downRightX, downRightY)
    
    member _.UpLeft = a
    member _.DownRight = b

    override _.Equals(obj) =
        // Perform an equality check on two rectangles (Point object pairs).
        match obj with
        | :? Rectangle as r ->
            a.Equals(r.UpLeft) && b.Equals(r.DownRight)
        | _ -> 
            false
        
    override _.GetHashCode() =
        (a, b).GetHashCode()

    override _.ToString() =
       $"Rectangle({a.X}, {a.Y}, {b.X}, {b.Y})"

let r1 = Rectangle(0, 0, 100, 200)
let r2 = Rectangle(0, 0, 100, 200)
let r3 = Rectangle(0, 0, 150, 200)

printfn $"{r1} = {r2}: {r1.Equals r2}"
printfn $"{r1} = {r3}: {r1.Equals r3}"
printfn $"{r2} = {r3}: {r2.Equals r3}"
// The example displays the following output:
//    Rectangle(0, 0, 100, 200) = Rectangle(0, 0, 100, 200): True
//    Rectangle(0, 0, 100, 200) = Rectangle(0, 0, 150, 200): False
//    Rectangle(0, 0, 100, 200) = Rectangle(0, 0, 150, 200): False

Class Rectangle 
    Private a, b As Point
    
    Public Sub New(ByVal upLeftX As Integer, ByVal upLeftY As Integer, _
                   ByVal downRightX As Integer, ByVal downRightY As Integer) 
        Me.a = New Point(upLeftX, upLeftY)
        Me.b = New Point(downRightX, downRightY)
    End Sub 
    
    Public Overrides Function Equals(ByVal obj As [Object]) As Boolean 
        ' Performs an equality check on two rectangles (Point object pairs).
        If obj Is Nothing OrElse Not [GetType]().Equals(obj.GetType()) Then
            Return False
        End If
        Dim r As Rectangle = CType(obj, Rectangle)
        Return a.Equals(r.a) AndAlso b.Equals(r.b)
    End Function

    Public Overrides Function GetHashCode() As Integer 
        Return Tuple.Create(a, b).GetHashCode()
    End Function 

    Public Overrides Function ToString() As String
       Return String.Format("Rectangle({0}, {1}, {2}, {3})",
                            a.x, a.y, b.x, b.y) 
    End Function
End Class 

Class Point
    Friend x As Integer
    Friend y As Integer
    
    Public Sub New(ByVal X As Integer, ByVal Y As Integer) 
        Me.x = X
        Me.y = Y
    End Sub 

    Public Overrides Function Equals(ByVal obj As [Object]) As Boolean 
        ' Performs an equality check on two points (integer pairs).
        If obj Is Nothing OrElse Not [GetType]().Equals(obj.GetType()) Then
            Return False
        Else
           Dim p As Point = CType(obj, Point)
           Return x = p.x AndAlso y = p.y
        End If
    End Function 
    
    Public Overrides Function GetHashCode() As Integer 
        Return Tuple.Create(x, y).GetHashCode()
    End Function 
End Class  

Class Example
    Public Shared Sub Main() 
        Dim r1 As New Rectangle(0, 0, 100, 200)
        Dim r2 As New Rectangle(0, 0, 100, 200)
        Dim r3 As New Rectangle(0, 0, 150, 200)
        
        Console.WriteLine("{0} = {1}: {2}", r1, r2, r1.Equals(r2))
        Console.WriteLine("{0} = {1}: {2}", r1, r3, r1.Equals(r3))
        Console.WriteLine("{0} = {1}: {2}", r2, r3, r2.Equals(r3))
    End Sub 
End Class 
' The example displays the following output:
'    Rectangle(0, 0, 100, 200) = Rectangle(0, 0, 100, 200): True
'    Rectangle(0, 0, 100, 200) = Rectangle(0, 0, 150, 200): False
'    Rectangle(0, 0, 100, 200) = Rectangle(0, 0, 150, 200): False

Algumas linguagens, como C# e Visual Basic, suportam sobrecarga do operador. Quando um tipo sobrecarrega o operador de igualdade, ele também deve substituir o método Equals(Object) para fornecer a mesma funcionalidade. Isso geralmente é feito escrevendo o método Equals(Object) em termos do operador de igualdade sobrecarregado, como no exemplo a seguir.

using System;

public struct Complex
{
   public double re, im;

   public override bool Equals(Object obj)
   {
      return obj is Complex && this == (Complex)obj;
   }

   public override int GetHashCode()
   {
      return Tuple.Create(re, im).GetHashCode();
   }

   public static bool operator ==(Complex x, Complex y)
   {
      return x.re == y.re && x.im == y.im;
   }

   public static bool operator !=(Complex x, Complex y)
   {
      return !(x == y);
   }

    public override String ToString()
    {
       return String.Format("({0}, {1})", re, im);
    }
}

class MyClass
{
  public static void Main()
  {
    Complex cmplx1, cmplx2;

    cmplx1.re = 4.0;
    cmplx1.im = 1.0;

    cmplx2.re = 2.0;
    cmplx2.im = 1.0;

    Console.WriteLine($"{cmplx1} <> {cmplx2}: {cmplx1 != cmplx2}");
    Console.WriteLine($"{cmplx1} = {cmplx2}: {cmplx1.Equals(cmplx2)}");

    cmplx2.re = 4.0;

    Console.WriteLine($"{cmplx1} = {cmplx2}: {cmplx1 == cmplx2}");
    Console.WriteLine($"{cmplx1} = {cmplx2}: {cmplx1.Equals(cmplx2)}");
  }
}
// The example displays the following output:
//       (4, 1) <> (2, 1): True
//       (4, 1) = (2, 1): False
//       (4, 1) = (4, 1): True
//       (4, 1) = (4, 1): True

[<Struct; CustomEquality; NoComparison>]
type Complex =
    val mutable re: double
    val mutable im: double

    override this.Equals(obj) =
        match obj with 
        | :? Complex as c when c = this -> true
        | _ -> false 

    override this.GetHashCode() =
        (this.re, this.im).GetHashCode()

    override this.ToString() =
        $"({this.re}, {this.im})"

    static member op_Equality (x: Complex, y: Complex) =
        x.re = y.re && x.im = y.im

    static member op_Inequality (x: Complex, y: Complex) =
        x = y |> not

let mutable cmplx1 = Complex()
let mutable cmplx2 = Complex()

cmplx1.re <- 4.0
cmplx1.im <- 1.0

cmplx2.re <- 2.0
cmplx2.im <- 1.0

printfn $"{cmplx1} <> {cmplx2}: {cmplx1 <> cmplx2}"
printfn $"{cmplx1} = {cmplx2}: {cmplx1.Equals cmplx2}"

cmplx2.re <- 4.0

printfn $"{cmplx1} = {cmplx2}: {cmplx1 = cmplx2}"
printfn $"{cmplx1} = {cmplx2}: {cmplx1.Equals cmplx2}"

// The example displays the following output:
//       (4, 1) <> (2, 1): True
//       (4, 1) = (2, 1): False
//       (4, 1) = (4, 1): True
//       (4, 1) = (4, 1): True

Public Structure Complex
    Public re, im As Double
    
    Public Overrides Function Equals(ByVal obj As [Object]) As Boolean 
        Return TypeOf obj Is Complex AndAlso Me = CType(obj, Complex)
    End Function 
    
    Public Overrides Function GetHashCode() As Integer 
        Return Tuple.Create(re, im).GetHashCode()
    End Function 
    
    Public Shared Operator = (x As Complex, y As Complex) As Boolean
       Return x.re = y.re AndAlso x.im = y.im
    End Operator 
    
    Public Shared Operator <> (x As Complex, y As Complex) As Boolean
       Return Not (x = y)
    End Operator 
    
    Public Overrides Function ToString() As String
       Return String.Format("({0}, {1})", re, im)
    End Function 
End Structure

Class Example8
    Public Shared Sub Main()
        Dim cmplx1, cmplx2 As Complex

        cmplx1.re = 4.0
        cmplx1.im = 1.0

        cmplx2.re = 2.0
        cmplx2.im = 1.0

        Console.WriteLine("{0} <> {1}: {2}", cmplx1, cmplx2, cmplx1 <> cmplx2)
        Console.WriteLine("{0} = {1}: {2}", cmplx1, cmplx2, cmplx1.Equals(cmplx2))

        cmplx2.re = 4.0

        Console.WriteLine("{0} = {1}: {2}", cmplx1, cmplx2, cmplx1 = cmplx2)
        Console.WriteLine("{0} = {1}: {2}", cmplx1, cmplx2, cmplx1.Equals(cmplx2))
    End Sub
End Class
' The example displays the following output:
'       (4, 1) <> (2, 1): True
'       (4, 1) = (2, 1): False
'       (4, 1) = (4, 1): True
'       (4, 1) = (4, 1): True

Por Complex ser um tipo de valor, ele não pode ser derivado. Portanto, o método override to Equals(Object) não precisa chamar GetType para determinar o tipo exato de tempo de execução de cada objeto, mas pode em vez disso usar o operador is em C# ou o operador TypeOf em Visual Basic para verificar o tipo do parâmetro obj.

Comentários

Esta página foi útil?

Last updated on 2025-04-04