Package graphql.execution.instrumentation

Interface FieldFetchingInstrumentationContext

All Superinterfaces:

InstrumentationContext<Object>

@PublicSpi
public interface FieldFetchingInstrumentationContext
extends InstrumentationContext<Object>

FieldFetchingInstrumentationContext is returned back from the Instrumentation.beginFieldFetching(InstrumentationFieldFetchParameters, InstrumentationState) method, and it's much like the normal InstrumentationContext type except it also gives the value that was returned by a fields DataFetcher. This allows you to know if the field value is a completely materialised field or if it's a CompletableFuture promise to a value.

Field Summary

Fields

Modifier and Type	Field	Description
static final FieldFetchingInstrumentationContext	NOOP

Method Summary

Modifier and Type	Method	Description
static FieldFetchingInstrumentationContext	adapter(@Nullable InstrumentationContext<Object> context)
static @NonNull FieldFetchingInstrumentationContext	nonNullCtx(FieldFetchingInstrumentationContext nullableContext)	This creates a no-op InstrumentationContext if the one passed in is null
default void	onExceptionHandled(DataFetcherResult<Object> dataFetcherResult)	This is called back after any DataFetcherExceptionHandler) has run on any exception raised during a DataFetcher invocation.
default void	onFetchedValue(Object fetchedValue)	This is called back with the value fetched for the field by its DataFetcher.

Methods inherited from interface graphql.execution.instrumentation.InstrumentationContext

onCompleted, onDispatched

Field Details

NOOP

static final FieldFetchingInstrumentationContext NOOP

Method Details

onFetchedValue

default void onFetchedValue(Object fetchedValue)

This is called back with the value fetched for the field by its DataFetcher. This can be a materialised java object or it maybe a CompletableFuture promise to some async value that has not yet completed.

Parameters:

fetchedValue - a value that a field's DataFetcher returned

onExceptionHandled

default void onExceptionHandled(DataFetcherResult<Object> dataFetcherResult)

This is called back after any DataFetcherExceptionHandler) has run on any exception raised during a DataFetcher invocation. This allows to see the final DataFetcherResult that will be used when performing the complete step.

Parameters:

dataFetcherResult - the final DataFetcherResult after the exception handler has run

nonNullCtx

static @NonNull FieldFetchingInstrumentationContext nonNullCtx(FieldFetchingInstrumentationContext nullableContext)

This creates a no-op InstrumentationContext if the one passed in is null

Parameters:

nullableContext - a InstrumentationContext that can be null

Returns:

a non-null InstrumentationContext that maybe a no-op

adapter

static FieldFetchingInstrumentationContext adapter(@Nullable InstrumentationContext<Object> context)