com.graphql.spring.boot.test.assertions

Class GraphQLFieldAssert

java.lang.Object

com.graphql.spring.boot.test.assertions.GraphQLFieldAssert

All Implemented Interfaces:

GraphQLResponseAssertion

public class GraphQLFieldAssert
extends java.lang.Object
implements GraphQLResponseAssertion

Provides fluent assertions for a field (specified by a json path) of the GraphQL response.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	EXPECTED_FIELD_S_TO_BE_PRESENT
static java.lang.String	EXPECTED_THAT_CONTENT_OF_FIELD_S_CAN_BE_CONVERTED_TO_S

Constructor Summary

Constructors

Constructor and Description
GraphQLFieldAssert()

Method Summary

Modifier and Type	Method and Description
GraphQLResponse	and()
<T> GraphQLGenericObjectAssert<T>	as(java.lang.Class<T> clazz) Returns an assertion for the content of the field as an instance of the specified class.
<T> GraphQLGenericObjectAssert<T>	as(com.fasterxml.jackson.databind.JavaType javaType) Returns an assertion for the content of the field as an instance of the specified type.
GraphQLBigDecimalAssert	asBigDecimal() Returns an assertion for the content of the field as BigDecimal.
GraphQLBigIntegerAssert	asBigInteger() Returns an assertion for the content of the field as BigInteger.
GraphQLBooleanAssert	asBoolean() Returns an assertion for the content of the field as Boolean.
GraphQLByteAssert	asByte() Returns an assertion for the content of the field as Byte.
GraphQLIntegerAssert	asInteger() Returns an assertion for the content of the field as Integer.
<T> GraphQLListAssert<T>	asList(com.fasterxml.jackson.databind.JavaType javaListType) Returns an assertion for the content of the field as an instance of the specified list type.
<T> GraphQLListAssert<T>	asListOf(java.lang.Class<T> elementClass) Returns an assertion for the content of the field as list of objects.
GraphQLLongAssert	asLong() Returns an assertion for the content of the field as Long.
GraphQLShortAssert	asShort() Returns an assertion for the content of the field as Short.
GraphQLStringAssert	asString() Returns an assertion for the content of the field as String.
GraphQLFieldAssert	isNotNull() Asserts that the field specified by the provided JSON path is not null.
GraphQLFieldAssert	isNotPresent() Asserts that the field specified by the provided JSON path is not present in the response.
GraphQLFieldAssert	isNotPresentOrNull() Asserts that the field specified by the provided JSON path is not present in the response or its value is null.
GraphQLFieldAssert	isNull() Asserts that the field specified by the provided JSON path is null.

Methods inherited from class java.lang.Object

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

Field Detail

EXPECTED_FIELD_S_TO_BE_PRESENT

public static final java.lang.String EXPECTED_FIELD_S_TO_BE_PRESENT

See Also:

Constant Field Values

EXPECTED_THAT_CONTENT_OF_FIELD_S_CAN_BE_CONVERTED_TO_S

public static final java.lang.String EXPECTED_THAT_CONTENT_OF_FIELD_S_CAN_BE_CONVERTED_TO_S

See Also:

Constant Field Values

Constructor Detail

GraphQLFieldAssert

public GraphQLFieldAssert()

Method Detail

isNotPresent

public GraphQLFieldAssert isNotPresent()

Asserts that the field specified by the provided JSON path is not present in the response.

Returns:

self

Throws:

java.lang.AssertionError - if the field is present in the response

isNotPresentOrNull

public GraphQLFieldAssert isNotPresentOrNull()

Asserts that the field specified by the provided JSON path is not present in the response or its value is null.

Returns:

self

Throws:

java.lang.AssertionError - if the field is present in the response and its value is not null.

isNull

public GraphQLFieldAssert isNull()

Asserts that the field specified by the provided JSON path is null.

Returns:

self

Throws:

java.lang.AssertionError - if the field is not present in the response or its value is not null.

isNotNull

public GraphQLFieldAssert isNotNull()

Asserts that the field specified by the provided JSON path is not null.

Returns:

self

Throws:

java.lang.AssertionError - if the field is not present in the response or its value is null.

asBigDecimal

public GraphQLBigDecimalAssert asBigDecimal()

Returns an assertion for the content of the field as BigDecimal.

Returns:

a GraphQLBigDecimalAssert instance

Throws:

java.lang.AssertionError - if the path does not exist or the content could not be converted to BigDecimal

asBigInteger

public GraphQLBigIntegerAssert asBigInteger()

Returns an assertion for the content of the field as BigInteger.

Returns:

a GraphQLBigIntegerAssert instance

Throws:

java.lang.AssertionError - if the path does not exist or the content could not be converted to BigInteger

asLong

public GraphQLLongAssert asLong()

Returns an assertion for the content of the field as Long.

Returns:

a GraphQLLongAssert instance

Throws:

java.lang.AssertionError - if the path does not exist or the content could not be converted to Long

asInteger

public GraphQLIntegerAssert asInteger()

Returns an assertion for the content of the field as Integer.

Returns:

a GraphQLIntegerAssert instance

Throws:

java.lang.AssertionError - if the path does not exist or the content could not be converted to Integer

asShort

public GraphQLShortAssert asShort()

Returns an assertion for the content of the field as Short.

Returns:

a GraphQLShortAssert instance

Throws:

java.lang.AssertionError - if the path does not exist or the content could not be converted to Short

asByte

public GraphQLByteAssert asByte()

Returns an assertion for the content of the field as Byte.

Returns:

a GraphQLByteAssert instance

Throws:

java.lang.AssertionError - if the path does not exist or the content could not be converted to Byte

asBoolean

public GraphQLBooleanAssert asBoolean()

Returns an assertion for the content of the field as Boolean.

Returns:

a GraphQLBooleanAssert instance

Throws:

java.lang.AssertionError - if the path does not exist or the content could not be converted to Boolean

asString

public GraphQLStringAssert asString()

Returns an assertion for the content of the field as String.

Returns:

a GraphQLStringAssert instance

Throws:

java.lang.AssertionError - if the path does not exist or the content could not be converted to String

as

public <T> GraphQLGenericObjectAssert<T> as(java.lang.Class<T> clazz)

Returns an assertion for the content of the field as an instance of the specified class.

Parameters:

clazz - The class of the object. to assert

Returns:

a GraphQLGenericObjectAssert instance

Throws:

java.lang.AssertionError - if the path does not exist or the content could not be converted to the specified class

as

public <T> GraphQLGenericObjectAssert<T> as(com.fasterxml.jackson.databind.JavaType javaType)

Returns an assertion for the content of the field as an instance of the specified type.

Parameters:

javaType - The java type definition.

Returns:

a GraphQLGenericObjectAssert instance

Throws:

java.lang.AssertionError - if the path does not exist or the content could not be converted to the specified class

asList

public <T> GraphQLListAssert<T> asList(com.fasterxml.jackson.databind.JavaType javaListType)

Returns an assertion for the content of the field as an instance of the specified list type.

Parameters:

javaListType - The java type definition. Expected to define a list type.

Returns:

a GraphQLListAssert instance

Throws:

java.lang.AssertionError - if the path does not exist or the content could not be converted to the specified class or if the provided type is not a list type.

asListOf

public <T> GraphQLListAssert<T> asListOf(java.lang.Class<T> elementClass)

Returns an assertion for the content of the field as list of objects.

Parameters:

elementClass - the type of objects in the list

Returns:

a GraphQLGenericObjectAssert instance

Throws:

java.lang.AssertionError - if the path does not exist or the content could not be converted to the specified class

and

public GraphQLResponse and()

Specified by:

and in interface GraphQLResponseAssertion

Returns:

the instance of GraphQLResponse for which this assertion was created. Allows chaining fluent assertions.