Object.Equals メソッド
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
2 つのオブジェクト インスタンスが等しいかどうかを判断します。
オーバーロード
Equals(Object) |
指定されたオブジェクトが現在のオブジェクトと等しいかどうかを判断します。 |
Equals(Object, Object) |
指定されたインスタンスが等しいかどうかを判断します。 |
Equals(Object)
指定されたオブジェクトが現在のオブジェクトと等しいかどうかを判断します。
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
パラメーター
- obj
- Object
現在のオブジェクトと比較するオブジェクト。
戻り値
指定したオブジェクトが現在のオブジェクトと等しい場合は true
。それ以外の場合は false
。
例
次の例は、Point
値の等価性を提供するためにメソッドをEqualsオーバーライドするクラスと、からPoint
派生したクラスをPoint3D
示しています。 値のObject.Equals(Object)等価性をテストするためのオーバーライドのためPoint
、Object.Equals(Object)メソッドは呼び出されません。 ただし、Point3D.Equals
呼び出しPoint.Equals
は、値のObject.Equals(Object)等価性を提供する方法で実装されるためPoint
です。
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
このメソッドは Point.Equals
、引数が obj
null ではなく、このオブジェクトと同じ型のインスタンスを参照していることを確認します。 いずれかのチェックが失敗した場合、メソッド false
は .
このメソッドは Point.Equals
、メソッドを GetType 呼び出して、2 つのオブジェクトの実行時の型が同一かどうかを判断します。 メソッドが C# または TryCast(obj, Point)
Visual Basic でフォームobj is Point
のチェックを使用した場合、現在のインスタンスがobj
同じ実行時型ではない場合obj
でも、派生クラスのPoint
インスタンスである場合にチェックが返true
されます。 両方のオブジェクトが同じ型であることを確認した後、メソッドは型Point
にキャストobj
し、2 つのオブジェクトのインスタンス フィールドを比較した結果を返します。
でPoint3D.Equals
、オーバーライドするObject.Equals(Object)継承されたPoint.Equals
メソッドは、他の処理が行われる前に呼び出されます。 シール クラス (NotInheritable
Visual Basic) であるためPoint3D
、C# または TryCast(obj, Point)
Visual Basic のフォームobj is Point
のチェックインは、オブジェクトであることをobj``Point3D
確認するのに十分です。 オブジェクトの Point3D
場合は、オブジェクトに Point
キャストされ、基底クラスの Equals実装に渡されます。 継承されたメソッドが返された Point.Equals
場合にのみ、 true
メソッドは派生クラスで導入されたインスタンス フィールドを比較 z
します。
次の例では、 Rectangle
内部的に四角形を 2 つの Point
オブジェクトとして実装するクラスを定義します。 このクラスは Rectangle
、値の Object.Equals(Object) 等価性を提供するためにもオーバーライドします。
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
C# や Visual Basic などの一部の言語では、演算子のオーバーロードがサポートされています。 型が等値演算子をオーバーロードする場合は、メソッドを Equals(Object) オーバーライドして同じ機能を提供する必要もあります。 これは通常、次の例のように、オーバーロードされた等値演算子の観点からメソッドを記述 Equals(Object) することによって実現されます。
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
値型であるため Complex
、派生できません。 したがって、メソッドのEquals(Object)オーバーライドは、各オブジェクトの正確な実行時の型を決定するために呼び出すGetType必要はありませんが、代わりに C# の演算子またはTypeOf
Visual Basicの演算子を使用is
してパラメーターの型をobj
確認できます。
注釈
現在のインスタンスとパラメーターの比較の種類は、現在の obj
インスタンスが参照型か値型かによって異なります。
現在のインスタンスが参照型の場合、 Equals(Object) メソッドは参照等価性をテストし、メソッドの Equals(Object) 呼び出しはメソッドの ReferenceEquals 呼び出しと同等です。 参照の等価性は、比較されるオブジェクト変数が同じオブジェクトを参照することを意味します。 次の例は、このような比較の結果を示しています。 参照型であるクラスを
Person
定義し、クラス コンストラクターをPerson
呼び出して、2 つの新しいPerson
オブジェクトとperson2
、person1a
同じ値を持つオブジェクトをインスタンス化します。 また、person1b
別のperson1a
オブジェクト変数に代入します。 例からの出力が示すように、person1a
person1b
同じオブジェクトを参照しているため、等しくなります。 ただし、person1a
person2
同じ値を持っていますが、等しくありません。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
現在のインスタンスが値型の場合、メソッドは Equals(Object) 値の等価性をテストします。 値の等価性は、次のことを意味します。
2 つのオブジェクトは同じ型です。 次の例に示すように、 Byte 12 の値を持つオブジェクトは、2 つのオブジェクトの実行時の型が異なるため、値が 12 のオブジェクトと等しくありません Int32 。
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
2 つのオブジェクトのパブリック フィールドとプライベート フィールドの値は等しくなります。 次の例では、値の等価性をテストします。 値型である構造体を
Person
定義し、クラス コンストラクターをPerson
呼び出して、2 つの新しいPerson
オブジェクトとperson2
、person1
同じ値を持つオブジェクトをインスタンス化します。 例からの出力が示すように、2 つのオブジェクト変数は異なるオブジェクトを参照していますがperson2
、person1
プライベートpersonName
フィールドの値が同じであるため、等しくなります。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
Objectクラスは.NET Framework内のすべての型の基底クラスであるため、Object.Equals(Object)メソッドは他のすべての型に対して既定の等値比較を提供します。 ただし、型は多くの場合、値の等価性を Equals 実装するためにメソッドをオーバーライドします。 詳細については、「呼び出し元のメモ」および「継承者のメモ」セクションを参照してください。
Windows ランタイムに関する注意事項
Windows ランタイム内のEquals(Object)クラスに対してメソッド オーバーロードを呼び出すと、オーバーライドEquals(Object)されないクラスの既定の動作が提供されます。 これは、.NET FrameworkがWindows ランタイムに提供するサポートの一部です (Windows ストア アプリとWindows ランタイムのサポート.NET Framework参照)。 Windows ランタイム内のクラスは継承Objectせず、現在はメソッドをEquals(Object)実装していません。 ただし、C# または Visual Basic コードで使用する場合は、メソッドとメソッドが含まれているように見えますToStringEquals(Object)GetHashCode。.NET Frameworkでは、これらのメソッドの既定の動作が提供されます。
注意
C# または Visual Basic で記述されたクラスWindows ランタイム、メソッドのオーバーロードをEquals(Object)オーバーライドできます。
呼び出し元に関する注意事項
派生クラスは、値の等価性を実装するためにメソッドを Object.Equals(Object) 頻繁にオーバーライドします。 さらに、型は、通常、インターフェイスを実装IEquatable<T>することによって、メソッドに厳密に型指定されたオーバーロードEquals
を追加する場合もよくあります。 メソッドを Equals
呼び出して等価性をテストする場合は、現在のインスタンスがオーバーライド Object.Equals されるかどうかを確認し、メソッドに対する特定の呼び出しがどのように解決されるかを Equals
理解する必要があります。 それ以外の場合は、意図した内容とは異なる等価性のテストを実行している可能性があり、メソッドは予期しない値を返す可能性があります。
具体的な例を次に示します。 同じ文字列で 3 つの StringBuilder オブジェクトをインスタンス化し、メソッドを Equals
4 回呼び出します。 最初のメソッド呼び出しが true
返され、残りの 3 つの戻り値が返されます 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
最初のケースでは、値の等価性をテストする厳密に型指定された StringBuilder.Equals(StringBuilder) メソッド オーバーロードが呼び出されます。 2 つのStringBuilderオブジェクトに割り当てられた文字列は等しいので、メソッドは .true
ただし、 StringBuilder オーバーライド Object.Equals(Object)しません。 このため、インスタンスがStringBuilder型Objectの変数にStringBuilderObject割り当てられ、メソッドが 2 つのStringBuilderオブジェクトを渡されるとObject.Equals(Object, Object)、既定Object.Equals(Object)のメソッドが呼び出されるときに、オブジェクトが a にキャストされます。 参照型であるため StringBuilder 、これは 2 つの StringBuilder オブジェクトをメソッドに渡すことと ReferenceEquals 同じです。 3 つの StringBuilder オブジェクトはすべて同じ文字列を含みますが、3 つの異なるオブジェクトを参照します。 その結果、これら 3 つのメソッド呼び出しが返されます false
。
メソッドを呼び出すことで、現在のオブジェクトを別のオブジェクトと比較して参照の等価性を ReferenceEquals 得ることができます。 Visual Basicでは、キーワード (たとえばIf Me Is otherObject Then ...
) をis
使用することもできます。
継承者に関する注意事項
独自の型を定義すると、その型は、その基本型のメソッドによって定義された機能を Equals
継承します。 次の表は、.NET Frameworkの型のEquals
主要なカテゴリに対するメソッドの既定の実装の一覧です。
型のカテゴリ | によって定義される等価性 | コメント |
---|---|---|
から直接派生したクラス Object | Object.Equals(Object) | 参照の等価性。呼び出し Object.ReferenceEqualsに相当します。 |
構造 | ValueType.Equals | 値の等価性。リフレクションを使用した直接バイト単位の比較またはフィールドごとのフィールド比較。 |
列挙 | Enum.Equals | 値は、同じ列挙型と同じ基になる値を持つ必要があります。 |
代理人 | MulticastDelegate.Equals | デリゲートは、同じ呼び出しリストを持つ同じ型である必要があります。 |
インターフェイス | Object.Equals(Object) | 参照の等価性。 |
リフレクションに依存する等価性のテストではパフォーマンスが低下するため、値型の場合は常にオーバーライド Equalsする必要があります。 参照の等価性の代わりに値の Equals 等価性をテストし、値の等価性の正確な意味を定義する参照型の既定の実装をオーバーライドすることもできます。 2 つのオブジェクトが Equals 同じインスタンスではない場合でも、同じ値を持つ場合の return true
のこのような実装。 型の実装者は、オブジェクトの値を構成するものを決定しますが、通常はオブジェクトのインスタンス変数に格納されているデータの一部またはすべてです。 たとえば、オブジェクトのString値は文字列String.Equals(Object)の文字に基づいています。メソッドは、同じ順序で同じ文字を含む任意の 2 つの文字列インスタンスに対して返すtrue
メソッドをオーバーライドObject.Equals(Object)します。
次の例は、メソッドをオーバーライドして値の Object.Equals(Object) 等価性をテストする方法を示しています。 クラスのメソッドPerson
をEqualsオーバーライドします。 等価性の基本クラスの実装を受け入れた場合 Person
、2 つの Person
オブジェクトは、単一のオブジェクトを参照した場合にのみ等しくなります。 ただし、この場合、プロパティの値が同じである場合、2 つの Person
オブジェクトは Person.Id
等しくなります。
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
オーバーライドに加えて、インターフェイスをEqualsIEquatable<T>実装して、厳密に型指定された等価性のテストを提供できます。
次のステートメントは、メソッドのすべての実装 Equals(Object) に当てはまる必要があります。 リスト内で、 x``y``z
null 以外のオブジェクト参照を表します。
x.Equals(x)
は、true
を返します。x.Equals(y)
からはy.Equals(x)
と同じ値が返されます。x.Equals(y)
は、両方の場合は を返しますNaN``y
。true
x
戻り値の場合
(x.Equals(y) && y.Equals(z))
はtrue
、x.Equals(z)
を返しますtrue
。参照されるオブジェクトが変更されない限り、同じ値を返す連続する
x
呼び出x.Equals(y)
しy
。x.Equals(null)
は、false
を返します。
の実装では例外を Equals スローしないでください。常に値を返す必要があります。 たとえば、次の場合obj
、null
Equalsメソッドは false
.ArgumentNullException
オーバーライドする場合は、次のガイドラインに Equals(Object)従ってください。
実装 IComparable する型はオーバーライド Equals(Object)する必要があります。
オーバーライド Equals(Object) する型もオーバーライド GetHashCodeする必要があります。そうしないと、ハッシュ テーブルが正しく機能しない可能性があります。
等しいかどうかを厳密に型指定したテストをサポートするには、インターフェイスの実装 IEquatable<T> を検討する必要があります。 IEquatable<T>.Equals 実装からは、Equals と一致する結果が返されなければなりません。
プログラミング言語で演算子のオーバーロードがサポートされていて、特定の型の等値演算子をオーバーロードする場合は、等値演算子と同じ結果を返すようにメソッドをオーバーライド Equals(Object) する必要もあります。 これにより、等値演算子をアプリケーション コードで使用する方法とHashtable一貫性のある方法で (などArrayList) を使用Equalsするクラス ライブラリ コードが動作することを保証できます。
参照型のガイドライン
参照型のオーバーライド Equals(Object) には、次のガイドラインが適用されます。
型のセマンティクスが、型が何らかの値を表すという事実に基づいている場合は、オーバーライド Equals することを検討してください。
ほとんどの参照型は、オーバーライド Equalsしても等値演算子をオーバーロードすることはできません。 ただし、複素数型などの値セマンティクスを持つ参照型を実装する場合は、等値演算子をオーバーライドする必要があります。
変更可能な参照型ではオーバーライド Equals しないでください。 これは、前の Equals セクションで説明したように、オーバーライドではメソッドもオーバーライド GetHashCode する必要があるためです。 つまり、変更可能な参照型のインスタンスのハッシュ コードは有効期間中に変更される可能性があるため、ハッシュ テーブルでオブジェクトが失われる可能性があります。
値型のガイドライン
値型のオーバーライド Equals(Object) には、次のガイドラインが適用されます。
参照型の値を持つ 1 つ以上のフィールドを含む値型を定義する場合は、オーバーライド Equals(Object)する必要があります。 提供されるValueType実装ではEquals(Object)、フィールドがすべての値型である値型に対してバイト単位の比較を実行しますが、リフレクションを使用して、参照型を含む値型のフィールドごとの比較を実行します。
オーバーライド Equals し、開発言語で演算子のオーバーロードがサポートされている場合は、等値演算子をオーバーロードする必要があります。
インターフェイスを実装する IEquatable<T> 必要があります。 厳密に型指定された IEquatable<T>.Equals メソッドを呼び出すと、引数のボックス化が
obj
回避されます。
こちらもご覧ください
適用対象
Equals(Object, Object)
指定されたインスタンスが等しいかどうかを判断します。
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
パラメーター
- objA
- Object
比較する最初のオブジェクト。
- objB
- Object
比較する 2 番目のオブジェクト。
戻り値
オブジェクトが等しいと見なされた場合は true
。それ以外の場合は false
。 objA
と objB
の両方が null の場合、このメソッドは true
を返します。
例
次の例では、メソッドを Equals(Object, Object) 示し、メソッドと ReferenceEquals 比較します。
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
注釈
静的Equals(Object, Object)メソッドは、2 つのオブジェクトと objB
、 objA
が等しいかどうかを示します。 また、値が null のオブジェクトの等価性をテストすることもできます。 次のように等しいかどうかを比較 objA
します objB
。
2 つのオブジェクトが同じオブジェクト参照を表すかどうかを決定します。 その場合、メソッド
true
は . このテストは、メソッドの呼び出しと ReferenceEquals 同じです。 さらに、両方ともobjA
objB
null の場合、メソッドtrue
は .null かどうかを
objA``objB
判断 します。 その場合は、false
.2 つのオブジェクトが同じオブジェクト参照を表せず、どちらも null でない場合は、呼び出されます
objA
。Equals
(objB
) を返し、結果を返します。 つまり、objA
メソッドをオーバーライドすると Object.Equals(Object) 、このオーバーライドが呼び出されます。