Package org.skyscreamer.jsonassert

Class JSONCompareResult

java.lang.Object

org.skyscreamer.jsonassert.JSONCompareResult

public class JSONCompareResult
extends java.lang.Object

Bean for holding results from JSONCompare.

Constructor Summary

Constructors

Constructor	Description
JSONCompareResult()	Default constructor.

Method Summary

Modifier and Type	Method	Description
void	fail(java.lang.String message)
JSONCompareResult	fail(java.lang.String field, java.lang.Object expected, java.lang.Object actual)	Identify that the comparison failed
JSONCompareResult	fail(java.lang.String field, ValueMatcherException exception)	Identify that the comparison failed
boolean	failed()	Did the comparison fail?
java.lang.Object	getActual()	Deprecated. Superseded by getFieldFailures()
java.lang.Object	getExpected()	Deprecated. Superseded by getFieldFailures()
java.lang.String	getField()	Deprecated. Superseded by getFieldFailures()
java.util.List<FieldComparisonFailure>	getFieldFailures()	Get the list of failures on field comparisons
java.util.List<FieldComparisonFailure>	getFieldMissing()	Get the list of missed on field comparisons
java.util.List<FieldComparisonFailure>	getFieldUnexpected()	Get the list of failures on field comparisons
java.lang.String	getMessage()	Result message
boolean	isFailureOnField()	Check if comparison failed on any particular fields
boolean	isMissingOnField()	Check if comparison failed with missing on any particular fields
boolean	isUnexpectedOnField()	Check if comparison failed with unexpected on any particular fields
JSONCompareResult	missing(java.lang.String field, java.lang.Object expected)	Identify the missing field
boolean	passed()	Did the comparison pass?
java.lang.String	toString()
JSONCompareResult	unexpected(java.lang.String field, java.lang.Object actual)	Identify unexpected field

Methods inherited from class java.lang.Object

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

Constructor Detail

JSONCompareResult

public JSONCompareResult()

Default constructor.

Method Detail

passed

public boolean passed()

Did the comparison pass?

Returns:

True if it passed

failed

public boolean failed()

Did the comparison fail?

Returns:

True if it failed

getMessage

public java.lang.String getMessage()

Result message

Returns:

String explaining why if the comparison failed

getFieldFailures

public java.util.List<FieldComparisonFailure> getFieldFailures()

Get the list of failures on field comparisons

Returns:

list of comparsion failures

getFieldMissing

public java.util.List<FieldComparisonFailure> getFieldMissing()

Get the list of missed on field comparisons

Returns:

list of comparsion failures

getFieldUnexpected

public java.util.List<FieldComparisonFailure> getFieldUnexpected()

Get the list of failures on field comparisons

Returns:

list of comparsion failures

getActual

@Deprecated
public java.lang.Object getActual()

Deprecated.

Superseded by getFieldFailures()

Actual field value

Returns:

a JSONObject, JSONArray or other Object instance, or null if the comparison did not fail on a particular field

getExpected

@Deprecated
public java.lang.Object getExpected()

Deprecated.

Superseded by getFieldFailures()

Expected field value

Returns:

a JSONObject, JSONArray or other Object instance, or null if the comparison did not fail on a particular field

isFailureOnField

public boolean isFailureOnField()

Check if comparison failed on any particular fields

Returns:

true if there are field failures

isMissingOnField

public boolean isMissingOnField()

Check if comparison failed with missing on any particular fields

Returns:

true if an expected field is missing

isUnexpectedOnField

public boolean isUnexpectedOnField()

Check if comparison failed with unexpected on any particular fields

Returns:

true if an unexpected field is in the result

getField

@Deprecated
public java.lang.String getField()

Deprecated.

Superseded by getFieldFailures()

Dot-separated path the the field that failed comparison

Returns:

a String instance, or null if the comparison did not fail on a particular field

fail

public void fail(java.lang.String message)

fail

public JSONCompareResult fail(java.lang.String field,
                              java.lang.Object expected,
                              java.lang.Object actual)

Identify that the comparison failed

Parameters:

field - Which field failed

expected - Expected result

actual - Actual result

Returns:

result of comparision

fail

public JSONCompareResult fail(java.lang.String field,
                              ValueMatcherException exception)

Identify that the comparison failed

Parameters:

field - Which field failed

exception - exception containing details of match failure

Returns:

result of comparision

missing

public JSONCompareResult missing(java.lang.String field,
                                 java.lang.Object expected)

Identify the missing field

Parameters:

field - missing field

expected - expected result

Returns:

result of comparison

unexpected

public JSONCompareResult unexpected(java.lang.String field,
                                    java.lang.Object actual)

Identify unexpected field

Parameters:

field - unexpected field

actual - actual result

Returns:

result of comparison

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object