com.jayway.jsonassert

Interface JsonAsserter

All Known Implementing Classes:

JsonAsserterImpl

public interface JsonAsserter

Method Summary

Modifier and Type	Method and Description
JsonAsserter	and() Syntactic sugar to allow chaining assertions with a separating and() statement with(json).assertThat("firstName", is(equalTo("Bobby"))).and().assertThat("lastName", is(equalTo("Ewing")))
<T> JsonAsserter	assertEquals(java.lang.String path, T expected) Asserts that object specified by path is equal to the expected value.
<T> JsonAsserter	assertEquals(java.lang.String path, T expected, java.lang.String message)
JsonAsserter	assertNotDefined(java.lang.String path) Checks that a path is not defined within a document.
JsonAsserter	assertNotDefined(java.lang.String path, java.lang.String message)
<T> JsonAsserter	assertNotNull(java.lang.String path) Asserts that object specified by path is NOT null.
<T> JsonAsserter	assertNotNull(java.lang.String path, java.lang.String message)
JsonAsserter	assertNull(java.lang.String path) Asserts that object specified by path is null.
JsonAsserter	assertNull(java.lang.String path, java.lang.String message)
<T> JsonAsserter	assertThat(java.lang.String path, org.hamcrest.Matcher<T> matcher) Asserts that object specified by path satisfies the condition specified by matcher.
<T> JsonAsserter	assertThat(java.lang.String path, org.hamcrest.Matcher<T> matcher, java.lang.String message)

Method Detail

assertThat

<T> JsonAsserter assertThat(java.lang.String path,
                            org.hamcrest.Matcher<T> matcher)

Asserts that object specified by path satisfies the condition specified by matcher. If not, an AssertionError is thrown with information about the matcher and failing value. Example:

with(json).assertThat("items[0].name", equalTo("Bobby")) .assertThat("items[0].age" , equalTo(24L))

Type Parameters:

T - the static type accepted by the matcher

Parameters:

path - the json path specifying the value being compared

matcher - an expression, built of Matchers, specifying allowed values

Returns:

this to allow fluent assertion chains

assertThat

<T> JsonAsserter assertThat(java.lang.String path,
                            org.hamcrest.Matcher<T> matcher,
                            java.lang.String message)

Type Parameters:

T - the static type that should be returned by the path

Parameters:

path - the json path specifying the value being compared

matcher - an expression, built of Matchers, specifying allowed values

message - the explanation message

Returns:

this to allow fluent assertion chains

assertEquals

<T> JsonAsserter assertEquals(java.lang.String path,
                              T expected)

Asserts that object specified by path is equal to the expected value. If they are not, an AssertionError is thrown with the given message.

Type Parameters:

T - the static type that should be returned by the path

Parameters:

path - the json path specifying the value being compared

expected - the expected value

Returns:

this to allow fluent assertion chains

assertEquals

<T> JsonAsserter assertEquals(java.lang.String path,
                              T expected,
                              java.lang.String message)

assertNotDefined

JsonAsserter assertNotDefined(java.lang.String path)

Checks that a path is not defined within a document. If the document contains the given path, an AssertionError is thrown

Parameters:

path - the path to make sure not exists

Returns:

this

assertNotDefined

JsonAsserter assertNotDefined(java.lang.String path,
                              java.lang.String message)

assertNull

JsonAsserter assertNull(java.lang.String path)

Asserts that object specified by path is null. If it is not, an AssertionError is thrown with the given message.

Parameters:

path - the json path specifying the value that should be null

Returns:

this to allow fluent assertion chains

assertNull

JsonAsserter assertNull(java.lang.String path,
                        java.lang.String message)

assertNotNull

<T> JsonAsserter assertNotNull(java.lang.String path)

Asserts that object specified by path is NOT null. If it is, an AssertionError is thrown with the given message.

Parameters:

path - the json path specifying the value that should be NOT null

Returns:

this to allow fluent assertion chains

assertNotNull

<T> JsonAsserter assertNotNull(java.lang.String path,
                               java.lang.String message)

and

JsonAsserter and()

Syntactic sugar to allow chaining assertions with a separating and() statement

with(json).assertThat("firstName", is(equalTo("Bobby"))).and().assertThat("lastName", is(equalTo("Ewing")))

Returns:

this to allow fluent assertion chains