Object.Equals(Object) Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Indicates whether some other object is "equal to" this one.
[Android.Runtime.Register("equals", "(Ljava/lang/Object;)Z", "GetEquals_Ljava_lang_Object_Handler")]
public virtual bool Equals (Java.Lang.Object? obj);
[<Android.Runtime.Register("equals", "(Ljava/lang/Object;)Z", "GetEquals_Ljava_lang_Object_Handler")>]
override this.Equals : Java.Lang.Object -> bool
Parameters
- obj
- Object
the reference object with which to compare.
Returns
true
if this object is the same as the obj
argument; false
otherwise.
- Attributes
Remarks
Indicates whether some other object is "equal to" this one.
The equals
method implements an equivalence relation on non-null object references: <ul> <li>It is reflexive: for any non-null reference value x
, x.equals(x)
should return true
. <li>It is symmetric: for any non-null reference values x
and y
, x.equals(y)
should return true
if and only if y.equals(x)
returns true
. <li>It is transitive: for any non-null reference values x
, y
, and z
, if x.equals(y)
returns true
and y.equals(z)
returns true
, then x.equals(z)
should return true
. <li>It is consistent: for any non-null reference values x
and y
, multiple invocations of x.equals(y)
consistently return true
or consistently return false
, provided no information used in equals
comparisons on the objects is modified. <li>For any non-null reference value x
, x.equals(null)
should return false
. </ul>
The equals
method for class Object
implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x
and y
, this method returns true
if and only if x
and y
refer to the same object (x == y
has the value true
).
Note that it is generally necessary to override the hashCode
method whenever this method is overridden, so as to maintain the general contract for the hashCode
method, which states that equal objects must have equal hash codes.
Java documentation for java.lang.Object.equals(java.lang.Object)
.
Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.