DiffResult

public class org.apache.commons.lang3.builder.DiffResult<T> implements Iterable<Diff<?>>

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.

Parameters:

<T> – type of the left and right object.

Since:

3.3

Fields and constants

OBJECTS_SAME_STRING

The String returned when the objects have no differences: ""

public static final String OBJECTS_SAME_STRING = ""

The String returned when the objects have no differences: ""

Methods

getDiffs()	Gets an unmodifiable list of Diffs.
getLeft()	Gets the object the right object has been compared to.
getNumberOfDiffs()	Gets the number of differences between the two objects.
getRight()	Gets the object the left object has been compared to.
getToStringStyle()	Gets the style used by the #toString() method.
iterator()	Returns an iterator over the Diff objects contained in this list.
toString()	Builds a String description of the differences contained within this DiffResult.
toString(ToStringStyle)	Builds a String description of the differences contained within this DiffResult, using the supplied ToStringStyle.

public List<Diff<?>> getDiffs()

Gets an unmodifiable list of Diffs. The list may be empty if there were no differences between the objects.

Returns:

An unmodifiable list of Diffs

public T getLeft()

Gets the object the right object has been compared to.

Returns:

The left object of the diff

Since:

3.10

public int getNumberOfDiffs()

Gets the number of differences between the two objects.

Returns:

The number of differences

public T getRight()

Gets the object the left object has been compared to.

Returns:

The right object of the diff

Since:

3.10

public ToStringStyle getToStringStyle()

Gets the style used by the #toString() method.

Returns:

The style

@Override public Iterator<Diff<?>> iterator()

Returns an iterator over the Diff objects contained in this list.

Returns:

The iterator

@Override public String toString()

Builds a String description of the differences contained within this DiffResult. A ToStringBuilder is used for each object and the style of the output is governed by the ToStringStyle 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 in Diffable and ToStringStyle#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, use #toString(ToStringStyle).

Returns:

A String description of the differences.

public String toString(ToStringStyle style)

Builds a String description of the differences contained within this DiffResult, using the supplied ToStringStyle.

Parameters:

style – the ToStringStyle to use when outputting the objects

Returns:

A String description of the differences.