com.github.jonpereiradev.diffobjects

Class DiffObjects<T>

java.lang.Object

com.github.jonpereiradev.diffobjects.DiffObjects<T>

Type Parameters:

T - type of object been compared.

public final class DiffObjects<T>
extends Object

Responsible for execute the diff between two objects.

Since:

1.0.0

Author:

Jonathan Pereira

Method Summary

Modifier and Type	Method and Description
List<DiffResult>	diff(Collection<T> expected, Collection<T> current, DiffComparator<T> matcher) Execute the diff between two objects using annotations.
List<DiffResult>	diff(Collection<T> expectedCollection, Collection<T> currentCollection, DiffConfiguration configuration, DiffComparator<T> matcher) Execute the diff between two objects using a configuration.
List<DiffResult>	diff(T expected, T current) Execute the diff between two objects using annotations.
List<DiffResult>	diff(T expected, T current, DiffConfiguration configuration) Execute the diff between two objects using a configuration.
static <T> DiffObjects<T>	forClass(Class<T> clazz) Creates a DiffObjects for a specific class.
boolean	isEquals(Collection<T> expectedCollection, Collection<T> currentCollection, DiffComparator<T> matcher) Check if exists any difference between the two objects using annotations.
boolean	isEquals(Collection<T> expectedCollection, Collection<T> currentCollection, DiffConfiguration configuration, DiffComparator<T> matcher) Check if exists any difference between the two objects.
boolean	isEquals(T expected, T current) Check if exists any difference between the two objects using annotations.
boolean	isEquals(T expected, T current, DiffConfiguration configuration) Check if exists any difference between the two objects.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

forClass

public static <T> DiffObjects<T> forClass(Class<T> clazz)

Creates a DiffObjects for a specific class.

Type Parameters:

T - type of the class.

Parameters:

clazz - class type of this DiffObjects.

Returns:

the DiffObjects for the class.

diff

public List<DiffResult> diff(T expected,
                             T current)

Execute the diff between two objects using annotations.

Parameters:

expected - the expected object state to compare with current object.

current - the current object state to compare with expected object.

Returns:

a list with the results of the diff.

diff

public List<DiffResult> diff(T expected,
                             T current,
                             DiffConfiguration configuration)

Execute the diff between two objects using a configuration.

Parameters:

expected - the expected object state to compare with after object.

current - the current object state to compare with before object.

configuration - the configuration of the diff.

Returns:

a list with the results of the diff.

diff

public List<DiffResult> diff(Collection<T> expected,
                             Collection<T> current,
                             DiffComparator<T> matcher)

Execute the diff between two objects using annotations.

Parameters:

expected - the expected object state to compare with after object.

current - the current object state to compare with before object.

matcher - the matcher that will define how an object from list is equals to other.

Returns:

a list with the results of the diff.

diff

public List<DiffResult> diff(Collection<T> expectedCollection,
                             Collection<T> currentCollection,
                             DiffConfiguration configuration,
                             DiffComparator<T> matcher)

Execute the diff between two objects using a configuration.

Parameters:

expectedCollection - the expected object state to compare with after object.

currentCollection - the current object state to compare with before object.

configuration - the configuration of the diff.

matcher - the matcher that will define how an object from list is equals to other.

Returns:

a list with the results of the diff.

isEquals

public boolean isEquals(T expected,
                        T current)

Check if exists any difference between the two objects using annotations.

Parameters:

expected - the expected object state to compare with after object.

current - the current object state to compare with before object.

Returns:

true if no difference exists between the objects or false otherwise.

isEquals

public boolean isEquals(T expected,
                        T current,
                        DiffConfiguration configuration)

Check if exists any difference between the two objects.

Parameters:

expected - the expected object state to compare with after object.

current - the current object state to compare with before object.

configuration - the configuration of the diff.

Returns:

true if no difference exists between the objects or false otherwise.

isEquals

public boolean isEquals(Collection<T> expectedCollection,
                        Collection<T> currentCollection,
                        DiffComparator<T> matcher)

Check if exists any difference between the two objects using annotations.

Parameters:

expectedCollection - the expected object state to compare with after object.

currentCollection - the current object state to compare with before object.

matcher - the matcher that will define how an object from list is equals to other.

Returns:

true if no difference exists between the objects or false otherwise.

isEquals

public boolean isEquals(Collection<T> expectedCollection,
                        Collection<T> currentCollection,
                        DiffConfiguration configuration,
                        DiffComparator<T> matcher)

Check if exists any difference between the two objects.

Parameters:

expectedCollection - the expected object state to compare with after object.

currentCollection - the current object state to compare with before object.

configuration - the configuration of the diff.

matcher - the matcher that will define how an object from list is equals to other.

Returns:

true if no difference exists between the objects or false otherwise.