Package org.springframework.graphql.client

Interface ClientResponseField

All Superinterfaces:

ResponseField

public interface ClientResponseField
extends ResponseField

Extends ResponseField to add options for decoding the field value.

Since:

1.0.0

Author:

Rossen Stoyanchev

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 toEntity(Class) to decode to a list of entities.

Methods inherited from interface org.springframework.graphql.ResponseField

getError, getErrors, getParsedPath, getPath, getValue, hasValue

Method Details

toEntity

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

Decode the field to an entity of the given type.

Parameters:

entityType - the type to convert to

Returns:

the decoded entity, or null if the field is null but otherwise there are no errors

Throws:

FieldAccessException - if the target field is null and the response is not valid or the field has errors.

toEntity

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

Variant of toEntity(Class) with a ParameterizedTypeReference.

toEntityList

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

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

Parameters:

elementType - the type of elements in the list

Returns:

the list of decoded entities, or an empty list if the field is null but otherwise there are no errors

Throws:

FieldAccessException - if the target field is null and the response is not valid or the field has errors.

toEntityList

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

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

Parameters:

elementType - the type of elements in the list

Returns:

the list of decoded entities, or an empty list if the field is null but otherwise there are no errors

Throws:

FieldAccessException - if the target field is null and the response is not valid or the field has errors.