Package org.springframework.graphql.client

Interface GraphQlClient.RetrieveSyncSpec

Enclosing interface:

GraphQlClient

public static interface GraphQlClient.RetrieveSyncSpec

Declares options to decode a field in a single response.

Method Summary

Modifier and Type	Method	Description
<D> D	toEntity(Class<D> entityType)	Decode the field to an entity of the given type.
<D> D	toEntity(ParameterizedTypeReference<D> entityType)	Variant of toEntity(Class) with a ParameterizedTypeReference.
<D> List<D>	toEntityList(Class<D> elementType)	Variant of toEntity(Class) to decode to a List of entities.
<D> List<D>	toEntityList(ParameterizedTypeReference<D> elementType)	Variant of toEntityList(Class) with a ParameterizedTypeReference.

Method Details

toEntity

@Nullable
<D> D toEntity(Class<D> entityType)

Decode the field to an entity of the given type.

Type Parameters:

D - the type to convert to

Parameters:

entityType - the type to convert to

Returns:

the entity or null if the field is null and has no errors.

Throws:

FieldAccessException - in case of field errors or an invalid response;

See Also:

• ResponseField.getErrors()

toEntity

@Nullable
<D> D toEntity(ParameterizedTypeReference<D> entityType)

Variant of toEntity(Class) with a ParameterizedTypeReference.

Type Parameters:

D - the type to convert to

Parameters:

entityType - the type to convert to

toEntityList

<D> List<D> toEntityList(Class<D> elementType)

Variant of toEntity(Class) to decode to a List of entities.

Type Parameters:

D - the type to convert to

Parameters:

elementType - the type of elements in the list

toEntityList

<D> List<D> toEntityList(ParameterizedTypeReference<D> elementType)

Variant of toEntityList(Class) with a ParameterizedTypeReference.

Type Parameters:

D - the type to convert to

Parameters:

elementType - the type of elements in the list