Skip to content

Commit d67f7b2

Browse files
SQiShERSQiShER
committed
Added documentation to the config classes
1 parent 85a398f commit d67f7b2

25 files changed

Lines changed: 410 additions & 316 deletions

‎src/integration-test/java/de/danielbechler/diff/ObjectDifferITCase.java‎

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ public class ObjectDifferITCase
6161
@BeforeMethod
6262
public void setUp() throws Exception
6363
{
64-
objectDiffer = ObjectDifferBuilder.buildDefaultObjectDiffer();
64+
objectDiffer = ObjectDifferBuilder.buildDefault();
6565
}
6666

6767
public void testCompareBeanWithIgnoredMapProperty()
@@ -96,7 +96,7 @@ public void testCompareCollectionWithAddedItem() throws Exception
9696
final Collection<String> working = new LinkedList<String>(asList("foo"));
9797
final Collection<String> base = new LinkedList<String>();
9898

99-
final DiffNode node = ObjectDifferBuilder.buildDefaultObjectDiffer().compare(working, base);
99+
final DiffNode node = ObjectDifferBuilder.buildDefault().compare(working, base);
100100

101101
NodeAssertions.assertThat(node).self().hasState(DiffNode.State.CHANGED);
102102
NodeAssertions.assertThat(node).child(new CollectionItemElement("foo")).hasState(DiffNode.State.ADDED);
@@ -107,7 +107,7 @@ public void testCompareCollectionWithRemovedItem() throws Exception
107107
final Collection<String> working = new LinkedList<String>();
108108
final Collection<String> base = new LinkedList<String>(asList("foo"));
109109

110-
final DiffNode node = ObjectDifferBuilder.buildDefaultObjectDiffer().compare(working, base);
110+
final DiffNode node = ObjectDifferBuilder.buildDefault().compare(working, base);
111111

112112
NodeAssertions.assertThat(node).self().hasState(DiffNode.State.CHANGED);
113113
NodeAssertions.assertThat(node).child(new CollectionItemElement("foo")).hasState(DiffNode.State.REMOVED);
@@ -119,7 +119,7 @@ public void testThatIgnoredPropertiesAreNeverAccessed()
119119
final ObjectWithAccessTrackingIgnoredProperty working = new ObjectWithAccessTrackingIgnoredProperty();
120120
final ObjectWithAccessTrackingIgnoredProperty base = new ObjectWithAccessTrackingIgnoredProperty();
121121

122-
ObjectDifferBuilder.buildDefaultObjectDiffer().compare(working, base);
122+
ObjectDifferBuilder.buildDefault().compare(working, base);
123123

124124
Assertions.assertThat(working.accessed).isFalse();
125125
Assertions.assertThat(base.accessed).isFalse();
@@ -147,7 +147,7 @@ public void testCompareCollectionWithDifferentCollectionImplementationsSucceeds(
147147
final Collection<String> base = new LinkedHashSet<String>(asList("one", "two"));
148148
final Collection<String> working = new TreeSet<String>(asList("one", "three"));
149149

150-
final DiffNode node = ObjectDifferBuilder.buildDefaultObjectDiffer().compare(base, working);
150+
final DiffNode node = ObjectDifferBuilder.buildDefault().compare(base, working);
151151

152152
NodeAssertions.assertThat(node).self().hasState(DiffNode.State.CHANGED);
153153
}
@@ -158,7 +158,7 @@ public void testCompareCollectionWithChangedItem() throws Exception
158158
final List<?> working = asList(new ObjectWithIdentityAndValue("foo", "1"));
159159
final List<?> base = asList(new ObjectWithIdentityAndValue("foo", "2"));
160160

161-
final DiffNode node = ObjectDifferBuilder.buildDefaultObjectDiffer().compare(working, base);
161+
final DiffNode node = ObjectDifferBuilder.buildDefault().compare(working, base);
162162

163163
assertThat(node).self().hasChanges();
164164
assertThat(node).child(new CollectionItemElement(new ObjectWithIdentityAndValue("foo")))
@@ -172,7 +172,7 @@ public void testWithNewMapInWorkingAndNoneInBase()
172172
final Map<String, String> working = new TreeMap<String, String>();
173173
working.put("foo", "bar");
174174

175-
final DiffNode node = ObjectDifferBuilder.buildDefaultObjectDiffer().compare(working, base);
175+
final DiffNode node = ObjectDifferBuilder.buildDefault().compare(working, base);
176176

177177
NodeAssertions.assertThat(node).self().hasState(DiffNode.State.ADDED);
178178
NodeAssertions.assertThat(node).child(new MapKeyElement("foo")).hasState(DiffNode.State.ADDED);
@@ -185,7 +185,7 @@ public void testWithAdditionOfSimpleTypeToWorkingMap()
185185
final Map<String, String> working = new TreeMap<String, String>();
186186
working.put("foo", "bar");
187187

188-
final DiffNode node = ObjectDifferBuilder.buildDefaultObjectDiffer().compare(working, base);
188+
final DiffNode node = ObjectDifferBuilder.buildDefault().compare(working, base);
189189

190190
NodeAssertions.assertThat(node).self().hasState(DiffNode.State.CHANGED);
191191
NodeAssertions.assertThat(node).child(new MapKeyElement("foo")).hasState(DiffNode.State.ADDED);
@@ -199,7 +199,7 @@ public void testWithSameEntryInBaseAndWorking()
199199
final Map<String, String> working = new TreeMap<String, String>();
200200
working.put("foo", "bar");
201201

202-
final DiffNode node = ObjectDifferBuilder.buildDefaultObjectDiffer().compare(working, base);
202+
final DiffNode node = ObjectDifferBuilder.buildDefault().compare(working, base);
203203

204204
NodeAssertions.assertThat(node).self().hasState(DiffNode.State.UNTOUCHED);
205205
NodeAssertions.assertThat(node).self().hasNoChildren();
@@ -212,7 +212,7 @@ public void testWithSingleEntryAddedToWorkingMap()
212212
base.put("foo", "bar");
213213
final Map<String, String> working = null;
214214

215-
final DiffNode node = ObjectDifferBuilder.buildDefaultObjectDiffer().compare(working, base);
215+
final DiffNode node = ObjectDifferBuilder.buildDefault().compare(working, base);
216216

217217
NodeAssertions.assertThat(node).self().hasState(DiffNode.State.REMOVED);
218218
NodeAssertions.assertThat(node).child(new MapKeyElement("foo")).hasState(DiffNode.State.REMOVED);
@@ -231,7 +231,7 @@ public void testWithAllNullMapItem()
231231
final Map<String, String> base = new HashMap<String, String>(1);
232232
base.put("foo", null);
233233

234-
final DiffNode node = ObjectDifferBuilder.buildDefaultObjectDiffer().compare(working, base);
234+
final DiffNode node = ObjectDifferBuilder.buildDefault().compare(working, base);
235235

236236
NodeAssertions.assertThat(node).self().hasState(DiffNode.State.UNTOUCHED);
237237
}
@@ -244,7 +244,7 @@ public void testWithSameEntries()
244244
final Map<String, String> base = new LinkedHashMap<String, String>(modified);
245245
modified.put("ping", "pong");
246246

247-
final DiffNode node = ObjectDifferBuilder.buildDefaultObjectDiffer().compare(modified, base);
247+
final DiffNode node = ObjectDifferBuilder.buildDefault().compare(modified, base);
248248

249249
NodeAssertions.assertThat(node).root().hasChildren(1);
250250
NodeAssertions.assertThat(node)
@@ -264,7 +264,7 @@ public void testWithChangedEntry()
264264
final Map<String, String> base = new LinkedHashMap<String, String>(1);
265265
base.put("foo", "woot");
266266

267-
final DiffNode node = ObjectDifferBuilder.buildDefaultObjectDiffer().compare(working, base);
267+
final DiffNode node = ObjectDifferBuilder.buildDefault().compare(working, base);
268268
NodeAssertions.assertThat(node).self().hasChildren(1);
269269
NodeAssertions.assertThat(node).child(new MapKeyElement("foo")).hasState(DiffNode.State.CHANGED);
270270
}
@@ -275,23 +275,23 @@ public void testCompareWithDifferentMapImplementationsSucceeds() throws Exceptio
275275
final Map<String, String> base = new LinkedHashMap<String, String>(Collections.singletonMap("test", "foo"));
276276
final Map<String, String> working = new TreeMap<String, String>(Collections.singletonMap("test", "bar"));
277277

278-
final DiffNode node = ObjectDifferBuilder.buildDefaultObjectDiffer().compare(working, base);
278+
final DiffNode node = ObjectDifferBuilder.buildDefault().compare(working, base);
279279

280280
NodeAssertions.assertThat(node).self().hasState(DiffNode.State.CHANGED);
281281
}
282282

283283
@Test(groups = INTEGRATION)
284284
public void testCompareWithDifferentStrings() throws Exception
285285
{
286-
final DiffNode node = ObjectDifferBuilder.buildDefaultObjectDiffer().compare("foo", "bar");
286+
final DiffNode node = ObjectDifferBuilder.buildDefault().compare("foo", "bar");
287287

288288
assertThat(node).self().hasState(DiffNode.State.CHANGED);
289289
}
290290

291291
@Test(expectedExceptions = IllegalArgumentException.class, groups = INTEGRATION)
292292
public void testCompareWithDifferentTypes()
293293
{
294-
ObjectDifferBuilder.buildDefaultObjectDiffer().compare("foo", 1337);
294+
ObjectDifferBuilder.buildDefault().compare("foo", 1337);
295295
}
296296

297297
@Test(groups = INTEGRATION)
@@ -315,7 +315,7 @@ public void testCompareWithComplexType()
315315
// when(configuration.isReturnable(any(Node.class))).thenReturn(true);
316316
// when(node.hasChanges()).thenReturn(true);
317317

318-
final DiffNode node = ObjectDifferBuilder.buildDefaultObjectDiffer().compare(
318+
final DiffNode node = ObjectDifferBuilder.buildDefault().compare(
319319
new ObjectWithIdentityAndValue("a", "1"),
320320
new ObjectWithIdentityAndValue("a", "2"));
321321

@@ -327,7 +327,7 @@ public void testCompareWithListContainingObjectTwiceDetectsIfOneGetsRemoved() th
327327
{
328328
final List<ObjectWithHashCodeAndEquals> base = asList(new ObjectWithHashCodeAndEquals("foo"), new ObjectWithHashCodeAndEquals("foo"));
329329
final List<ObjectWithHashCodeAndEquals> working = asList(new ObjectWithHashCodeAndEquals("foo"));
330-
final DiffNode node = ObjectDifferBuilder.buildDefaultObjectDiffer().compare(working, base);
330+
final DiffNode node = ObjectDifferBuilder.buildDefault().compare(working, base);
331331
node.visit(new NodeHierarchyVisitor());
332332
assertThat(node)
333333
.child(NodePath.createBuilder()
@@ -342,7 +342,7 @@ public void testCompareWithListContainingObjectOnceDetectsIfAnotherInstanceOfItG
342342
{
343343
final List<ObjectWithHashCodeAndEquals> base = asList(new ObjectWithHashCodeAndEquals("foo"));
344344
final List<ObjectWithHashCodeAndEquals> working = asList(new ObjectWithHashCodeAndEquals("foo"), new ObjectWithHashCodeAndEquals("foo"));
345-
final DiffNode node = ObjectDifferBuilder.buildDefaultObjectDiffer().compare(working, base);
345+
final DiffNode node = ObjectDifferBuilder.buildDefault().compare(working, base);
346346
node.visit(new NodeHierarchyVisitor());
347347
assertThat(node).child(NodePath.createBuilder()
348348
.withRoot()

‎src/integration-test/java/de/danielbechler/diff/example/CanonicalAccessorExample.java‎

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,18 @@
1616

1717
package de.danielbechler.diff.example;
1818

19-
import de.danielbechler.diff.*;
20-
import de.danielbechler.diff.visitor.*;
19+
import de.danielbechler.diff.DiffNode;
20+
import de.danielbechler.diff.ObjectDifferBuilder;
21+
import de.danielbechler.diff.visitor.NodeHierarchyVisitor;
2122

22-
import java.util.*;
23+
import java.util.LinkedList;
24+
import java.util.List;
2325

24-
import static java.util.Arrays.*;
26+
import static java.util.Arrays.asList;
2527

26-
/** @author Daniel Bechler */
28+
/**
29+
* @author Daniel Bechler
30+
*/
2731
class CanonicalAccessorExample
2832
{
2933
private CanonicalAccessorExample()
@@ -41,8 +45,8 @@ public static void main(final String[] args)
4145
final Contact baseContact = new Contact("Walter White");
4246
baseAddressBook.setContacts(asList(baseContact));
4347

44-
final DiffNode rootNode = ObjectDifferBuilder.buildDefaultObjectDiffer()
45-
.compare(workingAddressBook, baseAddressBook);
48+
final DiffNode rootNode = ObjectDifferBuilder.buildDefault()
49+
.compare(workingAddressBook, baseAddressBook);
4650
final DiffNode contactsNode = getFirstChildOf(rootNode);
4751
final DiffNode contactNode = getFirstChildOf(contactsNode);
4852
final DiffNode nicknameNode = getFirstChildOf(contactNode);

‎src/integration-test/java/de/danielbechler/diff/example/Example2ITSpec.groovy‎

Lines changed: 78 additions & 91 deletions
Original file line numberDiff line numberDiff line change
@@ -24,104 +24,91 @@ import spock.lang.Specification
2424

2525
import static de.danielbechler.diff.DiffNode.State.UNTOUCHED
2626

27-
class Example2ITSpec extends Specification
28-
{
29-
def "Comparing an object via equalsOnlyValueProvider (via property annotation)"()
30-
{
31-
given:
32-
def base = new Company()
33-
base.manager = new PersonWithEqualsOnlyTypeAnnotation("Walter", "Walt", "White")
34-
35-
and:
36-
def working = new Company()
37-
working.manager = new PersonWithEqualsOnlyTypeAnnotation("Walter", "Heisenberg", "White")
38-
39-
expect:
40-
ObjectDifferBuilder.buildDefaultObjectDiffer().compare(working, base).state == UNTOUCHED
41-
}
42-
43-
def "Comparing an object via equalsOnlyValueProvider (via type annotation)"()
44-
{
45-
given:
46-
def base = new PersonWithEqualsOnlyTypeAnnotation("Walter", "Walt", "White")
47-
def working = new PersonWithEqualsOnlyTypeAnnotation("Walter", "Heisenberg", "White")
48-
49-
expect:
50-
ObjectDifferBuilder.buildDefaultObjectDiffer().compare(working, base).state == UNTOUCHED
51-
}
52-
53-
def "Comparing an object via equalsOnlyValueProvider (via configuration using property path)"()
54-
{
55-
given:
56-
def builder = ObjectDifferBuilder.startBuilding()
57-
builder.configure().comparison().ofNode(NodePath.buildRootPath()).toUseEqualsMethodOfValueProvidedByMethod("presentationForDiffer")
58-
59-
def base = new PersonWithEqualsOnlyTypeAnnotation("Walter", "Walt", "White")
60-
def working = new PersonWithEqualsOnlyTypeAnnotation("Walter", "Heisenberg", "White")
61-
62-
expect:
63-
builder.build().compare(working, base).state == UNTOUCHED
64-
}
65-
66-
def "Comparing an object via equalsOnlyValueProvider (via configuration using type)"()
67-
{
68-
given:
69-
def builder = ObjectDifferBuilder.startBuilding()
70-
builder.configure().comparison().ofType(Person).toUseEqualsMethodOfValueProvidedByMethod("presentationForDiffer")
71-
def base = new PersonWithEqualsOnlyTypeAnnotation("Walter", "Walt", "White")
72-
def working = new PersonWithEqualsOnlyTypeAnnotation("Walter", "Heisenberg", "White")
73-
74-
expect:
75-
builder.build().compare(working, base).state == UNTOUCHED
76-
}
77-
78-
79-
public static class Company
80-
{
81-
private Person manager;
82-
83-
@ObjectDiffProperty(equalsOnly = true, equalsOnlyValueProviderMethod = "presentationForDiffer")
84-
public Person getManager()
85-
{
86-
return manager
27+
class Example2ITSpec extends Specification {
28+
def "Comparing an object via equalsOnlyValueProvider (via property annotation)"() {
29+
given:
30+
def base = new Company()
31+
base.manager = new PersonWithEqualsOnlyTypeAnnotation("Walter", "Walt", "White")
32+
33+
and:
34+
def working = new Company()
35+
working.manager = new PersonWithEqualsOnlyTypeAnnotation("Walter", "Heisenberg", "White")
36+
37+
expect:
38+
ObjectDifferBuilder.buildDefault().compare(working, base).state == UNTOUCHED
8739
}
8840
89-
void setManager(final Person manager)
90-
{
91-
this.manager = manager
41+
def "Comparing an object via equalsOnlyValueProvider (via type annotation)"() {
42+
given:
43+
def base = new PersonWithEqualsOnlyTypeAnnotation("Walter", "Walt", "White")
44+
def working = new PersonWithEqualsOnlyTypeAnnotation("Walter", "Heisenberg", "White")
45+
46+
expect:
47+
ObjectDifferBuilder.buildDefault().compare(working, base).state == UNTOUCHED
9248
}
93-
}
94-
95-
public static class Person
96-
{
97-
private String firstname
98-
private String lastname
99-
private String nickname
100-
101-
public Person(String firstname, String nickname, String lastname)
102-
{
103-
this.firstname = firstname
104-
this.nickname = nickname
105-
this.lastname = lastname
49+
50+
def "Comparing an object via equalsOnlyValueProvider (via configuration using property path)"() {
51+
given:
52+
def builder = ObjectDifferBuilder.startBuilding()
53+
builder.configure().comparison().ofNode(NodePath.buildRootPath()).toUseEqualsMethodOfValueProvidedByMethod("presentationForDiffer")
54+
55+
def base = new PersonWithEqualsOnlyTypeAnnotation("Walter", "Walt", "White")
56+
def working = new PersonWithEqualsOnlyTypeAnnotation("Walter", "Heisenberg", "White")
57+
58+
expect:
59+
builder.build().compare(working, base).state == UNTOUCHED
60+
}
61+
62+
def "Comparing an object via equalsOnlyValueProvider (via configuration using type)"() {
63+
given:
64+
def builder = ObjectDifferBuilder.startBuilding()
65+
builder.configure().comparison().ofType(Person).toUseEqualsMethodOfValueProvidedByMethod("presentationForDiffer")
66+
def base = new PersonWithEqualsOnlyTypeAnnotation("Walter", "Walt", "White")
67+
def working = new PersonWithEqualsOnlyTypeAnnotation("Walter", "Heisenberg", "White")
68+
69+
expect:
70+
builder.build().compare(working, base).state == UNTOUCHED
10671
}
10772
108-
public String presentationForDiffer()
109-
{
110-
return firstname + " " + lastname
73+
74+
public static class Company {
75+
private Person manager;
76+
77+
@ObjectDiffProperty(equalsOnly = true, equalsOnlyValueProviderMethod = "presentationForDiffer")
78+
public Person getManager() {
79+
return manager
80+
}
81+
82+
void setManager(final Person manager) {
83+
this.manager = manager
84+
}
11185
}
11286
113-
boolean equals(final o)
114-
{
115-
return false
87+
public static class Person {
88+
private String firstname
89+
private String lastname
90+
private String nickname
91+
92+
public Person(String firstname, String nickname, String lastname) {
93+
this.firstname = firstname
94+
this.nickname = nickname
95+
this.lastname = lastname
96+
}
97+
98+
public String presentationForDiffer() {
99+
return firstname + " " + lastname
100+
}
101+
102+
boolean equals(final o) {
103+
return false
104+
}
116105
}
117-
}
118-
119-
@ObjectDiffEqualsOnlyType(valueProviderMethod = "presentationForDiffer")
120-
public static class PersonWithEqualsOnlyTypeAnnotation extends Person
121-
{
122-
public PersonWithEqualsOnlyTypeAnnotation(final String firstname, final String nickname, final String lastname)
123-
{
124-
super(firstname, nickname, lastname)
106+
107+
@ObjectDiffEqualsOnlyType(valueProviderMethod = "presentationForDiffer")
108+
public static class PersonWithEqualsOnlyTypeAnnotation extends Person {
109+
public PersonWithEqualsOnlyTypeAnnotation(
110+
final String firstname, final String nickname, final String lastname) {
111+
super(firstname, nickname, lastname)
112+
}
125113
}
126-
}
127114
}

‎src/integration-test/java/de/danielbechler/diff/example/MapEntryValueAccessExample.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ public static void main(final String[] args)
4444
working.put(23, "Shephard");
4545
working.put(42, "Kwon");
4646

47-
final DiffNode mapNode = ObjectDifferBuilder.buildDefaultObjectDiffer().compare(working, base);
47+
final DiffNode mapNode = ObjectDifferBuilder.buildDefault().compare(working, base);
4848
mapNode.visitChildren(new DiffNode.Visitor()
4949
{
5050
public void accept(final DiffNode node, final Visit visit)

0 commit comments

Comments
 (0)