com.github.kvnxiao.jsonequals

Class JsonEquals

java.lang.Object

com.github.kvnxiao.jsonequals.JsonEquals

public class JsonEquals
extends java.lang.Object

A builder class used to compare two JSON elements.

Method Summary

Modifier and Type	Method and Description
static JsonEquals	between(me.doubledutch.lazyjson.LazyArray source, me.doubledutch.lazyjson.LazyArray comparate) Returns a new JsonEquals builder instance between two JSON arrays.
static JsonEquals	between(me.doubledutch.lazyjson.LazyObject source, me.doubledutch.lazyjson.LazyObject comparate) Returns a new JsonEquals builder instance between two JSON objects.
JsonCompareResult	compare() Compares the source with the comparate and returns a JsonCompareResult.
void	compareNode(me.doubledutch.lazyjson.LazyArray a, me.doubledutch.lazyjson.LazyArray b) Compares two JSON arrays, starting from the root level.
void	compareNode(me.doubledutch.lazyjson.LazyArray a, me.doubledutch.lazyjson.LazyArray b, java.lang.String currentPath) Compares two JSON arrays.
void	compareNode(me.doubledutch.lazyjson.LazyObject a, me.doubledutch.lazyjson.LazyObject b) Compares two JSON objects, starting from the root level.
void	compareNode(me.doubledutch.lazyjson.LazyObject a, me.doubledutch.lazyjson.LazyObject b, java.lang.String currentPath) Compares two JSON objects.
void	compareValues(me.doubledutch.lazyjson.LazyObject a, me.doubledutch.lazyjson.LazyObject b, java.lang.String fieldName, java.lang.String currentPath) Compares the values at the end of the JSON hierarchy (i.e.
static JsonEquals	ofType(me.doubledutch.lazyjson.LazyType rootType) Returns a new JsonEquals builder instance with the specified LazyType, being either for JSON objects or JSON arrays.
static void	setDebugMode(boolean debugMode) Sets the global debug mode for JSON comparisons.
JsonEquals	withComparate(me.doubledutch.lazyjson.LazyElement comparate) Specifies the JSON element comparate.
JsonEquals	withIgnoreFields(java.util.Set<java.lang.String> ignoreFields) Specifies the optional fields to ignore from comparison.
JsonEquals	withPruneFields(java.util.Map<java.lang.String,java.lang.String> pruneFields) Specifies the optional fields to prune before comparison.
JsonEquals	withSource(me.doubledutch.lazyjson.LazyElement source) Specifies the source JSON element.

Methods inherited from class java.lang.Object

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

Method Detail

ofType

public static JsonEquals ofType(me.doubledutch.lazyjson.LazyType rootType)

Returns a new JsonEquals builder instance with the specified LazyType, being either for JSON objects or JSON arrays.

Parameters:

rootType - The type of the JSON element, specified as either an object or array

Returns:

A new JsonEquals instance

between

public static JsonEquals between(me.doubledutch.lazyjson.LazyObject source,
                                 me.doubledutch.lazyjson.LazyObject comparate)

Returns a new JsonEquals builder instance between two JSON objects.

Parameters:

source - The JSON object source

comparate - The JSON object to be compared to

Returns:

A new JsonEquals instance with the specified source and comparate JSON objects

between

public static JsonEquals between(me.doubledutch.lazyjson.LazyArray source,
                                 me.doubledutch.lazyjson.LazyArray comparate)

Returns a new JsonEquals builder instance between two JSON arrays.

Parameters:

source - The JSON array source

comparate - The JSON array to be compared to

Returns:

A new JsonEquals instance with the specified source and comparate JSON arrays

withSource

public JsonEquals withSource(me.doubledutch.lazyjson.LazyElement source)

Specifies the source JSON element.

Parameters:

source - The JSON element source

Returns:

The JsonEquals instance

withComparate

public JsonEquals withComparate(me.doubledutch.lazyjson.LazyElement comparate)

Specifies the JSON element comparate.

Parameters:

comparate - The JSON element to compare to

Returns:

The JsonEquals instance

withIgnoreFields

public JsonEquals withIgnoreFields(java.util.Set<java.lang.String> ignoreFields)

Specifies the optional fields to ignore from comparison.

Parameters:

ignoreFields - The set of JSON node paths to ignore from comparison

Returns:

The JsonEquals instance

withPruneFields

public JsonEquals withPruneFields(java.util.Map<java.lang.String,java.lang.String> pruneFields)

Specifies the optional fields to prune before comparison.

Parameters:

pruneFields - The predicate map of JSON node paths to expected values that need to be pruned before comparison

Returns:

The JsonEquals instance

compare

public JsonCompareResult compare()

Compares the source with the comparate and returns a JsonCompareResult.

Returns:

The result of the deep-equal comparison

compareNode

public void compareNode(me.doubledutch.lazyjson.LazyObject a,
                        me.doubledutch.lazyjson.LazyObject b)

Compares two JSON objects, starting from the root level.

Parameters:

a - source JSON object

b - comparate JSON object

compareNode

public void compareNode(me.doubledutch.lazyjson.LazyArray a,
                        me.doubledutch.lazyjson.LazyArray b)

Compares two JSON arrays, starting from the root level.

Parameters:

a - source JSON array

b - comparate JSON array

compareNode

public void compareNode(me.doubledutch.lazyjson.LazyObject a,
                        me.doubledutch.lazyjson.LazyObject b,
                        java.lang.String currentPath)

Compares two JSON objects.

Parameters:

a - source JSON object

b - comparate JSON object

currentPath - The current JSON node path

compareNode

public void compareNode(me.doubledutch.lazyjson.LazyArray a,
                        me.doubledutch.lazyjson.LazyArray b,
                        java.lang.String currentPath)

Compares two JSON arrays.

Parameters:

a - source JSON array

b - comparate JSON array

currentPath - The current JSON node path

compareValues

public void compareValues(me.doubledutch.lazyjson.LazyObject a,
                          me.doubledutch.lazyjson.LazyObject b,
                          java.lang.String fieldName,
                          java.lang.String currentPath)

Compares the values at the end of the JSON hierarchy (i.e. a leaf node)

Parameters:

a - the value from the source

b - the value from the comparate

fieldName - the name of the JSON field which holds this value

currentPath - The current JSON node path

setDebugMode

public static void setDebugMode(boolean debugMode)

Sets the global debug mode for JSON comparisons. If set to true, all comparisons will be logged to the console using an SLF4J implementation.

Parameters:

debugMode - the debug mode boolean value