Object.Equals Método
Definição
Importante
Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.
Determina se duas instâncias de objeto são iguais.
Sobrecargas
Equals(Object) |
Determina se o objeto especificado é igual ao objeto atual. |
Equals(Object, Object) |
Determina se as instâncias de objeto especificadas são consideradas iguais. |
Equals(Object)
Determina se o objeto especificado é igual ao objeto atual.
public:
virtual bool Equals(System::Object ^ obj);
public virtual bool Equals (object obj);
public virtual bool Equals (object? obj);
abstract member Equals : obj -> bool
override this.Equals : obj -> bool
Public Overridable Function Equals (obj As Object) As Boolean
Parâmetros
- obj
- Object
O objeto a ser comparado com o objeto atual.
Retornos
true
se o objeto especificado for igual ao objeto atual, caso contrário, false
.
Exemplos
O exemplo a seguir mostra uma Point
classe que substitui o Equals método para fornecer igualdade de valor e uma Point3D
classe derivada de Point
. Como Point
substitui Object.Equals(Object) para testar a igualdade de valor, o Object.Equals(Object) método não é chamado. No entanto, Point3D.Equals
chama Point.Equals
porque Point
implementa Object.Equals(Object) de uma maneira que fornece igualdade de valor.
using System;
class Point
{
protected int x, y;
public Point() : this(0, 0)
{ }
public Point(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 {
Point p = (Point) obj;
return (x == p.x) && (y == p.y);
}
}
public override int GetHashCode()
{
return (x << 2) ^ y;
}
public override string ToString()
{
return String.Format("Point({0}, {1})", x, y);
}
}
sealed class Point3D: Point
{
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((Point)obj) && z == pt3.z;
}
public override int GetHashCode()
{
return (base.GetHashCode() << 2) ^ z;
}
public override String ToString()
{
return String.Format("Point({0}, {1}, {2})", x, y, z);
}
}
class Example
{
public static void Main()
{
Point point2D = new Point(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("{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));
}
}
// 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
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() =
(x <<< 2) ^^^ 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() =
(base.GetHashCode() <<< 2) ^^^ 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 Point
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 Point = DirectCast(obj, Point)
Return x = p.x AndAlso y = p.y
End If
End Function
Public Overrides Function GetHashCode() As Integer
Return (x << 2) XOr y
End Function
Public Overrides Function ToString() As String
Return String.Format("Point({0}, {1})", x, y)
End Function
End Class
Class Point3D : Inherits Point
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, Point)) AndAlso z = pt3.Z
End If
End Function
Public Overrides Function GetHashCode() As Integer
Return (MyBase.GetHashCode() << 2) XOr z
End Function
Public Overrides Function ToString() As String
Return String.Format("Point({0}, {1}, {2})", x, y, z)
End Function
End Class
Module Example
Public Sub Main()
Dim point2D As New Point(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
' 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
O Point.Equals
método verifica se o obj
argumento não é nulo e se faz referência a uma instância do mesmo tipo que esse objeto. Se uma das verificações 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 do formulário obj is Point
em C# ou TryCast(obj, Point)
no Visual Basic, a verificação retornaria true
nos casos obj
em que é uma instância de uma classe derivada de Point
, mesmo que obj
e a instância atual não sejam do mesmo tipo de tempo de execução. 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
seja um Point3D
objeto. Se for um Point3D
objeto , ele será convertido em um Point
objeto e passado para a implementação da classe base de Equals. Somente quando o método herdado Point.Equals
retorna true
o método compara os z
campos de 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 fornecer 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("{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));
}
}
// 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 sobrecarga de operador de suporte do C# e do Visual Basic. Quando um tipo sobrecarrega o operador de igualdade, ele também deve substituir o Equals(Object) método para fornecer a mesma funcionalidade. Isso normalmente é feito escrevendo o Equals(Object) método 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("{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));
}
}
// 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 Example
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
Como Complex
é um tipo de valor, ele não pode ser derivado de . Portanto, a substituição ao Equals(Object) método não precisa chamar GetType para determinar o tipo de tempo de execução preciso de cada objeto, mas pode usar o is
operador em C# ou o TypeOf
operador no Visual Basic para verificar o tipo do obj
parâmetro.
Comentários
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 Equals(Object) método testará a igualdade de referência e uma chamada para o Equals(Object) método será equivalente a uma chamada ao ReferenceEquals método . A igualdade de referência significa que as variáveis de objeto 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 oPerson
construtor de classe para instanciar dois novosPerson
objetos,person1a
eperson2
, que têm o mesmo valor. Ele também atribuiperson1a
a outra variável de objeto,person1b
. Como mostra a saída do exemplo,person1a
eperson1b
são iguais porque fazem referência ao mesmo objeto. No entanto,person1a
eperson2
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 Example { 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: {0}", person1a.Equals(person1b)); Console.WriteLine("person1a and person2: {0}", person1a.Equals(person2)); Console.WriteLine("\nCasting to an Object and calling Equals:"); Console.WriteLine("person1a and person1b: {0}", ((object) person1a).Equals((object) person1b)); Console.WriteLine("person1a and person2: {0}", ((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 Person 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 Example Public Sub Main() Dim person1a As New Person("John") Dim person1b As Person = person1a Dim person2 As New Person(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 Equals(Object) método testará a igualdade de valor. A igualdade de valor significa o seguinte:
Os dois objetos são do mesmo tipo. Como mostra o exemplo a seguir, um Byte objeto que tem um valor de 12 não é igual a um Int32 objeto que tem um valor de 12, pois 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("{0} ({1}) = {2} ({3}): {4}", 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 Example 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 dePerson
classe para instanciar dois novosPerson
objetos,person1
eperson2
, 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 eperson2
sejam iguaisperson1
porque têm o mesmo valor para o campo privadopersonName
.using System; // Define a value type that does not override Equals. public struct Person { private string personName; public Person(string name) { this.personName = name; } public override string ToString() { return this.personName; } } public struct Example { public static void Main() { Person person1 = new Person("John"); Person person2 = new Person("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 Person 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 Example Public Sub Main() Dim p1 As New Person("John") Dim p2 As New Person("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 Framework, o Object.Equals(Object) método fornece a comparação de igualdade padrão para todos os outros tipos. No entanto, os tipos geralmente substituem o Equals método para implementar a igualdade de valor. Para obter mais informações, consulte as seções Anotações para Chamadores e Anotações para Herdadores.
Anotações para o Windows Runtime
Quando você chama a sobrecarga de Equals(Object) método em uma classe no Windows Runtime, ele fornece o comportamento padrão para classes que não substituem Equals(Object). Isso faz parte do suporte que o .NET Framework fornece para o Windows Runtime (consulte Suporte .NET Framework para aplicativos e Windows Runtime da Windows Store). As classes no Windows Runtime não herdam Objecte atualmente não implementam um Equals(Object) método. No entanto, eles parecem ter ToStringmétodos , Equals(Object)e GetHashCode quando você os usa em seu código C# ou Visual Basic, e o .NET Framework fornece o comportamento padrão para esses métodos.
Observação
Windows Runtime classes escritas em C# ou Visual Basic podem substituir a sobrecarga do Equals(Object) método.
Observações para chamadores
Classes derivadas frequentemente substituem o Object.Equals(Object) método para implementar a igualdade de valor. Além disso, os tipos também frequentemente fornecem uma sobrecarga adicional fortemente tipada para o Equals
método, normalmente implementando a IEquatable<T> interface . Ao chamar o Equals
método para testar a igualdade, você deve saber se a instância atual substitui Object.Equals e entender como uma chamada específica a um Equals
método é resolvida. Caso contrário, você pode estar executando um teste de igualdade diferente do que você pretendia, e o método pode retornar um valor inesperado.
O exemplo a seguir ilustra esse cenário. Ele cria uma instância de 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 os três restantes retornam false
.
using System;
using System.Text;
public class Example
{
public static void Main()
{
StringBuilder sb1 = new StringBuilder("building a string...");
StringBuilder sb2 = new StringBuilder("building a string...");
Console.WriteLine("sb1.Equals(sb2): {0}", sb1.Equals(sb2));
Console.WriteLine("((Object) sb1).Equals(sb2): {0}",
((Object) sb1).Equals(sb2));
Console.WriteLine("Object.Equals(sb1, sb2): {0}",
Object.Equals(sb1, sb2));
Object sb3 = new StringBuilder("building a string...");
Console.WriteLine("\nsb3.Equals(sb2): {0}", 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 Example
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). Por isso, quando o StringBuilder objeto é convertido em um Object, quando uma StringBuilder instância é atribuída a uma variável do tipo Objecte quando o Object.Equals(Object, Object) método é passado 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 ...
).
Observações 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 Equals
método para as principais categorias de tipos no .NET Framework.
Categoria do tipo | Igualdade definida por | Comentários |
---|---|---|
Classe derivada diretamente de Object | Object.Equals(Object) | Igualdade de referência; equivalente a chamar Object.ReferenceEquals. |
Estrutura | ValueType.Equals | Igualdade de valor; comparação direta byte por 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. |
Delegar | MulticastDelegate.Equals | Os delegados devem ter o mesmo tipo com listas de invocação idênticas. |
Interface | Object.Equals(Object) | Igualdade de referência. |
Para um tipo de valor, você deve sempre substituir Equals, pois os testes de igualdade que dependem da reflexão oferecem baixo desempenho. Você também pode substituir a implementação padrão de para tipos de Equals referência testarem a igualdade de valor em vez da igualdade de referência e definirem o significado preciso da igualdade de valor. Essas implementações de Equals retorno 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 é 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 a ser retornado true
para duas instâncias de cadeia de caracteres que contêm os mesmos caracteres na mesma ordem.
O exemplo a seguir mostra como substituir o Object.Equals(Object) método para testar a igualdade de valor. Ele substitui o Equals método para a Person
classe . Se Person
aceitasse sua implementação de igualdade de classe base, dois Person
objetos seriam iguais somente se referenciassem um único objeto. No entanto, nesse caso, dois Person
objetos serão iguais se tiverem o mesmo valor para a Person.Id
propriedade .
public class Person
{
private string idNumber;
private string personName;
public Person(string name, string id)
{
this.personName = name;
this.idNumber = id;
}
public override bool Equals(Object obj)
{
Person personObj = obj as Person;
if (personObj == null)
return false;
else
return idNumber.Equals(personObj.idNumber);
}
public override int GetHashCode()
{
return this.idNumber.GetHashCode();
}
}
public class Example
{
public static void Main()
{
Person p1 = new Person("John", "63412895");
Person p2 = new Person("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 Example
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, você pode implementar a IEquatable<T> interface 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)
retornatrue
.x.Equals(y)
retorna o mesmo valor quey.Equals(x)
.x.Equals(y)
retornarátrue
se ey
x
foremNaN
.Se
(x.Equals(y) && y.Equals(z))
retornartrue
, retornarátrue
x.Equals(z)
.Chamadas sucessivas para
x.Equals(y)
retornar o mesmo valor, desde que os objetos referenciados porx
ey
não sejam modificados.x.Equals(null)
retornafalse
.
As implementações de Equals não devem gerar exceções; elas sempre devem retornar um valor. Por exemplo, se obj
for null
, o Equals método deverá retornar false
em vez de lançar um ArgumentNullException.
Siga estas diretrizes ao substituir Equals(Object):
Os tipos que implementam IComparable devem substituir 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.
Você deve considerar a implementação da IEquatable<T> interface para dar suporte a testes fortemente tipado para igualdade. Sua implementação IEquatable<T>.Equals deve retornar resultados consistentes com Equals.
Se a linguagem de programação der suporte à sobrecarga do operador e você sobrecarregar o operador de igualdade para um determinado tipo, você também deverá 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.
Diretrizes para tipos de referência
As diretrizes a seguir se aplicam à 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 valores.
A maioria dos tipos de referência não deve sobrecarregar o operador de igualdade, mesmo que eles substituam Equals. No entanto, se você estiver implementando um tipo de referência destinado a ter semântica de valor, como um tipo de número complexo, deverá substituir o operador de igualdade.
Você não deve substituir 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 ser alterado 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 inclui um ou mais campos cujos valores são tipos de referência, substitua 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 a campo de tipos de valor cujos campos incluem tipos de referência.
Se você substituir Equals e sua linguagem de desenvolvimento der suporte à sobrecarga de operador, você deverá sobrecarregar o operador de igualdade.
Você deve implementar a IEquatable<T> interface . Chamar o método fortemente tipado IEquatable<T>.Equals evita o boxing do
obj
argumento.
Confira também
Aplica-se a
Equals(Object, Object)
Determina se as instâncias de objeto especificadas são consideradas iguais.
public:
static bool Equals(System::Object ^ objA, System::Object ^ objB);
public static bool Equals (object objA, object objB);
public static bool Equals (object? objA, object? objB);
static member Equals : obj * obj -> bool
Public Shared Function Equals (objA As Object, objB As Object) As Boolean
Parâmetros
- objA
- Object
O primeiro objeto a ser comparado.
- objB
- Object
O segundo objeto a ser comparado.
Retornos
true
se os objetos forem considerados iguais; caso contrário, false
. Se objA
e objB
forem null, o método retornará true
.
Exemplos
O exemplo a seguir ilustra o Equals(Object, Object) método e o compara com o ReferenceEquals método .
using System;
public class Example
{
public static void Main()
{
Dog m1 = new Dog("Alaskan Malamute");
Dog m2 = new Dog("Alaskan Malamute");
Dog g1 = new Dog("Great Pyrenees");
Dog g2 = g1;
Dog d1 = new Dog("Dalmation");
Dog n1 = null;
Dog n2 = null;
Console.WriteLine("null = null: {0}", Object.Equals(n1, n2));
Console.WriteLine("null Reference Equals null: {0}\n", Object.ReferenceEquals(n1, n2));
Console.WriteLine("{0} = {1}: {2}", g1, g2, Object.Equals(g1, g2));
Console.WriteLine("{0} Reference Equals {1}: {2}\n", g1, g2, Object.ReferenceEquals(g1, g2));
Console.WriteLine("{0} = {1}: {2}", m1, m2, Object.Equals(m1, m2));
Console.WriteLine("{0} Reference Equals {1}: {2}\n", m1, m2, Object.ReferenceEquals(m1, m2));
Console.WriteLine("{0} = {1}: {2}", m1, d1, Object.Equals(m1, d1));
Console.WriteLine("{0} Reference Equals {1}: {2}", m1, d1, Object.ReferenceEquals(m1, d1));
}
}
public class Dog
{
// Public field.
public string Breed;
// Class constructor.
public Dog(string dogBreed)
{
this.Breed = dogBreed;
}
public override bool Equals(Object obj)
{
if (obj == null || !(obj is Dog))
return false;
else
return this.Breed == ((Dog) obj).Breed;
}
public override int GetHashCode()
{
return this.Breed.GetHashCode();
}
public override string ToString()
{
return this.Breed;
}
}
// The example displays the following output:
// null = null: True
// null Reference Equals null: True
//
// Great Pyrenees = Great Pyrenees: True
// Great Pyrenees Reference Equals Great Pyrenees: True
//
// Alaskan Malamute = Alaskan Malamute: True
// Alaskan Malamute Reference Equals Alaskan Malamute: False
//
// Alaskan Malamute = Dalmation: False
// Alaskan Malamute Reference Equals Dalmation: False
open System
// Class constructor
type Dog(dogBreed) =
// Public property.
member _.Breed = dogBreed
override this.Equals(obj) =
match obj with
| :? Dog as dog when dog.Breed = this.Breed -> true
| _ -> false
override _.GetHashCode() =
dogBreed.GetHashCode()
override _.ToString() =
dogBreed
let m1 = Dog "Alaskan Malamute"
let m2 = Dog "Alaskan Malamute"
let g1 = Dog "Great Pyrenees"
let g2 = g1
let d1 = Dog "Dalmation"
let n1 = Unchecked.defaultof<Dog>
let n2 = Unchecked.defaultof<Dog>
printfn $"null = null: {Object.Equals(n1, n2)}"
printfn $"null Reference Equals null: {Object.ReferenceEquals(n1, n2)}\n"
printfn $"{g1} = {g2}: {Object.Equals(g1, g2)}"
printfn $"{g1} Reference Equals {g2}: {Object.ReferenceEquals(g1, g2)}\n"
printfn $"{m1} = {m2}: {Object.Equals(m1, m2)}"
printfn $"{m1} Reference Equals {m2}: {Object.ReferenceEquals(m1, m2)}\n"
printfn $"{m1} = {d1}: {Object.Equals(m1, d1)}"
printfn $"{m1} Reference Equals {d1}: {Object.ReferenceEquals(m1, d1)}"
// The example displays the following output:
// null = null: True
// null Reference Equals null: True
//
// Great Pyrenees = Great Pyrenees: True
// Great Pyrenees Reference Equals Great Pyrenees: True
//
// Alaskan Malamute = Alaskan Malamute: True
// Alaskan Malamute Reference Equals Alaskan Malamute: False
//
// Alaskan Malamute = Dalmation: False
// Alaskan Malamute Reference Equals Dalmation: False
Module Example
Public Sub Main()
Dim m1 As New Dog("Alaskan Malamute")
Dim m2 As New Dog("Alaskan Malamute")
Dim g1 As New Dog("Great Pyrenees")
Dim g2 As Dog = g1
Dim d1 As New Dog("Dalmation")
Dim n1 As Dog = Nothing
Dim n2 As Dog = Nothing
Console.WriteLine("null = null: {0}", Object.Equals(n1, n2))
Console.WriteLine("null Reference Equals null: {0}", Object.ReferenceEquals(n1, n2))
Console.WriteLine()
Console.WriteLine("{0} = {1}: {2}", g1, g2, Object.Equals(g1, g2))
Console.WriteLine("{0} Reference Equals {1}: {2}", g1, g2, Object.ReferenceEquals(g1, g2))
Console.WriteLine()
Console.WriteLine("{0} = {1}: {2}", m1, m2, Object.Equals(m1, m2))
Console.WriteLine("{0} Reference Equals {1}: {2}", m1, m2, Object.ReferenceEquals(m1, m2))
Console.WriteLine()
Console.WriteLine("{0} = {1}: {2}", m1, d1, Object.Equals(m1, d1))
Console.WriteLine("{0} Reference Equals {1}: {2}", m1, d1, Object.ReferenceEquals(m1, d1))
End Sub
End Module
Public Class Dog
' Public field.
Public Breed As String
' Class constructor.
Public Sub New(dogBreed As String)
Me.Breed = dogBreed
End Sub
Public Overrides Function Equals(obj As Object) As Boolean
If obj Is Nothing OrElse Not typeof obj Is Dog Then
Return False
Else
Return Me.Breed = CType(obj, Dog).Breed
End If
End Function
Public Overrides Function GetHashCode() As Integer
Return Me.Breed.GetHashCode()
End Function
Public Overrides Function ToString() As String
Return Me.Breed
End Function
End Class
' The example displays the following output:
' null = null: True
' null Reference Equals null: True
'
' Great Pyrenees = Great Pyrenees: True
' Great Pyrenees Reference Equals Great Pyrenees: True
'
' Alaskan Malamute = Alaskan Malamute: True
' Alaskan Malamute Reference Equals Alaskan Malamute: False
'
' Alaskan Malamute = Dalmation: False
' Alaskan Malamute Reference Equals Dalmation: False
Comentários
O método estático Equals(Object, Object) indica se dois objetos e objA
objB
, são iguais. Ele também permite testar objetos cujo valor é nulo para igualdade. Ele compara objA
e objB
para igualdade da seguinte maneira:
Ele determina se os dois objetos representam a mesma referência de objeto. Se o fizerem, o método retornará
true
. Esse teste é equivalente a chamar o ReferenceEquals método . Além disso, se eobjA
objB
forem nulos, o método retornarátrue
.Ele determina se ou
objA
objB
é nulo. Nesse caso, ele retornafalse
.Se os dois objetos não representarem a mesma referência de objeto e nenhum for nulo, ele chamará
objA
.Equals
(objB
) e retorna o resultado. Isso significa que, seobjA
substituir o Object.Equals(Object) método, essa substituição será chamada.