Class DiffResult<T>
- Type Parameters:
T
- type of the left and right object.
A DiffResult
contains a collection of the differences between two
Diffable
objects. Typically these differences are displayed using
toString()
method, which returns a string describing the fields that
differ between the objects.
Use a DiffBuilder
to build a DiffResult
comparing two objects.
- Since:
- 3.3
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
TheString
returned when the objects have no differences: "" -
Method Summary
Modifier and TypeMethodDescriptiongetDiffs()
Returns an unmodifiable list ofDiff
s.getLeft()
Returns the object the right object has been compared to.int
Returns the number of differences between the two objects.getRight()
Returns the object the left object has been compared to.Returns the style used by thetoString()
method.iterator()
Returns an iterator over theDiff
objects contained in this list.toString()
Builds aString
description of the differences contained within thisDiffResult
.toString
(ToStringStyle style) Builds aString
description of the differences contained within thisDiffResult
, using the suppliedToStringStyle
.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface java.lang.Iterable
forEach, spliterator
-
Field Details
-
OBJECTS_SAME_STRING
The
String
returned when the objects have no differences: ""- See Also:
-
-
Method Details
-
getLeft
Returns the object the right object has been compared to.
- Returns:
- the left object of the diff
- Since:
- 3.10
-
getRight
Returns the object the left object has been compared to.
- Returns:
- the right object of the diff
- Since:
- 3.10
-
getDiffs
Returns an unmodifiable list of
Diff
s. The list may be empty if there were no differences between the objects.- Returns:
- an unmodifiable list of
Diff
s
-
getNumberOfDiffs
public int getNumberOfDiffs()Returns the number of differences between the two objects.
- Returns:
- the number of differences
-
getToStringStyle
Returns the style used by the
toString()
method.- Returns:
- the style
-
toString
Builds a
String
description of the differences contained within thisDiffResult
. AToStringBuilder
is used for each object and the style of the output is governed by theToStringStyle
passed to the constructor.If there are no differences stored in this list, the method will return
OBJECTS_SAME_STRING
. Otherwise, using the example given inDiffable
andToStringStyle.SHORT_PREFIX_STYLE
, an output might be:Person[name=John Doe,age=32] differs from Person[name=Joe Bloggs,age=26]
This indicates that the objects differ in name and age, but not in smoking status.
To use a different
ToStringStyle
for an instance of this class, usetoString(ToStringStyle)
. -
toString
Builds a
String
description of the differences contained within thisDiffResult
, using the suppliedToStringStyle
.- Parameters:
style
- theToStringStyle
to use when outputting the objects- Returns:
- a
String
description of the differences.
-
iterator
Returns an iterator over the
Diff
objects contained in this list.
-