Package graphql.execution
-
Interface Summary Interface Description Async.CombinedBuilder<T> A builder of materialized objects orCompletableFuture
s than can present a promise to the list of themDataFetcherExceptionHandler This is called when an exception is thrown duringDataFetcher.get(DataFetchingEnvironment)
executionDataLoaderDispatchStrategy EngineRunningObserver This class lets you observe the running state of the graphql-java engine.ExecutionIdProvider A provider ofExecutionId
sValueUnboxer A value unboxer takes values that are wrapped in classes likeOptional
/OptionalInt
etc.. -
Class Summary Class Description AbstractAsyncExecutionStrategy Async AsyncExecutionStrategy The standard graphql execution strategy that runs fields asynchronously non-blocking.AsyncSerialExecutionStrategy Async non-blocking execution, but serial: only one field at the time will be resolved.CoercedVariables Holds coerced variables, that is their values are now in a canonical form.DataFetcherExceptionHandlerParameters The parameters available toDataFetcherExceptionHandler
sDataFetcherExceptionHandlerParameters.Builder DataFetcherExceptionHandlerResult The result object forDataFetcherExceptionHandler
sDataFetcherExceptionHandlerResult.Builder DataFetcherResult<T> An object that can be returned from aDataFetcher
that contains both data, local context and errors to be added to the final result.DataFetcherResult.Builder<T> DefaultValueUnboxer Public API because it should be used as a delegate when implementing a customValueUnboxer
Execution ExecutionContext ExecutionContextBuilder ExecutionId This opaque identifier is used to identify a unique query executionExecutionStepInfo As the graphql query executes, it forms a hierarchy from parent fields (and their type) to their child fields (and their type) until a scalar type is encountered; this class captures that execution type information.ExecutionStepInfo.Builder ExecutionStepInfoFactory ExecutionStrategy An execution strategy is give a list of fields from the graphql query to execute and find values for using a recursive strategy.ExecutionStrategyParameters The parameters that are passed to execution strategiesExecutionStrategyParameters.Builder FetchedValue Note: This is returned byInstrumentationFieldCompleteParameters.getFetchedValue()
and therefore part of the public despite never used in a method signature.FieldCollector A field collector can iterate over field selection sets and build out the sub fields that have been selected, expanding named and inline fragments as it goes.FieldCollectorParameters Internal because FieldCollector is internal.FieldCollectorParameters.Builder FieldValueInfo TheFieldValueInfo
holds the type of field that was fetched and completed along with the completed value.MergedField This represents all Fields in a query which overlap and are merged into one.MergedField.Builder MergedSelectionSet MergedSelectionSet.Builder NonNullableFieldValidator This will check that a value is non-null when the type definition says it must be and, it will throwNonNullableFieldWasNullException
if this is not the case.NonNullableFieldWasNullError This is the base error that indicates that a non null field value was in fact null.NormalizedVariables Holds coerced variables, that is their values are now in a normalizedNormalizedInputValue
form.RawVariables Holds raw variables, which have not been coerced yet intoCoercedVariables
ResolveType ResultNodesInfo This class is used to track the number of result nodes that have been created during execution.ResultPath As a graphql query is executed, each field forms a hierarchical path from parent field to child field and this class represents that path as a series of segments.SimpleDataFetcherExceptionHandler The standard handling of data fetcher error involves placing aExceptionWhileDataFetching
error into the error collectionSubscriptionExecutionStrategy An execution strategy that implements graphql subscriptions by using reactive-streams as the output result of the subscription query.TypeFromAST TypeResolutionParameters This class is a classic builder style one that SHOULD have been on have been onTypeResolutionEnvironment
but for legacy reasons was not.TypeResolutionParameters.Builder ValuesResolver -
Enum Summary Enum Description EngineRunningObserver.RunningState FieldValueInfo.CompleteValueType ValuesResolver.ValueMode -
Exception Summary Exception Description AbortExecutionException This Exception indicates that the current execution should be aborted.InputMapDefinesTooManyFieldsException https://facebook.github.io/graphql/#sec-Input-Objects - This unordered map should not contain any entries with names not defined by a field of this input object type, otherwise an error should be thrown.MissingRootTypeException This is thrown if a query is attempting to perform an operation not defined in the GraphQL schemaNonNullableFieldWasNullException See (https://spec.graphql.org/October2021/#sec-Errors-and-Non-Nullability), but if a non nullable field actually resolves to a null value and the parent type is nullable then the parent must in fact become null so we use exceptions to indicate this special caseNonNullableValueCoercedAsNullException This is thrown if a non nullable value is coerced to a null valueOneOfNullValueException The input map to One Of Input Types MUST only have 1 entry with a non null valueOneOfTooManyKeysException The input map to One Of Input Types MUST only have 1 entryUnknownOperationException This is thrown if multiple operations are defined in the query and the operation name is missing or there is no matching operation name contained in the GraphQL query.UnresolvedTypeException This is thrown if aTypeResolver
fails to give back a concrete type or provides a type that doesn't implement the given interface or union.