Object.Equals メソッド

定義

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

現在のオブジェクトと比較するオブジェクト。

戻り値

Boolean

指定したオブジェクトが現在のオブジェクトと等しい場合は true。それ以外の場合は false

次の例は、 メソッドをオーバーライドして値の等値を提供するクラスと、 から派生したクラス Point Equals Point3D を示しています Point 。 値の Point 等値 Object.Equals(Object) をテストするオーバーライドなので、 Object.Equals(Object) メソッドは呼び出されません。 ただし、 Point3D.EqualsPoint.Equals 呼び出す Point 理由は、 Object.Equals(Object) 値の等値を提供する方法で を実装します。

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
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

メソッドは、引数が null ではなく、このオブジェクトと同じ型のインスタンスを参照 Point.Equals obj する必要があることを確認します。 いずれかのチェックが失敗した場合、メソッドは を返します false

メソッド Point.Equals は、 メソッド GetType を呼び出して、2 つの オブジェクトの実行時の型が同一かどうかを判断します。 メソッドが C# または Visual Basic でフォームのチェックを使用した場合、現在のインスタンスが同じ実行時型ではない場合でも、 が の派生クラスのインスタンスである場合、チェックは を返します。 obj is Point TryCast(obj, Point) true obj Point obj 両方のオブジェクトの型が同じことを確認した後、メソッドは 型にキャストし、2 つの オブジェクトのインスタンス フィールドを比較した結果 obj Point を返します。

では Point3D.Equals 、 をオーバーライドする継承されたメソッドが、 Point.Equals Object.Equals(Object) 他の処理が行われる前に呼び出されます。 はシール クラス ( Visual Basic) なので、C# または Visual Basic の形式のチェックは、 が オブジェクトであるのを確認するために Point3D NotInheritable obj is Point TryCast(obj, 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
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# や 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
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 is TypeOf C# の 演算子または Visual Basic の 演算子を使用してパラメーターの型を確認 obj できます。

注釈

現在のインスタンスと パラメーターの比較の種類は、現在のインスタンスが参照型か値型か obj によって異なります。

  • 現在のインスタンスが参照型の場合、メソッドは参照の等価性をテストし、メソッドの呼び出しは メソッドの呼び出し Equals(Object) Equals(Object) と同 ReferenceEquals じです。 参照の等値は、比較されるオブジェクト変数が同じオブジェクトを参照します。 次の例は、このような比較の結果を示しています。 参照型である クラスを定義し、クラス コンストラクターを呼び出して、同じ値を持つ と の 2 つの新しいオブジェクト Person Person Person person1a person2 をインスタンス化します。 また、 を別の person1a オブジェクト変数 に割り当てします person1b 。 例の出力に示すように、 と は同じオブジェクトを参照します person1a person1b 。 ただし、 person1aperson2 は等しくないが、同じ値を持つ。

    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.
    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 つの オブジェクトの型は同じです。 次の例に示すように、12 の値を持つオブジェクトは、2 つのオブジェクトの実行時型が異なっているので、値 Byte が 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
      
      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 つの オブジェクトのパブリック フィールドとプライベート フィールドの値が等しくなります。 次の例では、値の等値をテストします。 これは、値型である 構造体を定義し、クラス コンストラクターを呼び出して、同じ値を持つ と の 2 つの新しいオブジェクト Person Person Person person1 person2 をインスタンス化します。 例の出力に示すように、2 つのオブジェクト変数は異なるオブジェクトを参照し、プライベート フィールドに対して同じ値を持つため、等 person1 person2 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.
      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
      

クラスは .NET Framework のすべての型の基本クラスなので、 メソッドは他のすべての型の既定の等値 Object Object.Equals(Object) 比較を提供します。 ただし、型は多くの場合、 メソッド Equals をオーバーライドして値の等値を実装します。 詳細については、「呼び出し元に関する注意事項」および「継承元に関する注意事項」セクションを参照してください。

Windows ランタイムに関する注意事項

Windows Runtime のクラスでメソッド オーバーロードを呼び出す場合は、 をオーバーライドしないクラスの既定の動作 Equals(Object) が提供されます Equals(Object) 。 これは、.NET Framework が Windows ランタイムに提供するサポートの一部です (「Windows Store Windows Apps と Windows ランタイムの .NET Framework サポート」を参照してください)。 ランタイムのクラスWindows継承されません。 Object 現在、メソッドは実装 Equals(Object) されません。 ただし ToString Equals(Object) 、C# または Visual Basic コードで使用すると、および メソッドが含み、.NET Framework によってこれらのメソッドの既定の動作が提供されます GetHashCode

注意

WindowsC# または C# で記述されたランタイム クラスは、Visual Basicオーバーライド Equals(Object) できます。

呼び出し元に関する注意事項

派生クラスは、多くの場合、 メソッドを Object.Equals(Object) オーバーライドして値の等値を実装します。 さらに、型は、通常は インターフェイスを実装することで、 メソッドに対してさらに強力に型指定されたオーバーロード Equals を提供する場合 IEquatable<T> もあります。 メソッドを呼び出して等しいかどうかをテストする場合は、現在のインスタンスがオーバーライドされているかどうかを把握し、メソッドへの特定の呼び出しがどのように Equals Object.Equals 解決される Equals のかを理解する必要があります。 それ以外の場合は、意図した値とは異なる等値のテストを実行し、メソッドが予期しない値を返す可能性があります。

具体的な例を次に示します。 同じ文字列を持つ StringBuilder 3 つの オブジェクトをインスタンス化し、メソッドに対して 4 つの呼び Equals 出しを行います。 最初のメソッド呼び出しは 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
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) 。 この理由から、 オブジェクトが にキャストされる場合、インスタンスが 型の変数に割り当てられている場合、および メソッドに 2 つのオブジェクトが渡された場合は、既定のメソッドが StringBuilder Object 呼び StringBuilder Object Object.Equals(Object, Object) StringBuilder Object.Equals(Object) 出されます。 は参照 StringBuilder 型なので、これは 2 つの オブジェクトを メソッドに StringBuilder 渡すのと同 ReferenceEquals じです。 3 つのオブジェクト StringBuilder はすべて同じ文字列を含むが、3 つの異なるオブジェクトを参照している。 その結果、これら 3 つのメソッド呼び出しは を返します false

メソッドを呼び出すことによって、現在のオブジェクトを別のオブジェクトと比較して参照の等しい値を指定 ReferenceEquals できます。 このVisual Basic、 キーワード is (例: ) を使用できます If Me Is otherObject Then ...

継承者に関する注意事項

独自の型を定義すると、その型は基本型の メソッドによって定義された Equals 機能を継承します。 次の表に、 メソッドの型の主要なカテゴリに対する メソッドの既定の実装 Equals を示.NET Framework。

型のカテゴリ で定義される等値 コメント
から直接派生したクラス Object Object.Equals(Object) 参照の等値。を呼び出すのと同じです Object.ReferenceEquals
構造 ValueType.Equals 値の等値。リフレクションを使用した直接バイトバイバイト比較またはフィールドバイフィールド比較。
列挙 Enum.Equals 値の列挙型は同じで、基になる値は同じである必要があります。
代理人 MulticastDelegate.Equals デリゲートは、同じ呼び出しリストを持つ同じ型である必要があります。
インターフェイス Object.Equals(Object) 参照の等値。

値型の場合は常に をオーバーライドする必要があります。リフレクションに依存する等値のテストではパフォーマンスが Equals 低下します。 参照型の の既定の実装をオーバーライドして、参照の等値の代わりに値の等値をテストし、値の等値の正確な意味 Equals を定義することもできます。 このような の実装は、2 つのオブジェクトが同じインスタンスではない場合でも、同じ値 Equals true を持つ場合に を返します。 型の実装者は、オブジェクトの値を構成するものを決定しますが、通常は、オブジェクトのインスタンス変数に格納されているデータの一部またはすべてです。 たとえば、 オブジェクトの値は文字列の文字に基づいており、 メソッドは、 メソッドをオーバーライドして、同じ順序で同じ文字を含む任意の 2 つの文字列インスタンスに対して を返 String String.Equals(Object) Object.Equals(Object) true します。

次の例は、 メソッドをオーバーライドして値の等値 Object.Equals(Object) をテストする方法を示しています。 クラスの メソッド Equals をオーバーライド Person します。 等値の基本クラスの実装を受け入れる場合、2 つのオブジェクトは 1 つのオブジェクトを参照 Person Person している場合にのみ等しくなります。 ただし、この場合、 プロパティの値 Person が同じ場合、2 つの オブジェクトは等 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
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

をオーバーライドする以外に、 インターフェイスを実装して、等値性の Equals IEquatable<T> テストを強力に型指定できます。

次のステートメントは、 メソッドのすべての実装に対して true である必要 Equals(Object) があります。 一覧の x 、、 y および は z 、null ではないオブジェクト参照を表します。

の実装では Equals 、例外をスローし "、常に値を返す必要があります。 たとえば、 が の obj 場合 null 、 メソッド Equals は をスローする代 false わりに を返す必要があります ArgumentNullException

をオーバーライドする場合は、次のガイドラインに従います Equals(Object)

  • を実装する型は IComparable 、 をオーバーライドする必要があります Equals(Object)

  • をオーバーライドする型 Equals(Object) もオーバーライドする必要があります GetHashCode 。それ以外の場合、ハッシュ テーブルが正しく機能しない可能性があります。

  • インターフェイスの実装を検討して IEquatable<T> 、等しいか、強く型指定されたテストをサポートする必要があります。 IEquatable<T>.Equals 実装からは、Equals と一致する結果が返されなければなりません。

  • プログラミング言語で演算子のオーバーロードがサポートされ、特定の型の等値演算子をオーバーロードする場合は、 メソッドをオーバーライドして、等値演算子と同じ結果を返す Equals(Object) 必要があります。 これにより、 ( や など) を使用するクラス ライブラリ コードが、アプリケーション コードで等値演算子を使用する方法と一致する方法で動作 Equals ArrayList Hashtable します。

参照型のガイドライン

参照型のオーバーライドには、次 Equals(Object) のガイドラインが適用されます。

  • 型のセマンティクスが、型が何らかの値を表すという事実に基づく場合は、オーバーライド Equals を検討してください。

  • ほとんどの参照型は、 をオーバーライドする場合でも、等値演算子をオーバーロードする必要があります Equals 。 ただし、複素数型などの値セマンティクスを持つ参照型を実装する場合は、等値演算子をオーバーライドする必要があります。

  • 変更可能な参照 Equals 型に対して をオーバーライドする必要があります。 これは、オーバーライドでは、前のセクションで説明したように、 メソッドもオーバーライド Equals GetHashCode する必要があるためです。 つまり、変更可能な参照型のインスタンスのハッシュ コードは有効期間中に変更される可能性があります。これにより、ハッシュ テーブルでオブジェクトが失われる可能性があります。

値型のガイドライン

値型のオーバーライドには、次 Equals(Object) のガイドラインが適用されます。

  • 値が参照型である 1 つ以上のフィールドを含む値型を定義する場合は、 をオーバーライドする必要があります Equals(Object) 。 によって提供される 実装では、すべての値型を持つ値型のバイトバイバイト比較が実行されますが、リフレクションを使用して、フィールドに参照型が含まれる値型のフィールドバイフィールド比較を実行します。 Equals(Object) ValueType

  • をオーバーライドし 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 番目のオブジェクト。

戻り値

Boolean

オブジェクトが等しいと見なされた場合は true。それ以外の場合は falseobjAobjB の両方が 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
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 つのオブジェクトが objA objB 等しいかどうかを示します。 また、値が null で等しいオブジェクト テストすることもできます。 次のように、 objAobjB が等しいと比較されます。

  • 2 つの オブジェクトが同じオブジェクト参照を表すかどうかを判断します。 その場合、メソッドは を返します true 。 このテストは、 メソッドを呼び出すのと同 ReferenceEquals じです。 また、 と の両方が objA objB null の場合、 メソッドは を返します true

  • または が null objA であるかどうかを objB 判断 します。 その場合は、 が返されます false

  • 2 つの オブジェクトが同じオブジェクト参照を表していない場合、どちらも null ではない場合は、 を呼び出します objAEquals( objB ) と は結果を返します。 つまり、 が objA メソッドをオーバーライドする Object.Equals(Object) 場合、このオーバーライドが呼び出されます。

こちらもご覧ください

適用対象