Uses of Annotation Type
graphql.PublicApi
Packages that use PublicApi
Package
Description
-
Uses of PublicApi in graphql
Modifier and TypeClassDescriptionclassclassThe directives that are understood by graphql-javainterfaceErrors in graphql-java can have a classification to help with the processing of errors.enumAll the errors in graphql belong to one of these categoriesclassThis graphql error will be used if a runtime exception is encountered while a data fetcher is invokedclassThis represents the series of values that can be input on a graphql query executioninterfaceThis simple value class represents the result of performing a graphql query.classThis class is where all graphql-java query execution begins.static classclassThis context object can be used to contain key values that can be useful as "context" when executingDataFetchersinterfaceThe interface describing graphql errors NOTE: This class implementsSerializableand hence it can be serialised and placed into a distributed cache.classGraphqlErrorBuilder<B extends GraphqlErrorBuilder<B>>This helps you buildGraphQLErrors and also has a quick way to make aDataFetcherResults from that error.classA base class for graphql runtime exceptions that also implementGraphQLErrorand can be used in a general sense direct or have specialisations made of it.classThis class allows you to parse and validate a graphql query without executing it.classA result object used inParseAndValidatehelper that indicates the outcomes of a parse and validate operation.classThis contains the implementations of the Scalar types that ship with graphql-java.classclassclassThis is passed to aTypeResolverto help with object type resolution.class -
Uses of PublicApi in graphql.analysis
Classes in graphql.analysis with annotations of type PublicApiModifier and TypeInterfaceDescriptioninterfaceUsed to calculate the complexity of a field.classclassPrevents execution if the query complexity is greater than the specified maxComplexity.classPrevents execution if the query depth is greater than the specified maxDepth.classThis can calculate the complexity of an operation using the specifiedFieldComplexityCalculatoryou pass into it.classThe query complexity info.static classclassThe query depth info.static classinterfaceQueryReducer<T>Used byQueryTraverserto reduce the fields of a Document (or part of it) to a single value.classHelps to transform a Document (or parts of it) and tracks at the same time the corresponding Schema types.static classclassHelps to traverse (or reduce) a Document (or parts of it) and tracks at the same time the corresponding Schema types.static classinterfaceUsed byQueryTraverserto visit the nodes of a Query.interfaceinterfaceThis 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.interfaceinterfaceinterfaceinterfaceinterfaceclass -
Uses of PublicApi in graphql.analysis.values
Classes in graphql.analysis.values with annotations of type PublicApiModifier and TypeClassDescriptionclassThis 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 TypeClassDescriptionclassThis Exception indicates that the current execution should be aborted.classThe standard graphql execution strategy that runs fields asynchronously non-blocking.classAsync non-blocking execution, but serial: only one field at the time will be resolved.classHolds coerced variables, that is their values are now in a canonical form.classThe parameters available toDataFetcherExceptionHandlersclassThe result object forDataFetcherExceptionHandlersclassAn object that can be returned from aDataFetcherthat contains both data, local context and errors to be added to the final result.classPublic API because it should be used as a delegate when implementing a customValueUnboxerclassclassclassThis opaque identifier is used to identify a unique query executionclassAs 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.classThe parameters that are passed to execution strategiesclassNote: This is returned byInstrumentationFieldCompleteParameters.getFetchedValue()and therefore part of the public despite never used in a method signature.classclasshttps://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.classThis represents all Fields in a query which overlap and are merged into one.classclassThis is thrown if a query is attempting to perform an operation not defined in the GraphQL schemaclassThis is thrown if a non nullable value is coerced to a null valueclassThe input map to One Of Input Types MUST only have 1 entry with a non null valueclassThe input map to One Of Input Types MUST only have 1 entryclassHolds raw variables, which have not been coerced yet intoCoercedVariablesclassThis class is used to track the number of result nodes that have been created during execution.classAs 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.classThe standard handling of data fetcher error involves placing aExceptionWhileDataFetchingerror into the error collectionclassAn execution strategy that implements graphql subscriptions by using reactive-streams as the output result of the subscription query.classThis 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.classThis is thrown if aTypeResolverfails 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 TypeClassDescriptionclassAn applied directive represents the instance of a directive that is applied to a query element such as a field or fragment.classThis represents the argument values that can be placed on anQueryAppliedDirective.interfaceThis 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 TypeClassDescriptionclassThis allows you to chain together a number ofInstrumentationimplementations and run them in sequence.classclassThis version ofChainedInstrumentationwill call a list ofInstrumentations but it will never back on the returnedInstrumentationContextobjects, hence it is only suitable to certain use cases.classDeprecated.classA simple implementation ofInstrumentationContextclassAn implementation ofInstrumentationthat does nothing. -
Uses of PublicApi in graphql.execution.instrumentation.dataloader
Classes in graphql.execution.instrumentation.dataloader with annotations of type PublicApiModifier and TypeClassDescriptionclassThis graphqlInstrumentationwill dispatch all the containedDataLoaders when each level of the graphql query is executed.classThe options that control the operation ofDataLoaderDispatcherInstrumentationclassA 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 TypeInterfaceDescriptioninterfaceThis represents a field and its arguments that may be validated.interfaceThis contains all of the field and their arguments for a given query.classThisInstrumentationallows you to validate the fields of the query before the query is executed.classThis 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 TypeClassDescriptionclassParameters sent toInstrumentationmethodsclassParameters sent toInstrumentationmethodsclassParameters sent toInstrumentationmethodsclassParameters sent toInstrumentationmethodsclassParameters sent toInstrumentationmethodsclassParameters sent toInstrumentationmethodsclassParameters sent toInstrumentationmethodsclassParameters sent toInstrumentationmethods -
Uses of PublicApi in graphql.execution.instrumentation.tracing
Classes in graphql.execution.instrumentation.tracing with annotations of type PublicApiModifier and TypeClassDescriptionclassThisInstrumentationimplementation usesTracingSupportto capture tracing information and puts it into theExecutionResultclassThis 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 TypeClassDescriptionclassAn 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 TypeClassDescriptionclassThis persisted query support class supports the Apollo scheme where the persisted query id is inExecutionInput.getExtensions().classA PersistedQueryCache that is just an in memory map of known queries.interfaceThe call back when a valid persisted query is not in cache and it needs to be compiled and validated by the graphql engine.classclassAn 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 TypeClassDescriptionclassA simple subscription that delegates to anotherclassSubscription queries return an instance of this class in theExecutionResultdata element for the subscribed field. -
Uses of PublicApi in graphql.extensions
Classes in graphql.extensions with annotations of type PublicApiModifier and TypeClassDescriptionclassThis 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 TypeClassDescriptionclassThisInstrumentationensure that a submitted introspection query is done in good faith.classGraphQl 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.interfaceclassIntrospectionQueryBuilderallows you to build introspection queries controlled by the options you specifyclassclassThe 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 interfaceThe parameter environment on a call toIntrospectionWithDirectivesSupport.DirectivePredicate -
Uses of PublicApi in graphql.language
Classes in graphql.language with annotations of type PublicApiModifier and TypeClassDescriptionclassAbstractDescribedNode<T extends Node>classAbstractNode<T extends Node>classclassclassAdapts an Ast node to the general node from the util packageclassThis can take graphql language AST and print it out as a stringclassThis will produce signature and privacy safe query documents that can be used for query categorisation and logging.classA class that helps you sort AST nodesclassAllows 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.classclassA single-line comment.interfaceDefinition<T extends Definition>interfaceDescribedNode<T extends Node>Represents a node that can contain a description.classclassclassclassinterfaceDirectivesContainer<T extends DirectivesContainer>Represents a language node that can contain Directives.classclassclassclassclassclassclassclassclassProvided to the DataFetcher, therefore public APIclassclassGraphql syntax has a series of characters, such as spaces, new lines and commas that are not considered relevant to the syntax.classGraphql syntax has a series of characters, such as spaces, new lines and commas that are not considered relevant to the syntax.interfaceImplementingTypeDefinition<T extends TypeDefinition>ATypeDefinitionthat might implement interfacesclassclassclassclassclassclassclassclassinterfaceRepresents a language node that has a nameinterfaceThe base interface for virtually all graphql language elements NOTE: This class implementsSerializableand hence it can be serialised and placed into a distributed cache.interfaceclassContainer of children of aNode.interfaceclassNodeParentTree<T extends Node>This represents a hierarchy from a graphql language node upwards to its associated parent nodes.classLets you traverse aNodetree.interfaceUsed byNodeTraverserto visitNode.classConvenient implementation ofNodeVisitorfor easy subclassing methods handling different types of Nodes in one method.classclassclassclassclassclassclassclassclassclassinterfaceScalarValue<T extends Value>classclassinterfaceSDLDefinition<T extends SDLDefinition>An interface for Schema Definition Language (SDL) definitions.interfaceA marker interface for Schema Definition Language (SDL) extension definitions.interfaceSDLNamedDefinition<T extends SDLNamedDefinition>A interface for named Schema Definition Language (SDL) definition.interfaceclassinterfaceSelectionSetContainer<T extends Node>classclassinterfaceinterfaceTypeDefinition<T extends TypeDefinition>An interface for type definitions in a Schema Definition Language (SDL).enumAnd enumeration of the the kind of things that can be in a graphql type systemclassclassclassinterfaceclassclass -
Uses of PublicApi in graphql.normalized
Classes in graphql.normalized with annotations of type PublicApiModifier and TypeClassDescriptionclassAnExecutableNormalizedFieldrepresents a field in an executable graphql operation.classAExecutableNormalizedOperationrepresent how the text of a graphql operation (sometimes known colloquially as a query) will be executed at runtime according to the graphql specification.classThis factory can create aExecutableNormalizedOperationwhich represents what would be executed during a given graphql operation.classThis class can take a list ofExecutableNormalizedFields and compiling out a normalised operationDocumentthat would represent how those fields maybe executed.classAn argument value with type information. -
Uses of PublicApi in graphql.parser
Classes in graphql.parser with annotations of type PublicApiModifier and TypeClassDescriptionclassThis exception is thrown by theParserif the graphql syntax is not validclassThis 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.classThis can parse graphql syntax, both Query syntax and Schema Definition Language (SDL) syntax, into an Abstract Syntax Tree (AST) represented by aDocumentinterfaceThis is the arguments that can be passed to aParserclassOptions that control how theParserbehaves. -
Uses of PublicApi in graphql.relay
Classes in graphql.relay with annotations of type PublicApiModifier and TypeInterfaceDescriptioninterfaceConnection<T>interfaceRepresents aconnectioncursor in Relay which is an opaque string that the server understands.classA default implementation ofConnectionclassclassDefaultEdge<T>classinterfaceEdge<T>Represents an edge in Relay which is essentially a node of data T and the cursor for that node.interfaceRepresents pagination information in Relay aboutedgeswhen used inside aconnectionSee https://facebook.github.io/relay/graphql/connections.htm#sec-undefined.PageInfoclassThis 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 TypeClassDescriptionclassA modifier type that indicates the underlying data fetcher is run asynchronouslyclassclassclassclassA helper forDataFetcherFactoryclassThis is passed to aDataFetcherFactorywhen it is invoked to get aDataFetcherinterfaceA DataFetchingEnvironment instance of passed to aDataFetcheras a execution context and its the place where you can find out information to help you resolve a data value given a graphql field inputinterfaceThis class allows you to retrieve the selection set of fields that have been asked for when theDataFetcherwas invoked.classAssociates aComparatorwith aGraphqlTypeComparatorEnvironmentto control the scope in which theComparatorcan be applied.classDelegatingDataFetchingEnvironment implementsDataFetchingEnvironmentby delegating to an underlying instance.classA field in graphql is uniquely located within a parent type and hence code elements likeDataFetcherneed to be specified using those coordinates.classAn applied directive represents the instance of a directive that is applied to a schema element, as opposed to it definitionclassThis represents the argument values that can be placed on anGraphQLAppliedDirective.classThis defines an argument that can be supplied to a graphql field (viaGraphQLFieldDefinition.classTheGraphQLCodeRegistryholds that execution code that is associated with graphql types, namely theDataFetchers associated with fields, theTypeResolvers associated with abstract types and theGraphqlFieldVisibilityinterfaceclassA directive can be used to modify the behavior of a graphql field or type.interfaceRepresents a graphql runtime type that can haveGraphQLAppliedDirectives.classThis represents a hierarchy an graphql runtime element upwards to its associated parent elements.classA graphql enumeration type has a limited set of values.classA graphql enumeration type has a limited set of values and this defines one of those unique valuesstatic classclassFields are the ways you get data values in graphql and a field definition represents a field, its type, the arguments it takes and theDataFetcherused to get data values for that field.static classinterfaceTypes that can contain output fields are marked with this interfaceinterfaceA GraphQLType which can implement interfacesinterfaceTypes that can contain input fields are marked with this interfaceclassInput objects defined viaGraphQLInputObjectTypecontains these input fields.static classclassgraphql 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 classinterfaceA schema element that is concerned with input.interfaceInput types represent those set of types that are allowed to be accepted as graphql mutation input, as opposed toGraphQLOutputTypes which can only be used as graphql response output.interfaceNamed schema elements that contain input type information.classIn graphql, an interface is an abstract type that defines the set of fields that a type must include to implement that interface.static classclassA modified type that indicates there is a list of the underlying wrapped type, eg a list of strings or a list of booleans.interfaceA modified type wraps another graphql type and modifies it behaviorinterfaceInput types represent those set of types that are allowed to be accepted as graphql mutation input, as opposed toGraphQLOutputTypes which can only be used as graphql response output.interfaceOutput types represent those set of types that are allowed to be sent back as a graphql response, as opposed toGraphQLInputTypes which can only be used as graphql mutation input.interfaceA Schema element which has a name and also a description and AST Node which it is based on.interfaceA GraphQLType which is also a named element, which means it has a getName() method.classA modified type that indicates there the underlying wrapped type will not be null.interfaceclassThis is the work horse type and represents an object with one or more field values that can be retrieved by the graphql system.static classinterfaceOutput types represent those set of types that are allowed to be sent back as a graphql response, as opposed toGraphQLInputTypes which can only be used as graphql mutation input.classA scalar type is a leaf node in the graphql tree of types.static classclassThe schema represents the combined type system of the graphql engine.interfaceA GraphQLSchema can be viewed as a graph of GraphQLSchemaElement.interfaceA type inside the GraphQLSchema.classDefines the scope to control where the registeredComparatorcan be applied.interfaceclassA special type to allow a object/interface types to reference itself.classA utility class that helps work withGraphQLTypesinterfaceGraphQLTypeVisitor can be used to visit all the elements of a schema (types, fields, directives and so on) in a visitor pattern.classBase implementation ofGraphQLTypeVisitorfor convenience.classA union type is a polymorphic type that dynamically represents one of more concrete object types.static classinterfaceclassUsed by @GraphQLArgumentandGraphQLInputObjectFieldto represent different value states.classThis 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.classclassTransforms aGraphQLSchemaobject by calling bac on a provided visitor.classinterfaceASelectedFieldrepresents a field that occurred in a query selection set during execution and they are returned from using theDataFetchingFieldSelectionSetinterface returned viaDataFetchingEnvironment.getSelectionSet()classADataFetcherthat always returns the same value -
Uses of PublicApi in graphql.schema.diff
Classes in graphql.schema.diff with annotations of type PublicApiModifier and TypeClassDescriptionenumA classification of difference events.classThis represents the events that theSchemaDiffoutputs.enumThis is the level of difference between graphql APIsclassDeprecated.classInterface used to define 2 schemas that can be diffed by theSchemaDiffoperation. -
Uses of PublicApi in graphql.schema.diff.reporting
Classes in graphql.schema.diff.reporting with annotations of type PublicApiModifier and TypeClassDescriptionclassA reporter that captures all the difference events as they occurclassA reporter that chains together one or more difference reportersclassA 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 TypeClassDescriptionclassThis combines a number ofWiringFactorys together to act as one.classInfo on all the directives provided by graphql specificationclassclassclassclassclassNaturalEnumValuesProvider<T extends Enum<T>>Simple EnumValuesProvided which maps the GraphQL Enum name to the Java Enum instance.classA runtime wiring is a specification of data fetchers, type resolvers and custom scalars that are needed to wire together a functionalGraphQLSchemastatic classclassInfo on all the standard scalar objects provided by graphql-javaclassinterfaceA SchemaDirectiveWiring is responsible for enhancing a runtime element based on directives placed on that element in the Schema Definition Language (SDL).interfaceSchemaDirectiveWiringis passed this object as parameters when it builds out behaviourclassThis can generate a working runtime schema from a type registry and runtime wiringclassThis can take a graphql schema definition and parse it into aTypeDefinitionRegistryof definitions ready to be placed intoSchemaGeneratorsayclassThis can print an in memory GraphQL schema back to a logical schema definitionclassATypeDefinitionRegistrycontains the set of type definitions that come from compiling a graphql schema definition file viaSchemaParser.parse(String)classA 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 TypeClassDescriptionclassA number of problems can occur when using the schema tools likeSchemaParserorSchemaGeneratorclasses and they are reported via this exception as a list ofGraphQLErrors -
Uses of PublicApi in graphql.schema.transform
Classes in graphql.schema.transform with annotations of type PublicApiModifier and TypeClassDescriptionclassTransforms a schema by applying a visibility predicate to every field.interfaceContainer 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 TypeClassDescriptionclassThis class shows schema usage information.class -
Uses of PublicApi in graphql.schema.validation
Classes in graphql.schema.validation with annotations of type PublicApiModifier and TypeInterfaceDescriptioninterfaceError 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 TypeClassDescriptionclassThis helper class will take a list of regular expressions and match them against the fully qualified name of a type and its fields.classThe default field visibility of graphql-java is that everything is visibleinterfaceThis allows you to control the visibility of graphql fields.classDeprecated.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 TypeClassDescriptionclassThis 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 TypeClassDescriptionclassUtil class which converts schemas and optionally queries into anonymized schemas and queries.classBreadcrumb<T>A specificNodeLocationinside a node.interfaceNodeAdapter<T>Adapts an arbitrary class to behave as a node.classGeneral position of a Node inside a parent.classclassNodeZipper<T>enumSpecial traversal control valuesinterfaceTraversal context.classclass -
Uses of PublicApi in graphql.validation
Classes in graphql.validation with annotations of type PublicApiModifier and TypeClassDescriptionclassinterfaceenum
SimplePerformantInstrumentationinstead as a base class.