Interface SelfDescribingDataFetcher<T>

Type Parameters:

T - the type of data returned by the DataFetcher

All Superinterfaces:

graphql.schema.DataFetcher<T>

public interface SelfDescribingDataFetcher<T>
extends graphql.schema.DataFetcher<T>

Specialized DataFetcher that exposes additional details such as return type information.

Since:

1.2.0

Author:

Brian Clozel, Rossen Stoyanchev

Method Summary

Modifier and Type	Method	Description
default @Nullable Method	asMethod()	Return the current DataFetcher as a Java method, if possible.
default Map<String, ResolvableType>	getArguments()	Return a map with arguments that this DataFetcher looks up along with the Java types they are mapped to.
String	getDescription()	Provide a description of the DataFetcher for display or logging purposes.
ResolvableType	getReturnType()	The return type of this DataFetcher.
default boolean	usesDataLoader()	Whether this DataFetcher uses a DataLoader to return data.

Methods inherited from interface graphql.schema.DataFetcher

get

Method Details

getDescription

String getDescription()

Provide a description of the DataFetcher for display or logging purposes. Depending on the underlying implementation, this could be a controller method, a Spring Data repository backed DataFetcher, or other.

getReturnType

ResolvableType getReturnType()

The return type of this DataFetcher.

This could be derived from the method signature of an annotated @Controller method, the domain type of a DataFetcher backed by a Spring Data repository, or other.

getArguments

default Map<String, ResolvableType> getArguments()

Return a map with arguments that this DataFetcher looks up along with the Java types they are mapped to.

Since:

1.3.0

asMethod

default @Nullable Method asMethod()

Return the current DataFetcher as a Java method, if possible.

This can be supported for annotated @Controller, or Spring Data Repository interfaces.

Since:

2.0.0

usesDataLoader

default boolean usesDataLoader()

Whether this DataFetcher uses a DataLoader to return data. This represents a deferred operation that is typically repeatable, and a candidate for aggregation from a metrics and tracing perspective.

Since:

1.4.0