Package org.springframework.test.json

Class JsonComparison

java.lang.Object

org.springframework.test.json.JsonComparison

public final class JsonComparison
extends Object

A comparison of two JSON strings as returned from a JsonComparator.

Since:

6.2

Author:

Phillip Webb

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	JsonComparison.Result	Comparison results.

Method Summary

Modifier and Type	Method	Description
String	getMessage()	Return a message describing the comparison.
JsonComparison.Result	getResult()	Return the result of the comparison.
static JsonComparison	match()	Factory method to create a new JsonComparison when the JSON strings match.
static JsonComparison	mismatch(String message)	Factory method to create a new JsonComparison when the JSON strings do not match.

Methods inherited from class java.lang.Object

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

Method Details

match

public static JsonComparison match()

Factory method to create a new JsonComparison when the JSON strings match.

Returns:

a new JsonComparison instance

mismatch

public static JsonComparison mismatch(String message)

Factory method to create a new JsonComparison when the JSON strings do not match.

Parameters:

message - a message describing the mismatch

Returns:

a new JsonComparison instance

getResult

public JsonComparison.Result getResult()

Return the result of the comparison.

getMessage

@Nullable
public String getMessage()

Return a message describing the comparison.