com.toomuchcoding.jsonassert

Interface JsonVerifiable

All Superinterfaces:

IteratingOverArray, JsonReader

public interface JsonVerifiable
extends IteratingOverArray, JsonReader

Contract to match a parsed JSON via JSON Path

Since:

0.1.0

Author:

Marcin Grzejszczak

Method Summary

Modifier and Type	Method and Description
JsonVerifiable	array() When in JSON path you iterate over a nameless array
JsonVerifiable	array(Object value) When you want to assert values in a array with a given name
JsonVerifiable	arrayField() When you want to compare values of a field in a nameless array
JsonVerifiable	contains(Object value) Assertion of a field inside an array.
JsonVerifiable	elementWithIndex(int index) Provides the JsonVerifiable for the index element of the array
JsonVerifiable	field(Object value) Field assertion.
JsonVerifiable	field(String... fields) Field assertions.
JsonVerifiable	hasSize(int size) Checks if the array is of a given size.
JsonVerifiable	isEmpty() Checks if the array is empty
JsonVerifiable	isEqualTo(Boolean value) Equality comparison with a Boolean
JsonVerifiable	isEqualTo(Number value) Equality comparison with a Number
JsonVerifiable	isEqualTo(Object value) Equality comparison with any object
JsonVerifiable	isEqualTo(String value) 0Equality comparison with String
JsonVerifiable	isInstanceOf(Class clazz) Checks if instance is the same type
JsonVerifiable	isNull() Equality comparison to null
String	jsonPath() Returns current JSON Path expression
JsonVerifiable	matches(String value) Regex matching for strings
void	matchesJsonPath(String jsonPath) Checks if the parsed document matches given JSON Path
JsonVerifiable	value() Syntactic sugar for checking against an array of primitives
JsonVerifiable	withoutThrowingException() Calling this method will setup the fluent interface to ignore any JSON Path verification

Methods inherited from interface com.toomuchcoding.jsonassert.IteratingOverArray

isAssertingAValueInArray, isIteratingOverArray, isIteratingOverNamelessArray

Methods inherited from interface com.toomuchcoding.jsonassert.JsonReader

read

Method Detail

contains

JsonVerifiable contains(Object value)

Assertion of a field inside an array. Use it only for assertion and not traversing

field

JsonVerifiable field(Object value)

Field assertion. Adds a JSON Path entry for the given field.

field

JsonVerifiable field(String... fields)

Field assertions. Traverses through the list of fields and adds a JSON Path entry for each one.

array

JsonVerifiable array(Object value)

When you want to assert values in a array with a given name

arrayField

JsonVerifiable arrayField()

When you want to compare values of a field in a nameless array

array

JsonVerifiable array()

When in JSON path you iterate over a nameless array

elementWithIndex

JsonVerifiable elementWithIndex(int index)

Provides the JsonVerifiable for the index element of the array

isEqualTo

JsonVerifiable isEqualTo(String value)
                  throws IllegalStateException

0Equality comparison with String

Throws:

IllegalStateException - - if JSON Path is not matched for the parsed JSON

isEqualTo

JsonVerifiable isEqualTo(Object value)
                  throws IllegalStateException

Equality comparison with any object

Throws:

IllegalStateException - - if JSON Path is not matched for the parsed JSON

isEqualTo

JsonVerifiable isEqualTo(Number value)
                  throws IllegalStateException

Equality comparison with a Number

Throws:

IllegalStateException - - if JSON Path is not matched for the parsed JSON

isNull

JsonVerifiable isNull()
               throws IllegalStateException

Equality comparison to null

Throws:

IllegalStateException - - if JSON Path is not matched for the parsed JSON

matches

JsonVerifiable matches(String value)
                throws IllegalStateException

Regex matching for strings

Throws:

IllegalStateException - - if JSON Path is not matched for the parsed JSON

isEqualTo

JsonVerifiable isEqualTo(Boolean value)
                  throws IllegalStateException

Equality comparison with a Boolean

Throws:

IllegalStateException - - if JSON Path is not matched for the parsed JSON

isEmpty

JsonVerifiable isEmpty()
                throws IllegalStateException

Checks if the array is empty

Throws:

IllegalStateException - - if the result of the JSON Path contains any values

isInstanceOf

JsonVerifiable isInstanceOf(Class clazz)
                     throws IllegalStateException

Checks if instance is the same type

Throws:

IllegalStateException - - if the object from JSON is not of proper type

value

JsonVerifiable value()

Syntactic sugar for checking against an array of primitives

withoutThrowingException

JsonVerifiable withoutThrowingException()

Calling this method will setup the fluent interface to ignore any JSON Path verification

jsonPath

String jsonPath()

Returns current JSON Path expression

matchesJsonPath

void matchesJsonPath(String jsonPath)

Checks if the parsed document matches given JSON Path

hasSize

JsonVerifiable hasSize(int size)

Checks if the array is of a given size. Example of usage:

 String json =  '''{ "some_list" : ["name1", "name2"] }'''
 assertThat(json).array("some_list").hasSize(2)