Skip to content

Commit 9c5f851

Browse files
author
Gabor Nagy
committed
IdentityConfigurer javadoc
1 parent 6f7af09 commit 9c5f851

File tree

2 files changed

+13
-3
lines changed

2 files changed

+13
-3
lines changed

src/main/java/de/danielbechler/diff/identity/IdentityConfigurer.java

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,20 @@
2626
* Applies rules to subclasses / interface implementations.
2727
*/
2828
public interface IdentityConfigurer {
29+
/**
30+
* @param nodePath of the collection to attach to.
31+
*/
2932
Of ofNode(NodePath nodePath);
3033

31-
Of ofType(Class<?> type);
34+
/**
35+
* @param collectionElementType of the elements within the collection to attach to.
36+
*/
37+
Of ofType(Class<?> collectionElementType);
3238

39+
/**
40+
* @param type of the host class of the collection to attach to.
41+
* @param propertyNames property name of the collection in the host class
42+
*/
3343
Of ofTypeAndProperty(Class<?> type, String... propertyNames);
3444

3545
ObjectDifferBuilder and();

src/main/java/de/danielbechler/diff/identity/IdentityService.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -111,8 +111,8 @@ public Of ofNode(final NodePath nodePath) {
111111
return new OfNodePath(nodePath);
112112
}
113113

114-
public Of ofType(final Class<?> type) {
115-
return new OfType(type);
114+
public Of ofType(final Class<?> collectionElementType) {
115+
return new OfType(collectionElementType);
116116
}
117117

118118
public Of ofTypeAndProperty(final Class<?> type,

0 commit comments

Comments
 (0)