-
Notifications
You must be signed in to change notification settings - Fork 47
Expand file tree
/
Copy pathObjectComparer.cs
More file actions
329 lines (296 loc) · 16.1 KB
/
Copy pathObjectComparer.cs
File metadata and controls
329 lines (296 loc) · 16.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
/********
* This file is part of Ext.NET.
*
* Ext.NET is free software: you can redistribute it and/or modify
* it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* Ext.NET is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU AFFERO GENERAL PUBLIC LICENSE for more details.
*
* You should have received a copy of the GNU AFFERO GENERAL PUBLIC LICENSE
* along with Ext.NET. If not, see <http://www.gnu.org/licenses/>.
*
*
* @version : 2.0.0.beta - Community Edition (AGPLv3 License)
* @author : Ext.NET, Inc. http://www.ext.net/
* @date : 2012-03-07
* @copyright : Copyright (c) 2007-2012, Ext.NET, Inc. (http://www.ext.net/). All rights reserved.
* @license : GNU AFFERO GENERAL PUBLIC LICENSE (AGPL) 3.0.
* See license.txt and http://www.ext.net/license/.
* See AGPL License at http://www.gnu.org/licenses/agpl-3.0.txt
********/
using System;
using System.Collections.Generic;
using System.Reflection;
namespace Ext.Net
{
/// <summary>
/// Utility class for comparing objects.
/// </summary>
public static class ObjectComparer
{
/// <summary>
/// Compares the public properties of any 2 objects and determines if the properties of each
/// all contain the same value.
/// <para>
/// In cases where object1 and object2 are of different Types (both being derived from Type T)
/// we will cast both objects down to the base Type T to ensure the property comparison is only
/// completed on COMMON properties.
/// (ex. Type T is Foo, object1 is GoodFoo and object2 is BadFoo -- both being inherited from Foo --
/// both objects will be cast to Foo for comparison)
/// </para>
/// </summary>
/// <typeparam name="T">Any class with public properties.</typeparam>
/// <param name="object1">Object to compare to object2.</param>
/// <param name="object2">Object to compare to object1.</param>
/// <param name="propertyInfoList">A List of <see cref="PropertyInfo"/> objects that contain data on the properties
/// from object1 that are not equal to the corresponding properties of object2.</param>
/// <returns>A boolean value indicating whether or not the properties of each object match.</returns>
public static bool GetDifferentProperties<T>(T object1, T object2, out List<PropertyInfo> propertyInfoList)
where T : class
{
return GetDifferentProperties<T>(object1, object2, null, out propertyInfoList);
}
/// <summary>
/// Compares the public properties of any 2 objects and determines if the properties of each
/// all contain the same value.
/// <para>
/// In cases where object1 and object2 are of different Types (both being derived from Type T)
/// we will cast both objects down to the base Type T to ensure the property comparison is only
/// completed on COMMON properties.
/// (ex. Type T is Foo, object1 is GoodFoo and object2 is BadFoo -- both being inherited from Foo --
/// both objects will be cast to Foo for comparison)
/// </para>
/// </summary>
/// <typeparam name="T">Any class with public properties.</typeparam>
/// <param name="object1">Object to compare to object2.</param>
/// <param name="object2">Object to compare to object1.</param>
/// <param name="ignoredProperties">A list of <see cref="PropertyInfo"/> objects
/// to ignore when completing the comparison.</param>
/// <param name="propertyInfoList">A List of <see cref="PropertyInfo"/> objects that contain data on the properties
/// from object1 that are not equal to the corresponding properties of object2.</param>
/// <returns>A boolean value indicating whether or not the properties of each object match.</returns>
public static bool GetDifferentProperties<T>(T object1, T object2, List<PropertyInfo> ignoredProperties, out List<PropertyInfo> propertyInfoList)
where T : class
{
propertyInfoList = new List<PropertyInfo>();
// If either object is null, we can't compare anything
if (object1 == null || object2 == null)
{
return false;
}
Type object1Type = object1.GetType();
Type object2Type = object2.GetType();
// In cases where object1 and object2 are of different Types (both being derived from Type T)
// we will cast both objects down to the base Type T to ensure the property comparison is only
// completed on COMMON properties.
// (ex. Type T is Foo, object1 is GoodFoo and object2 is BadFoo -- both being inherited from Foo --
// both objects will be cast to Foo for comparison)
if (object1Type != object2Type)
{
object1Type = typeof(T);
object2Type = typeof(T);
}
// Remove any properties to be ignored
List<PropertyInfo> comparisonProps =
RemoveProperties(object1Type.GetProperties(), ignoredProperties);
foreach (PropertyInfo object1Prop in comparisonProps)
{
Type propertyType = null;
object object1PropValue = null;
object object2PropValue = null;
// Rule out an attempt to check against a property which requires
// an index, such as one accessed via this[]
if (object1Prop.GetIndexParameters().GetLength(0) == 0)
{
// Get the value of each property
object1PropValue = object1Prop.GetValue(object1, null);
object2PropValue = object2Type.GetProperty(object1Prop.Name).GetValue(object2, null);
// As we are comparing 2 objects of the same type we know
// that they both have the same properties, so grab the
// first non-null value
if (object1PropValue != null)
propertyType = object1PropValue.GetType().GetInterface("IComparable");
if (propertyType == null)
if (object2PropValue != null)
propertyType = object2PropValue.GetType().GetInterface("IComparable");
}
// If both objects have null values or were indexed properties, don't continue
if (propertyType != null)
{
// If one property value is null and the other is not null,
// they aren't equal; this is done here as a native CompareTo
// won't work with a null value as the target
if (object1PropValue == null || object2PropValue == null)
{
propertyInfoList.Add(object1Prop);
}
else
{
// Use the native CompareTo method
MethodInfo nativeCompare = propertyType.GetMethod("CompareTo");
// Sanity Check:
// If we don't have a native CompareTo OR both values are null, we can't compare;
// hence, we can't confirm the values differ... just go to the next property
if (nativeCompare != null)
{
// Return the native CompareTo result
bool equal = (0 == (int)(nativeCompare.Invoke(object1PropValue, new object[] { object2PropValue })));
if (!equal)
{
propertyInfoList.Add(object1Prop);
}
}
}
}
}
return propertyInfoList.Count == 0;
}
/// <summary>
/// Compares the public properties of any 2 objects and determines if the properties of each
/// all contain the same value.
/// <para>
/// In cases where object1 and object2 are of different Types (both being derived from Type T)
/// we will cast both objects down to the base Type T to ensure the property comparison is only
/// completed on COMMON properties.
/// (ex. Type T is Foo, object1 is GoodFoo and object2 is BadFoo -- both being inherited from Foo --
/// both objects will be cast to Foo for comparison)
/// </para>
/// </summary>
/// <typeparam name="T">Any class with public properties.</typeparam>
/// <param name="object1">Object to compare to object2.</param>
/// <param name="object2">Object to compare to object1.</param>
/// <returns>A boolean value indicating whether or not the properties of each object match.</returns>
public static bool HasSamePropertyValues<T>(T object1, T object2)
where T : class
{
return HasSamePropertyValues<T>(object1, object2, null);
}
/// <summary>
/// Compares the public properties of any 2 objects and determines if the properties of each
/// all contain the same value.
/// <para>
/// In cases where object1 and object2 are of different Types (both being derived from Type T)
/// we will cast both objects down to the base Type T to ensure the property comparison is only
/// completed on COMMON properties.
/// (ex. Type T is Foo, object1 is GoodFoo and object2 is BadFoo -- both being inherited from Foo --
/// both objects will be cast to Foo for comparison)
/// </para>
/// </summary>
/// <typeparam name="T">Any class with public properties.</typeparam>
/// <param name="object1">Object to compare to object2.</param>
/// <param name="object2">Object to compare to object1.</param>
/// <param name="ignoredProperties">A list of <see cref="PropertyInfo"/> objects
/// to ignore when completing the comparison.</param>
/// <returns>A boolean value indicating whether or not the properties of each object match.</returns>
public static bool HasSamePropertyValues<T>(T object1, T object2, List<PropertyInfo> ignoredProperties)
where T : class
{
// If either object is null, we can't compare anything
if (object1 == null || object2 == null)
{
return false;
}
Type object1Type = object1.GetType();
Type object2Type = object2.GetType();
// In cases where object1 and object2 are of different Types (both being derived from Type T)
// we will cast both objects down to the base Type T to ensure the property comparison is only
// completed on COMMON properties.
// (ex. Type T is Foo, object1 is GoodFoo and object2 is BadFoo -- both being inherited from Foo --
// both objects will be cast to Foo for comparison)
if (object1Type != object2Type)
{
object1Type = typeof(T);
object2Type = typeof(T);
}
// Remove any properties to be ignored
List<PropertyInfo> comparisonProps =
RemoveProperties(object1Type.GetProperties(), ignoredProperties);
foreach (PropertyInfo object1Prop in comparisonProps)
{
Type propertyType = null;
object object1PropValue = null;
object object2PropValue = null;
// Rule out an attempt to check against a property which requires
// an index, such as one accessed via this[]
if (object1Prop.GetIndexParameters().GetLength(0) == 0)
{
// Get the value of each property
object1PropValue = object1Prop.GetValue(object1, null);
object2PropValue = object2Type.GetProperty(object1Prop.Name).GetValue(object2, null);
// As we are comparing 2 objects of the same type we know
// that they both have the same properties, so grab the
// first non-null value
if (object1PropValue != null)
propertyType = object1PropValue.GetType().GetInterface("IComparable");
if (propertyType == null)
if (object2PropValue != null)
propertyType = object2PropValue.GetType().GetInterface("IComparable");
}
// If both objects have null values or were indexed properties, don't continue
if (propertyType != null)
{
// If one property value is null and the other is not null,
// they aren't equal; this is done here as a native CompareTo
// won't work with a null value as the target
if (object1PropValue == null || object2PropValue == null)
{
return false;
}
// Use the native CompareTo method
MethodInfo nativeCompare = propertyType.GetMethod("CompareTo");
// Sanity Check:
// If we don't have a native CompareTo OR both values are null, we can't compare;
// hence, we can't confirm the values differ... just go to the next property
if (nativeCompare != null)
{
// Return the native CompareTo result
bool equal = (0 == (int)(nativeCompare.Invoke(object1PropValue, new object[] { object2PropValue })));
if (!equal)
{
return false;
}
}
}
}
return true;
}
/// <summary>
/// Removes any <see cref="PropertyInfo"/> object in the supplied List of
/// properties from the supplied Array of properties.
/// </summary>
/// <param name="allProperties">Array containing master list of
/// <see cref="PropertyInfo"/> objects.</param>
/// <param name="propertiesToRemove">List of <see cref="PropertyInfo"/> objects to
/// remove from the supplied array of properties.</param>
/// <returns>A List of <see cref="PropertyInfo"/> objects.</returns>
private static List<PropertyInfo> RemoveProperties(
IEnumerable<PropertyInfo> allProperties, IEnumerable<PropertyInfo> propertiesToRemove)
{
List<PropertyInfo> innerPropertyList = new List<PropertyInfo>();
// Add all properties to a list for easy manipulation
foreach (PropertyInfo prop in allProperties)
{
innerPropertyList.Add(prop);
}
// Sanity check
if (propertiesToRemove != null)
{
// Iterate through the properties to ignore and remove them from the list of
// all properties, if they exist
foreach (PropertyInfo ignoredProp in propertiesToRemove)
{
if (innerPropertyList.Contains(ignoredProp))
{
innerPropertyList.Remove(ignoredProp);
}
}
}
return innerPropertyList;
}
}
}