mcs/class/System.Xml.Linq/Documentation/en/System.Xml.Linq/XNodeEqualityComparer.xml

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <Type Name="XNodeEqualityComparer" FullName="System.Xml.Linq.XNodeEqualityComparer">
   3   <TypeSignature Language="C#" Value="public sealed class XNodeEqualityComparer : System.Collections.Generic.IEqualityComparer&lt;System.Xml.Linq.XNode&gt;, System.Collections.IEqualityComparer" />
   4   <TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit XNodeEqualityComparer extends System.Object implements class System.Collections.Generic.IEqualityComparer`1&lt;class System.Xml.Linq.XNode&gt;, class System.Collections.IEqualityComparer" />
   5   <AssemblyInfo>
   6     <AssemblyName>System.Xml.Linq</AssemblyName>
   7     <AssemblyVersion>4.0.0.0</AssemblyVersion>
   8   </AssemblyInfo>
   9   <Base>
  10     <BaseTypeName>System.Object</BaseTypeName>
  11   </Base>
  12   <Interfaces>
  13     <Interface>
  14       <InterfaceName>System.Collections.Generic.IEqualityComparer&lt;System.Xml.Linq.XNode&gt;</InterfaceName>
  15     </Interface>
  16     <Interface>
  17       <InterfaceName>System.Collections.IEqualityComparer</InterfaceName>
  18     </Interface>
  19   </Interfaces>
  20   <Docs>
  21     <remarks>
  22       <attribution license="cc4" from="Microsoft" modified="false" />
  23       <para>The purpose of this class is to implement <see cref="T:System.Collections.IEqualityComparer" /> and <see cref="T:System.Collections.Generic.IEqualityComparer`1" />. Classes that require identity (such as <see cref="T:System.Collections.Generic.Dictionary`2" /> ) require an instance of a class that implements one of these interfaces. </para>
  24     </remarks>
  25     <summary>
  26       <attribution license="cc4" from="Microsoft" modified="false" />
  27       <para>Compares nodes to determine whether they are equal. This class cannot be inherited. </para>
  28     </summary>
  29   </Docs>
  30   <Members>
  31     <Member MemberName=".ctor">
  32       <MemberSignature Language="C#" Value="public XNodeEqualityComparer ();" />
  33       <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
  34       <MemberType>Constructor</MemberType>
  35       <AssemblyInfo>
  36         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  37       </AssemblyInfo>
  38       <Parameters />
  39       <Docs>
  40         <remarks>To be added.</remarks>
  41         <summary>
  42           <attribution license="cc4" from="Microsoft" modified="false" />
  43           <para>Initializes a new instance of the <see cref="T:System.Xml.Linq.XNodeEqualityComparer" /> class. </para>
  44         </summary>
  45       </Docs>
  46     </Member>
  47     <Member MemberName="Equals">
  48       <MemberSignature Language="C#" Value="public bool Equals (System.Xml.Linq.XNode x, System.Xml.Linq.XNode y);" />
  49       <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool Equals(class System.Xml.Linq.XNode x, class System.Xml.Linq.XNode y) cil managed" />
  50       <MemberType>Method</MemberType>
  51       <AssemblyInfo>
  52         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  53       </AssemblyInfo>
  54       <ReturnValue>
  55         <ReturnType>System.Boolean</ReturnType>
  56       </ReturnValue>
  57       <Parameters>
  58         <Parameter Name="x" Type="System.Xml.Linq.XNode" />
  59         <Parameter Name="y" Type="System.Xml.Linq.XNode" />
  60       </Parameters>
  61       <Docs>
  62         <remarks>
  63           <attribution license="cc4" from="Microsoft" modified="false" />
  64           <para>The following criteria determine whether two nodes are equal:</para>
  65           <list type="bullet">
  66             <item>
  67               <para>A null node is equal to another null node but unequal to a non-null node. </para>
  68             </item>
  69             <item>
  70               <para>Two <see cref="T:System.Xml.Linq.XNode" /> objects of different types are never equal. </para>
  71             </item>
  72             <item>
  73               <para>Two <see cref="T:System.Xml.Linq.XText" /> nodes are equal if they contain the same text. </para>
  74             </item>
  75             <item>
  76               <para>Two <see cref="T:System.Xml.Linq.XElement" /> nodes are equal if they have the same tag name, the same set of attributes with the same values, and (ignoring comments and processing instructions), contain two equal-length sequences of pairwise equal content nodes. </para>
  77             </item>
  78             <item>
  79               <para>Two <see cref="T:System.Xml.Linq.XDocument" /> objects are equal if their root nodes are equal. </para>
  80             </item>
  81             <item>
  82               <para>Two <see cref="T:System.Xml.Linq.XComment" /> nodes are equal if they contain the same comment text. </para>
  83             </item>
  84             <item>
  85               <para>Two <see cref="T:System.Xml.Linq.XProcessingInstruction" /> nodes are equal if they have the same target and data. </para>
  86             </item>
  87             <item>
  88               <para>Two <see cref="T:System.Xml.Linq.XDocumentType" /> nodes are equal if the have the same name, public ID, system ID, and internal subset.</para>
  89             </item>
  90           </list>
  91         </remarks>
  92         <summary>
  93           <attribution license="cc4" from="Microsoft" modified="false" />
  94           <para>Compares the values of two nodes.</para>
  95         </summary>
  96         <returns>
  97           <attribution license="cc4" from="Microsoft" modified="false" />
  98           <para>A <see cref="T:System.Boolean" /> indicating if the nodes are equal.</para>
  99         </returns>
 100         <param name="x">
 101           <attribution license="cc4" from="Microsoft" modified="false" />The first <see cref="T:System.Xml.Linq.XNode" /> to compare.</param>
 102         <param name="y">
 103           <attribution license="cc4" from="Microsoft" modified="false" />The second <see cref="T:System.Xml.Linq.XNode" /> to compare.</param>
 104       </Docs>
 105     </Member>
 106     <Member MemberName="GetHashCode">
 107       <MemberSignature Language="C#" Value="public int GetHashCode (System.Xml.Linq.XNode obj);" />
 108       <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance int32 GetHashCode(class System.Xml.Linq.XNode obj) cil managed" />
 109       <MemberType>Method</MemberType>
 110       <AssemblyInfo>
 111         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 112       </AssemblyInfo>
 113       <ReturnValue>
 114         <ReturnType>System.Int32</ReturnType>
 115       </ReturnValue>
 116       <Parameters>
 117         <Parameter Name="obj" Type="System.Xml.Linq.XNode" />
 118       </Parameters>
 119       <Docs>
 120         <remarks>
 121           <attribution license="cc4" from="Microsoft" modified="false" />
 122           <para>The <see cref="T:System.Xml.Linq.XNode" /> implementation of <see cref="M:System.Object.GetHashCode" /> is based on the referential identity of the node. This method computes a deep hash code based on the value of the node and all descendants. The hash code reflects all attributes and all descendent nodes.</para>
 123         </remarks>
 124         <summary>
 125           <attribution license="cc4" from="Microsoft" modified="false" />
 126           <para>Returns a hash code based on an <see cref="T:System.Xml.Linq.XNode" />.</para>
 127         </summary>
 128         <returns>
 129           <attribution license="cc4" from="Microsoft" modified="false" />
 130           <para>A <see cref="T:System.Int32" /> that contains a value-based hash code for the node.</para>
 131         </returns>
 132         <param name="obj">
 133           <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Xml.Linq.XNode" /> to hash.</param>
 134       </Docs>
 135     </Member>
 136     <Member MemberName="System.Collections.IEqualityComparer.Equals">
 137       <MemberSignature Language="C#" Value="bool IEqualityComparer.Equals (object n1, object n2);" />
 138       <MemberSignature Language="ILAsm" Value=".method hidebysig newslot virtual instance bool System.Collections.IEqualityComparer.Equals(object n1, object n2) cil managed" />
 139       <MemberType>Method</MemberType>
 140       <AssemblyInfo>
 141         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 142       </AssemblyInfo>
 143       <ReturnValue>
 144         <ReturnType>System.Boolean</ReturnType>
 145       </ReturnValue>
 146       <Parameters>
 147         <Parameter Name="n1" Type="System.Object" />
 148         <Parameter Name="n2" Type="System.Object" />
 149       </Parameters>
 150       <Docs>
 151         <param name="n1">To be added.</param>
 152         <param name="n2">To be added.</param>
 153         <remarks>
 154           <attribution license="cc4" from="Microsoft" modified="false" />
 155           <para>The following criteria determine whether two nodes are equal:</para>
 156           <list type="bullet">
 157             <item>
 158               <para>A null node is equal to another null node but unequal to a non-null node. </para>
 159             </item>
 160             <item>
 161               <para>Two <see cref="T:System.Xml.Linq.XNode" /> objects of different types are never equal. </para>
 162             </item>
 163             <item>
 164               <para>Two <see cref="T:System.Xml.Linq.XText" /> nodes are equal if they contain the same text. </para>
 165             </item>
 166             <item>
 167               <para>Two <see cref="T:System.Xml.Linq.XElement" /> nodes are equal if they have the same tag name, the same set of attributes with the same values, and (ignoring comments and processing instructions), contain two equa-length sequences of pairwise equal content nodes. </para>
 168             </item>
 169             <item>
 170               <para>Two <see cref="T:System.Xml.Linq.XDocument" /> objects are equal if their root nodes are equal. </para>
 171             </item>
 172             <item>
 173               <para>Two <see cref="T:System.Xml.Linq.XComment" /> nodes are equal if they contain the same comment text. </para>
 174             </item>
 175             <item>
 176               <para>Two <see cref="T:System.Xml.Linq.XProcessingInstruction" /> nodes are equal if they have the same target and data. </para>
 177             </item>
 178             <item>
 179               <para>Two <see cref="T:System.Xml.Linq.XDocumentType" /> nodes are equal if the have the same name, public ID, system ID, and internal subset.</para>
 180             </item>
 181           </list>
 182         </remarks>
 183         <summary>
 184           <attribution license="cc4" from="Microsoft" modified="false" />
 185           <para>Compares the values of two nodes.</para>
 186         </summary>
 187         <returns>
 188           <attribution license="cc4" from="Microsoft" modified="false" />
 189           <para>true if the nodes are equal; otherwise false.</para>
 190         </returns>
 191       </Docs>
 192     </Member>
 193     <Member MemberName="System.Collections.IEqualityComparer.GetHashCode">
 194       <MemberSignature Language="C#" Value="int IEqualityComparer.GetHashCode (object obj);" />
 195       <MemberSignature Language="ILAsm" Value=".method hidebysig newslot virtual instance int32 System.Collections.IEqualityComparer.GetHashCode(object obj) cil managed" />
 196       <MemberType>Method</MemberType>
 197       <AssemblyInfo>
 198         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 199       </AssemblyInfo>
 200       <ReturnValue>
 201         <ReturnType>System.Int32</ReturnType>
 202       </ReturnValue>
 203       <Parameters>
 204         <Parameter Name="obj" Type="System.Object" />
 205       </Parameters>
 206       <Docs>
 207         <remarks>
 208           <attribution license="cc4" from="Microsoft" modified="false" />
 209           <para>The <see cref="T:System.Xml.Linq.XNode" /> implementation of <see cref="T:System.Object.GetHashCode" /> is based on the referential identity of the node. This method computes a deep hash code based on the value of the node, its attributes, and its descendants.</para>
 210         </remarks>
 211         <summary>
 212           <attribution license="cc4" from="Microsoft" modified="false" />
 213           <para>Returns a hash code based on the value of a node.</para>
 214         </summary>
 215         <returns>
 216           <attribution license="cc4" from="Microsoft" modified="false" />
 217           <para>A <see cref="T:System.Int32" /> that contains a value-based hash code for the node.</para>
 218         </returns>
 219         <param name="obj">
 220           <attribution license="cc4" from="Microsoft" modified="false" />The node to hash.</param>
 221       </Docs>
 222     </Member>
 223   </Members>
 224 </Type>