com.github.jonpereiradev.diffobjects.builder

Class DiffBuilder

java.lang.Object

com.github.jonpereiradev.diffobjects.builder.DiffBuilder

All Implemented Interfaces:

DiffInstanceBuilder

public final class DiffBuilder
extends Object
implements DiffInstanceBuilder

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

Since:

1.0

Author:

Jonathan Pereira

See Also:

DiffInstanceBuilder, DiffMappingBuilder, DiffConfiguration

Method Summary

Modifier and Type	Method and Description
static DiffBuilder	map(Class<?> clazz) Creates a diff instance instance to map the diff elements of a class.
DiffQueryMappingBuilder	mapping(String field) Maps the getter of the field for the class.
DiffQueryMappingBuilder	mapping(String field, String value) Maps the getter of the field for the class with the value property to allow deep diff.
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 DiffBuilder map(Class<?> clazz)

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

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

Returns:

the instance instance responsible for this mapping.

mapping

public DiffQueryMappingBuilder mapping(String field)

Maps the getter of the field for the class.

Specified by:

mapping in interface DiffInstanceBuilder

Parameters:

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

Returns:

the instance of this mapping instance.

mapping

public DiffQueryMappingBuilder mapping(String field,
                                       String value)

Maps the getter of the field for the class with the value property to allow deep diff.

Specified by:

mapping in interface DiffInstanceBuilder

Parameters:

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

value - the nested property of the object to make the diff.

Returns:

the instance of this mapping instance.

Throws:

DiffException - throw if the field doesn't have a public no args method for the field.