Package graphql
-
Interface Summary Interface Description ErrorClassification Errors in graphql-java can have a classification to help with the processing of errors.ExecutionResult This simple value class represents the result of performing a graphql query.ExecutionResult.Builder<B extends ExecutionResult.Builder<B>> GraphQLError The interface describing graphql errors NOTE: This class implementsSerializableand hence it can be serialised and placed into a distributed cache.GraphQLError.Builder<B extends GraphQLError.Builder<B>> A builder ofGraphQLErrorsTrivialDataFetcher<T> Mark a DataFetcher as trivial: If a data fetcher is simply mapping data from an object to a field, it can be considered a trivial data fetcher for the purposes of tracing and so on. -
Class Summary Class Description Assert Directives The directives that are understood by graphql-javaDirectivesUtil DirectivesUtil.DirectivesHolder A holder class that breaks a list of directives into maps to be more easily accessible in using classesExceptionWhileDataFetching This graphql error will be used if a runtime exception is encountered while a data fetcher is invokedExecutionInput This represents the series of values that can be input on a graphql query executionExecutionInput.Builder ExecutionResultImpl ExecutionResultImpl.Builder GraphQL This class is where all graphql-java query execution begins.GraphQL.Builder GraphQLContext This context object can be used to contain key values that can be useful as "context" when executingDataFetchersGraphQLContext.Builder GraphqlErrorBuilder<B extends GraphqlErrorBuilder<B>> This helps you buildGraphQLErrors and also has a quick way to make aDataFetcherResults from that error.GraphqlErrorException.Builder GraphqlErrorException.BuilderBase<T extends GraphqlErrorException.BuilderBase<T,B>,B extends GraphqlErrorException> A trait like base class that contains the properties that GraphqlErrorException handles and can be used by other classes to derive their own builders.GraphqlErrorHelper This little helper allows GraphQlErrors to implement common things (hashcode/ equals ) and to specification more easilyInvalidSyntaxError ParseAndValidate This class allows you to parse and validate a graphql query without executing it.ParseAndValidateResult A result object used inParseAndValidatehelper that indicates the outcomes of a parse and validate operation.ParseAndValidateResult.Builder Scalars This contains the implementations of the Scalar types that ship with graphql-java.SerializationError TypeMismatchError TypeResolutionEnvironment This is passed to aTypeResolverto help with object type resolution.UnresolvedTypeError -
Enum Summary Enum Description ErrorType All the errors in graphql belong to one of these categories -
Exception Summary Exception Description AssertException GraphqlErrorException A base class for graphql runtime exceptions that also implementGraphQLErrorand can be used in a general sense direct or have specialisations made of it.GraphQLException -
Annotation Types Summary Annotation Type Description DeprecatedAt Helper to track deprecation Please use ISO-8601 format i.e.ExperimentalApi This represents code that the graphql-java project considers experimental API and while our intention is that it will progress to bePublicApi, its existence, signature of behavior may change between releases.Internal This represents code that the graphql-java project considers internal code that MAY not be stable within major releases.Mutable This marks a type as mutable which means after constructing it can be changed.PublicApi This represents code that the graphql-java project considers public API and has an imperative to be stable within major releases.PublicSpi This represents code that the graphql-java project considers public SPI and has an imperative to be stable within major releases.ThreadSafe This represents code that is known to be mutable but thread safe.VisibleForTesting Marks fields, methods etc as more visible than actually needed for testing purposes.