Uses of Annotation Type
graphql.PublicApi
Packages that use PublicApi
Package
Description
-
Uses of PublicApi in graphql
Modifier and TypeClassDescriptionclass
class
The directives that are understood by graphql-javainterface
Errors in graphql-java can have a classification to help with the processing of errors.enum
All the errors in graphql belong to one of these categoriesclass
This graphql error will be used if a runtime exception is encountered while a data fetcher is invokedclass
This represents the series of values that can be input on a graphql query executioninterface
This simple value class represents the result of performing a graphql query.class
This class is where all graphql-java query execution begins.static class
class
This context object can be used to contain key values that can be useful as "context" when executingDataFetcher
sinterface
The interface describing graphql errors NOTE: This class implementsSerializable
and hence it can be serialised and placed into a distributed cache.class
GraphqlErrorBuilder<B extends GraphqlErrorBuilder<B>>
This helps you buildGraphQLError
s and also has a quick way to make aDataFetcherResult
s from that error.class
A base class for graphql runtime exceptions that also implementGraphQLError
and can be used in a general sense direct or have specialisations made of it.class
This class allows you to parse and validate a graphql query without executing it.class
A result object used inParseAndValidate
helper that indicates the outcomes of a parse and validate operation.class
This contains the implementations of the Scalar types that ship with graphql-java.class
class
class
This is passed to aTypeResolver
to help with object type resolution.class
-
Uses of PublicApi in graphql.analysis
Classes in graphql.analysis with annotations of type PublicApiModifier and TypeInterfaceDescriptioninterface
Used to calculate the complexity of a field.class
class
Prevents execution if the query complexity is greater than the specified maxComplexity.class
Prevents execution if the query depth is greater than the specified maxDepth.class
This can calculate the complexity of an operation using the specifiedFieldComplexityCalculator
you pass into it.class
The query complexity info.static class
class
The query depth info.static class
interface
QueryReducer<T>
Used byQueryTraverser
to reduce the fields of a Document (or part of it) to a single value.class
Helps to transform a Document (or parts of it) and tracks at the same time the corresponding Schema types.static class
class
Helps to traverse (or reduce) a Document (or parts of it) and tracks at the same time the corresponding Schema types.static class
interface
Used byQueryTraverser
to visit the nodes of a Query.interface
interface
This describes the tree structure that forms from a argument input type, especially with `input ComplexType { ....}` types that might in turn contain other complex types and hence form a tree of values.interface
interface
interface
interface
interface
class
-
Uses of PublicApi in graphql.analysis.values
Classes in graphql.analysis.values with annotations of type PublicApiModifier and TypeClassDescriptionclass
This class allows you to traverse a set of input values according to the type system and optional change the values present. -
Uses of PublicApi in graphql.execution
Classes in graphql.execution with annotations of type PublicApiModifier and TypeClassDescriptionclass
This Exception indicates that the current execution should be aborted.class
The standard graphql execution strategy that runs fields asynchronously non-blocking.class
Async non-blocking execution, but serial: only one field at the time will be resolved.class
Holds coerced variables, that is their values are now in a canonical form.class
The parameters available toDataFetcherExceptionHandler
sclass
The result object forDataFetcherExceptionHandler
sclass
An object that can be returned from aDataFetcher
that contains both data, local context and errors to be added to the final result.class
Public API because it should be used as a delegate when implementing a customValueUnboxer
class
class
class
This opaque identifier is used to identify a unique query executionclass
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.class
The parameters that are passed to execution strategiesclass
Note: This is returned byInstrumentationFieldCompleteParameters.getFetchedValue()
and therefore part of the public despite never used in a method signature.class
class
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.class
This represents all Fields in a query which overlap and are merged into one.class
class
This is thrown if a query is attempting to perform an operation not defined in the GraphQL schemaclass
This is thrown if a non nullable value is coerced to a null valueclass
The input map to One Of Input Types MUST only have 1 entry with a non null valueclass
The input map to One Of Input Types MUST only have 1 entryclass
Holds raw variables, which have not been coerced yet intoCoercedVariables
class
This class is used to track the number of result nodes that have been created during execution.class
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.class
The standard handling of data fetcher error involves placing aExceptionWhileDataFetching
error into the error collectionclass
An execution strategy that implements graphql subscriptions by using reactive-streams as the output result of the subscription query.class
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.class
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. -
Uses of PublicApi in graphql.execution.directives
Classes in graphql.execution.directives with annotations of type PublicApiModifier and TypeClassDescriptionclass
An applied directive represents the instance of a directive that is applied to a query element such as a field or fragment.class
This represents the argument values that can be placed on anQueryAppliedDirective
.interface
This gives you access to the immediate directives on aMergedField
. -
Uses of PublicApi in graphql.execution.instrumentation
Classes in graphql.execution.instrumentation with annotations of type PublicApiModifier and TypeClassDescriptionclass
This allows you to chain together a number ofInstrumentation
implementations and run them in sequence.class
class
This version ofChainedInstrumentation
will call a list ofInstrumentation
s but it will never back on the returnedInstrumentationContext
objects, hence it is only suitable to certain use cases.class
Deprecated.class
A simple implementation ofInstrumentationContext
class
An implementation ofInstrumentation
that does nothing. -
Uses of PublicApi in graphql.execution.instrumentation.dataloader
Classes in graphql.execution.instrumentation.dataloader with annotations of type PublicApiModifier and TypeClassDescriptionclass
This graphqlInstrumentation
will dispatch all the containedDataLoader
s when each level of the graphql query is executed.class
The options that control the operation ofDataLoaderDispatcherInstrumentation
class
A base class that keeps track of whether aggressive batching can be used -
Uses of PublicApi in graphql.execution.instrumentation.fieldvalidation
Classes in graphql.execution.instrumentation.fieldvalidation with annotations of type PublicApiModifier and TypeInterfaceDescriptioninterface
This represents a field and its arguments that may be validated.interface
This contains all of the field and their arguments for a given query.class
ThisInstrumentation
allows you to validate the fields of the query before the query is executed.class
This very simple field validation will run the supplied function for a given field path and if it returns an error it will be added to the list of problems. -
Uses of PublicApi in graphql.execution.instrumentation.parameters
Classes in graphql.execution.instrumentation.parameters with annotations of type PublicApiModifier and TypeClassDescriptionclass
Parameters sent toInstrumentation
methodsclass
Parameters sent toInstrumentation
methodsclass
Parameters sent toInstrumentation
methodsclass
Parameters sent toInstrumentation
methodsclass
Parameters sent toInstrumentation
methodsclass
Parameters sent toInstrumentation
methodsclass
Parameters sent toInstrumentation
methodsclass
Parameters sent toInstrumentation
methods -
Uses of PublicApi in graphql.execution.instrumentation.tracing
Classes in graphql.execution.instrumentation.tracing with annotations of type PublicApiModifier and TypeClassDescriptionclass
ThisInstrumentation
implementation usesTracingSupport
to capture tracing information and puts it into theExecutionResult
class
This creates a map of tracing information as outlined in https://github.com/apollographql/apollo-tracing -
Uses of PublicApi in graphql.execution.preparsed
Classes in graphql.execution.preparsed with annotations of type PublicApiModifier and TypeClassDescriptionclass
An instance of a preparsed document entry represents the result of a query parse and validation. -
Uses of PublicApi in graphql.execution.preparsed.persisted
Classes in graphql.execution.preparsed.persisted with annotations of type PublicApiModifier and TypeClassDescriptionclass
This persisted query support class supports the Apollo scheme where the persisted query id is inExecutionInput.getExtensions()
.class
A PersistedQueryCache that is just an in memory map of known queries.interface
The call back when a valid persisted query is not in cache and it needs to be compiled and validated by the graphql engine.class
class
An exception that indicates the query id is not valid and can be found ever in cache -
Uses of PublicApi in graphql.execution.reactive
Classes in graphql.execution.reactive with annotations of type PublicApiModifier and TypeClassDescriptionclass
A simple subscription that delegates to anotherclass
Subscription queries return an instance of this class in theExecutionResult
data element for the subscribed field. -
Uses of PublicApi in graphql.extensions
Classes in graphql.extensions with annotations of type PublicApiModifier and TypeClassDescriptionclass
This class can be used to help build the graphql `extensions` map. -
Uses of PublicApi in graphql.introspection
Classes in graphql.introspection with annotations of type PublicApiModifier and TypeClassDescriptionclass
ThisInstrumentation
ensure that a submitted introspection query is done in good faith.class
GraphQl has a unique capability called Introspection that allow consumers to inspect the system and discover the fields and types available and makes the system self documented.interface
class
IntrospectionQueryBuilder
allows you to build introspection queries controlled by the options you specifyclass
class
The graphql specification does not allow you to retrieve the directives and their argument values that are present on types, enums, fields and input fields, so this class allows you to change the schema and enhance the Introspection types to contain this information.static interface
The parameter environment on a call toIntrospectionWithDirectivesSupport.DirectivePredicate
-
Uses of PublicApi in graphql.language
Classes in graphql.language with annotations of type PublicApiModifier and TypeClassDescriptionclass
AbstractDescribedNode<T extends Node>
class
AbstractNode<T extends Node>
class
class
class
Adapts an Ast node to the general node from the util packageclass
This can take graphql language AST and print it out as a stringclass
This will produce signature and privacy safe query documents that can be used for query categorisation and logging.class
A class that helps you sort AST nodesclass
Allows for an easy way to "manipulate" the immutable Ast by changing specific nodes and getting back a new Ast containing the changed nodes while everything else is the same.class
class
A single-line comment.interface
Definition<T extends Definition>
interface
DescribedNode<T extends Node>
Represents a node that can contain a description.class
class
class
class
interface
DirectivesContainer<T extends DirectivesContainer>
Represents a language node that can contain Directives.class
class
class
class
class
class
class
class
class
Provided to the DataFetcher, therefore public APIclass
class
Graphql syntax has a series of characters, such as spaces, new lines and commas that are not considered relevant to the syntax.class
Graphql syntax has a series of characters, such as spaces, new lines and commas that are not considered relevant to the syntax.interface
ImplementingTypeDefinition<T extends TypeDefinition>
ATypeDefinition
that might implement interfacesclass
class
class
class
class
class
class
class
interface
Represents a language node that has a nameinterface
The base interface for virtually all graphql language elements NOTE: This class implementsSerializable
and hence it can be serialised and placed into a distributed cache.interface
class
Container of children of aNode
.interface
class
NodeParentTree<T extends Node>
This represents a hierarchy from a graphql language node upwards to its associated parent nodes.class
Lets you traverse aNode
tree.interface
Used byNodeTraverser
to visitNode
.class
Convenient implementation ofNodeVisitor
for easy subclassing methods handling different types of Nodes in one method.class
class
class
class
class
class
class
class
class
class
interface
ScalarValue<T extends Value>
class
class
interface
SDLDefinition<T extends SDLDefinition>
An interface for Schema Definition Language (SDL) definitions.interface
A marker interface for Schema Definition Language (SDL) extension definitions.interface
SDLNamedDefinition<T extends SDLNamedDefinition>
A interface for named Schema Definition Language (SDL) definition.interface
class
interface
SelectionSetContainer<T extends Node>
class
class
interface
interface
TypeDefinition<T extends TypeDefinition>
An interface for type definitions in a Schema Definition Language (SDL).enum
And enumeration of the the kind of things that can be in a graphql type systemclass
class
class
interface
class
class
-
Uses of PublicApi in graphql.normalized
Classes in graphql.normalized with annotations of type PublicApiModifier and TypeClassDescriptionclass
AnExecutableNormalizedField
represents a field in an executable graphql operation.class
AExecutableNormalizedOperation
represent how the text of a graphql operation (sometimes known colloquially as a query) will be executed at runtime according to the graphql specification.class
This factory can create aExecutableNormalizedOperation
which represents what would be executed during a given graphql operation.class
This class can take a list ofExecutableNormalizedField
s and compiling out a normalised operationDocument
that would represent how those fields maybe executed.class
An argument value with type information. -
Uses of PublicApi in graphql.parser
Classes in graphql.parser with annotations of type PublicApiModifier and TypeClassDescriptionclass
This exception is thrown by theParser
if the graphql syntax is not validclass
This reader allows you to read N number readers and combine them as one logical reader however you can then map back to the underlying readers in terms of their source name and the relative lines numbers.class
This can parse graphql syntax, both Query syntax and Schema Definition Language (SDL) syntax, into an Abstract Syntax Tree (AST) represented by aDocument
interface
This is the arguments that can be passed to aParser
class
Options that control how theParser
behaves. -
Uses of PublicApi in graphql.relay
Classes in graphql.relay with annotations of type PublicApiModifier and TypeInterfaceDescriptioninterface
Connection<T>
interface
Represents aconnection
cursor in Relay which is an opaque string that the server understands.class
A default implementation ofConnection
class
class
DefaultEdge<T>
class
interface
Edge<T>
Represents an edge in Relay which is essentially a node of data T and the cursor for that node.interface
Represents pagination information in Relay aboutedges
when used inside aconnection
See https://facebook.github.io/relay/graphql/connections.htm#sec-undefined.PageInfoclass
This can be used to compose graphql runtime types that implement that Relay specification.class
-
Uses of PublicApi in graphql.schema
Classes in graphql.schema with annotations of type PublicApiModifier and TypeClassDescriptionclass
A modifier type that indicates the underlying data fetcher is run asynchronouslyclass
class
class
class
A helper forDataFetcherFactory
class
This is passed to aDataFetcherFactory
when it is invoked to get aDataFetcher
interface
A DataFetchingEnvironment instance of passed to aDataFetcher
as a execution context and its the place where you can find out information to help you resolve a data value given a graphql field inputinterface
This class allows you to retrieve the selection set of fields that have been asked for when theDataFetcher
was invoked.class
Associates aComparator
with aGraphqlTypeComparatorEnvironment
to control the scope in which theComparator
can be applied.class
DelegatingDataFetchingEnvironment implementsDataFetchingEnvironment
by delegating to an underlying instance.class
A field in graphql is uniquely located within a parent type and hence code elements likeDataFetcher
need to be specified using those coordinates.class
An applied directive represents the instance of a directive that is applied to a schema element, as opposed to it definitionclass
This represents the argument values that can be placed on anGraphQLAppliedDirective
.class
This defines an argument that can be supplied to a graphql field (viaGraphQLFieldDefinition
.class
TheGraphQLCodeRegistry
holds that execution code that is associated with graphql types, namely theDataFetcher
s associated with fields, theTypeResolver
s associated with abstract types and theGraphqlFieldVisibility
interface
class
A directive can be used to modify the behavior of a graphql field or type.interface
Represents a graphql runtime type that can haveGraphQLAppliedDirective
s.class
This represents a hierarchy an graphql runtime element upwards to its associated parent elements.class
A graphql enumeration type has a limited set of values.class
A graphql enumeration type has a limited set of values and this defines one of those unique valuesstatic class
class
Fields are the ways you get data values in graphql and a field definition represents a field, its type, the arguments it takes and theDataFetcher
used to get data values for that field.static class
interface
Types that can contain output fields are marked with this interfaceinterface
A GraphQLType which can implement interfacesinterface
Types that can contain input fields are marked with this interfaceclass
Input objects defined viaGraphQLInputObjectType
contains these input fields.static class
class
graphql clearly delineates between the types of objects that represent the output of a query and input objects that can be fed into a graphql mutation.static class
interface
A schema element that is concerned with input.interface
Input types represent those set of types that are allowed to be accepted as graphql mutation input, as opposed toGraphQLOutputType
s which can only be used as graphql response output.interface
Named schema elements that contain input type information.class
In graphql, an interface is an abstract type that defines the set of fields that a type must include to implement that interface.static class
class
A modified type that indicates there is a list of the underlying wrapped type, eg a list of strings or a list of booleans.interface
A modified type wraps another graphql type and modifies it behaviorinterface
Input types represent those set of types that are allowed to be accepted as graphql mutation input, as opposed toGraphQLOutputType
s which can only be used as graphql response output.interface
Output types represent those set of types that are allowed to be sent back as a graphql response, as opposed toGraphQLInputType
s which can only be used as graphql mutation input.interface
A Schema element which has a name and also a description and AST Node which it is based on.interface
A GraphQLType which is also a named element, which means it has a getName() method.class
A modified type that indicates there the underlying wrapped type will not be null.interface
class
This is the work horse type and represents an object with one or more field values that can be retrieved by the graphql system.static class
interface
Output types represent those set of types that are allowed to be sent back as a graphql response, as opposed toGraphQLInputType
s which can only be used as graphql mutation input.class
A scalar type is a leaf node in the graphql tree of types.static class
class
The schema represents the combined type system of the graphql engine.interface
A GraphQLSchema can be viewed as a graph of GraphQLSchemaElement.interface
A type inside the GraphQLSchema.class
Defines the scope to control where the registeredComparator
can be applied.interface
class
A special type to allow a object/interface types to reference itself.class
A utility class that helps work withGraphQLType
sinterface
GraphQLTypeVisitor can be used to visit all the elements of a schema (types, fields, directives and so on) in a visitor pattern.class
Base implementation ofGraphQLTypeVisitor
for convenience.class
A union type is a polymorphic type that dynamically represents one of more concrete object types.static class
interface
class
Used by @GraphQLArgument
andGraphQLInputObjectField
to represent different value states.class
This is the default data fetcher used in graphql-java, and it will examine maps, records and POJO java beans for values that match the desired name, typically the field name, or it will use a provided function to obtain values.class
class
Transforms aGraphQLSchema
object by calling bac on a provided visitor.class
interface
ASelectedField
represents a field that occurred in a query selection set during execution and they are returned from using theDataFetchingFieldSelectionSet
interface returned viaDataFetchingEnvironment.getSelectionSet()
class
ADataFetcher
that always returns the same value -
Uses of PublicApi in graphql.schema.diff
Classes in graphql.schema.diff with annotations of type PublicApiModifier and TypeClassDescriptionenum
A classification of difference events.class
This represents the events that theSchemaDiff
outputs.enum
This is the level of difference between graphql APIsclass
Deprecated.class
Interface used to define 2 schemas that can be diffed by theSchemaDiff
operation. -
Uses of PublicApi in graphql.schema.diff.reporting
Classes in graphql.schema.diff.reporting with annotations of type PublicApiModifier and TypeClassDescriptionclass
A reporter that captures all the difference events as they occurclass
A reporter that chains together one or more difference reportersclass
A reporter that prints its output to a PrintStream -
Uses of PublicApi in graphql.schema.idl
Classes in graphql.schema.idl with annotations of type PublicApiModifier and TypeClassDescriptionclass
This combines a number ofWiringFactory
s together to act as one.class
Info on all the directives provided by graphql specificationclass
class
class
class
class
NaturalEnumValuesProvider<T extends Enum<T>>
Simple EnumValuesProvided which maps the GraphQL Enum name to the Java Enum instance.class
A runtime wiring is a specification of data fetchers, type resolvers and custom scalars that are needed to wire together a functionalGraphQLSchema
static class
class
Info on all the standard scalar objects provided by graphql-javaclass
interface
A SchemaDirectiveWiring is responsible for enhancing a runtime element based on directives placed on that element in the Schema Definition Language (SDL).interface
SchemaDirectiveWiring
is passed this object as parameters when it builds out behaviourclass
This can generate a working runtime schema from a type registry and runtime wiringclass
This can take a graphql schema definition and parse it into aTypeDefinitionRegistry
of definitions ready to be placed intoSchemaGenerator
sayclass
This can print an in memory GraphQL schema back to a logical schema definitionclass
ATypeDefinitionRegistry
contains the set of type definitions that come from compiling a graphql schema definition file viaSchemaParser.parse(String)
class
A type runtime wiring is a specification of the data fetchers and possible type resolver for a given type name.class
(package private) class
-
Uses of PublicApi in graphql.schema.idl.errors
Classes in graphql.schema.idl.errors with annotations of type PublicApiModifier and TypeClassDescriptionclass
A number of problems can occur when using the schema tools likeSchemaParser
orSchemaGenerator
classes and they are reported via this exception as a list ofGraphQLError
s -
Uses of PublicApi in graphql.schema.transform
Classes in graphql.schema.transform with annotations of type PublicApiModifier and TypeClassDescriptionclass
Transforms a schema by applying a visibility predicate to every field.interface
Container to pass additional context about a schema element (ie., field) toVisibleFieldPredicate
. -
Uses of PublicApi in graphql.schema.usage
Classes in graphql.schema.usage with annotations of type PublicApiModifier and TypeClassDescriptionclass
This class shows schema usage information.class
-
Uses of PublicApi in graphql.schema.validation
Classes in graphql.schema.validation with annotations of type PublicApiModifier and TypeInterfaceDescriptioninterface
Error in graphql schema validation can have a classification, and all the error classifications implement this interface. -
Uses of PublicApi in graphql.schema.visibility
Classes in graphql.schema.visibility with annotations of type PublicApiModifier and TypeClassDescriptionclass
This helper class will take a list of regular expressions and match them against the fully qualified name of a type and its fields.class
The default field visibility of graphql-java is that everything is visibleinterface
This allows you to control the visibility of graphql fields.class
Deprecated.This is no longer the best way to prevent Introspection -Introspection.enabledJvmWide(boolean)
can be used instead -
Uses of PublicApi in graphql.schema.visitor
Classes in graphql.schema.visitor with annotations of type PublicApiModifier and TypeClassDescriptionclass
This indicates what traversal control to apply during the visitation and can be created via calls to methods likeGraphQLSchemaVisitorEnvironment.ok()
orGraphQLSchemaVisitorEnvironment.changeNode(GraphQLSchemaElement)
say -
Uses of PublicApi in graphql.util
Classes in graphql.util with annotations of type PublicApiModifier and TypeClassDescriptionclass
Util class which converts schemas and optionally queries into anonymized schemas and queries.class
Breadcrumb<T>
A specificNodeLocation
inside a node.interface
NodeAdapter<T>
Adapts an arbitrary class to behave as a node.class
General position of a Node inside a parent.class
class
NodeZipper<T>
enum
Special traversal control valuesinterface
Traversal context.class
class
-
Uses of PublicApi in graphql.validation
Classes in graphql.validation with annotations of type PublicApiModifier and TypeClassDescriptionclass
interface
enum
SimplePerformantInstrumentation
instead as a base class.