Package graphql.schema

Interface Summary

Interface	Description
Coercing<I,O>	The Coercing interface is used by GraphQLScalarTypes to parse and serialize object values.
DataFetcher<T>	A data fetcher is responsible for returning a data value back for a given graphql field.
DataFetcherFactory<T>	A DataFetcherFactory allows a level of indirection in providing DataFetchers for graphql fields.
DataFetchingEnvironment	A DataFetchingEnvironment instance of passed to a DataFetcher 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 input
DataFetchingFieldSelectionSet	This class allows you to retrieve the selection set of fields that have been asked for when the DataFetcher was invoked.
GraphQLCompositeType
GraphQLDirectiveContainer	Represents a graphql runtime type that can have GraphQLAppliedDirectives.
GraphQLFieldsContainer	Types that can contain output fields are marked with this interface
GraphQLImplementingType	A GraphQLType which can implement interfaces
GraphQLInputFieldsContainer	Types that can contain input fields are marked with this interface
GraphQLInputSchemaElement	A schema element that is concerned with input.
GraphQLInputType	Input types represent those set of types that are allowed to be accepted as graphql mutation input, as opposed to GraphQLOutputTypes which can only be used as graphql response output.
GraphQLInputValueDefinition	Named schema elements that contain input type information.
GraphQLModifiedType	A modified type wraps another graphql type and modifies it behavior
GraphQLNamedInputType	Input types represent those set of types that are allowed to be accepted as graphql mutation input, as opposed to GraphQLOutputTypes which can only be used as graphql response output.
GraphQLNamedOutputType	Output types represent those set of types that are allowed to be sent back as a graphql response, as opposed to GraphQLInputTypes which can only be used as graphql mutation input.
GraphQLNamedSchemaElement	A Schema element which has a name and also a description and AST Node which it is based on.
GraphQLNamedType	A GraphQLType which is also a named element, which means it has a getName() method.
GraphQLNullableType
GraphQLOutputType	Output types represent those set of types that are allowed to be sent back as a graphql response, as opposed to GraphQLInputTypes which can only be used as graphql mutation input.
GraphQLSchemaElement	A GraphQLSchema can be viewed as a graph of GraphQLSchemaElement.
GraphQLType	A type inside the GraphQLSchema.
GraphqlTypeComparatorRegistry
GraphQLTypeVisitor	GraphQLTypeVisitor can be used to visit all the elements of a schema (types, fields, directives and so on) in a visitor pattern.
GraphQLUnmodifiedType
LightDataFetcher<T>	A LightDataFetcher is a specialised version of DataFetcher that is passed more lightweight arguments when it is asked to fetch values.
SelectedField	A SelectedField represents a field that occurred in a query selection set during execution and they are returned from using the DataFetchingFieldSelectionSet interface returned via DataFetchingEnvironment.getSelectionSet()
TypeResolver	This is called during type resolution to work out what concrete GraphQLObjectType should be used dynamically during runtime for GraphQLInterfaceTypes and GraphQLUnionTypes

Class Summary

Class	Description
AsyncDataFetcher<T>	A modifier type that indicates the underlying data fetcher is run asynchronously
CodeRegistryVisitor	This ensure that all fields have data fetchers and that unions and interfaces have type resolvers
CoercingParseLiteralException.Builder
CoercingParseValueException.Builder
CoercingSerializeException.Builder
DataFetcherFactories	A helper for DataFetcherFactory
DataFetcherFactoryEnvironment	Deprecated. This class will go away at some point in the future since its pointless wrapper of a GraphQLFieldDefinition
DataFetcherFactoryEnvironment.Builder
DataFetchingEnvironmentImpl
DataFetchingEnvironmentImpl.Builder
DataFetchingFieldSelectionSetImpl
DefaultGraphqlTypeComparatorRegistry	Associates a Comparator with a GraphqlTypeComparatorEnvironment to control the scope in which the Comparator can be applied.
DefaultGraphqlTypeComparatorRegistry.Builder
DelegatingDataFetchingEnvironment	DelegatingDataFetchingEnvironment implements DataFetchingEnvironment by delegating to an underlying instance.
FieldCoordinates	A field in graphql is uniquely located within a parent type and hence code elements like DataFetcher need to be specified using those coordinates.
GraphQLAppliedDirective	An applied directive represents the instance of a directive that is applied to a schema element, as opposed to it definition
GraphQLAppliedDirective.Builder
GraphQLAppliedDirectiveArgument	This represents the argument values that can be placed on an GraphQLAppliedDirective.
GraphQLAppliedDirectiveArgument.Builder
GraphQLArgument	This defines an argument that can be supplied to a graphql field (via GraphQLFieldDefinition.
GraphQLArgument.Builder
GraphQLCodeRegistry	The GraphQLCodeRegistry holds that execution code that is associated with graphql types, namely the DataFetchers associated with fields, the TypeResolvers associated with abstract types and the GraphqlFieldVisibility
GraphQLCodeRegistry.Builder
GraphQLDirective	A directive can be used to modify the behavior of a graphql field or type.
GraphQLDirective.Builder
GraphqlDirectivesContainerTypeBuilder<B extends GraphqlDirectivesContainerTypeBuilder<B,BASE>,BASE extends GraphqlTypeBuilder<BASE>>
GraphqlElementParentTree	This represents a hierarchy an graphql runtime element upwards to its associated parent elements.
GraphQLEnumType	A graphql enumeration type has a limited set of values.
GraphQLEnumType.Builder
GraphQLEnumValueDefinition	A graphql enumeration type has a limited set of values and this defines one of those unique values
GraphQLEnumValueDefinition.Builder
GraphQLFieldDefinition	Fields are the ways you get data values in graphql and a field definition represents a field, its type, the arguments it takes and the DataFetcher used to get data values for that field.
GraphQLFieldDefinition.Builder
GraphQLInputObjectField	Input objects defined via GraphQLInputObjectType contains these input fields.
GraphQLInputObjectField.Builder
GraphQLInputObjectType	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.
GraphQLInputObjectType.Builder
GraphQLInterfaceType	In graphql, an interface is an abstract type that defines the set of fields that a type must include to implement that interface.
GraphQLInterfaceType.Builder
GraphQLList	A modified type that indicates there is a list of the underlying wrapped type, eg a list of strings or a list of booleans.
GraphQLNonNull	A modified type that indicates there the underlying wrapped type will not be null.
GraphQLObjectType	This is the work horse type and represents an object with one or more field values that can be retrieved by the graphql system.
GraphQLObjectType.Builder
GraphQLScalarType	A scalar type is a leaf node in the graphql tree of types.
GraphQLScalarType.Builder
GraphQLSchema	The schema represents the combined type system of the graphql engine.
GraphQLSchema.Builder
GraphQLSchema.BuilderWithoutTypes
GraphQLSchemaElementAdapter
GraphqlTypeBuilder<B extends GraphqlTypeBuilder<B>>
GraphqlTypeComparatorEnvironment	Defines the scope to control where the registered Comparator can be applied.
GraphqlTypeComparatorEnvironment.Builder
GraphqlTypeComparators
GraphQLTypeReference	A special type to allow a object/interface types to reference itself.
GraphQLTypeResolvingVisitor
GraphQLTypeUtil	A utility class that helps work with GraphQLTypes
GraphQLTypeVisitorStub	Base implementation of GraphQLTypeVisitor for convenience.
GraphQLUnionType	A union type is a polymorphic type that dynamically represents one of more concrete object types.
GraphQLUnionType.Builder
InputValueWithState	Used by @GraphQLArgument and GraphQLInputObjectField to represent different value states.
PropertyDataFetcher<T>	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.
PropertyDataFetcherHelper	This class is the guts of a property data fetcher and also used in AST code to turn in memory java objects into AST elements
PropertyFetchingImpl	A re-usable class that can fetch from POJOs
SchemaElementChildrenContainer
SchemaElementChildrenContainer.Builder
SchemaTransformer	Transforms a GraphQLSchema object by calling bac on a provided visitor.
SchemaTraverser
SingletonPropertyDataFetcher<T>	The SingletonPropertyDataFetcher is much like the PropertyDataFetcher except that it is designed to only ever fetch properties via the name of the field passed in.
StaticDataFetcher	A DataFetcher that always returns the same value
TypeResolverProxy

Exception Summary

Exception	Description
CoercingParseLiteralException
CoercingParseValueException
CoercingSerializeException