com.github.jonpereiradev.diffobjects.builder

Class DiffBuilder<T>

java.lang.Object

com.github.jonpereiradev.diffobjects.builder.DiffBuilder<T>

All Implemented Interfaces:

DiffInstanceBuilder<T>

public final class DiffBuilder<T>
extends Object
implements DiffInstanceBuilder<T>

Responsible to map a class and fields to be able to generate diffs.

Since:

1.0.0

Author:

Jonathan Pereira

See Also:

DiffInstanceBuilder, DiffMappingBuilder, DiffConfiguration

Method Summary

Modifier and Type	Method and Description
static <T> DiffBuilder<T>	map(Class<T> clazz) Creates a diff instance instance to map the diff elements of a class.
DiffQueryMappingBuilder<T>	mapping(String field) Maps the getter of the field for the class.
<F> DiffQueryMappingBuilder<T>	mapping(String field, DiffComparator<F> fieldComparator) Maps the getter of the field for the class.
DiffMappingAllBuilder	mappingAll() Maps all the field of a class.

Methods inherited from class java.lang.Object

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

Method Detail

map

public static <T> DiffBuilder<T> map(Class<T> clazz)

Creates a diff instance instance to map the diff elements of a class.

Type Parameters:

T - the type of class the builder will create the mappings.

Parameters:

clazz - the class that will be registry to make diffs.

Returns:

the diff instance instance.

mappingAll

public DiffMappingAllBuilder mappingAll()

Maps all the field of a class.

Specified by:

mappingAll in interface DiffInstanceBuilder<T>

Returns:

the instance instance responsible for this mapping.

mapping

public DiffQueryMappingBuilder<T> mapping(String field)

Maps the getter of the field for the class.

Specified by:

mapping in interface DiffInstanceBuilder<T>

Parameters:

field - name of the field that will me used to find the getter method.

Returns:

the instance of this mapping instance.

mapping

public <F> DiffQueryMappingBuilder<T> mapping(String field,
                                              DiffComparator<F> fieldComparator)

Maps the getter of the field for the class.

Specified by:

mapping in interface DiffInstanceBuilder<T>

Type Parameters:

F - the type of object been mapped for the field.

Parameters:

field - name of the field that will me used to find the getter method.

fieldComparator - implementation that define how two objects will be check for equality.

Returns:

the instance of this mapping.