Package graphql.schema.visitor

Interface GraphQLSchemaVisitor

@PublicSpi
public interface GraphQLSchemaVisitor

This visitor interface offers more "smarts" above GraphQLTypeVisitor and aims to be easier to use with more type safe helpers.

You would use it places that need a GraphQLTypeVisitor by doing `new GraphQLSchemaVisitor() { ...}.toTypeVisitor()`

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	GraphQLSchemaVisitor.AppliedDirectiveArgumentVisitorEnvironment	A GraphQLSchemaVisitorEnvironment environment specific to GraphQLAppliedDirectiveArgument
static interface	GraphQLSchemaVisitor.AppliedDirectiveVisitorEnvironment	A GraphQLSchemaVisitorEnvironment environment specific to GraphQLAppliedDirective
static interface	GraphQLSchemaVisitor.ArgumentVisitorEnvironment	A GraphQLSchemaVisitorEnvironment environment specific to GraphQLArgument
static interface	GraphQLSchemaVisitor.DirectiveVisitorEnvironment
static interface	GraphQLSchemaVisitor.EnumTypeVisitorEnvironment	A GraphQLSchemaVisitorEnvironment environment specific to GraphQLEnumType
static interface	GraphQLSchemaVisitor.EnumValueDefinitionVisitorEnvironment	A GraphQLSchemaVisitorEnvironment environment specific to GraphQLEnumValueDefinition
static interface	GraphQLSchemaVisitor.FieldDefinitionVisitorEnvironment	A GraphQLSchemaVisitorEnvironment environment specific to GraphQLFieldDefinition
static interface	GraphQLSchemaVisitor.InputObjectFieldVisitorEnvironment	A GraphQLSchemaVisitorEnvironment environment specific to GraphQLInputObjectField
static interface	GraphQLSchemaVisitor.InputObjectTypeVisitorEnvironment	A GraphQLSchemaVisitorEnvironment environment specific to GraphQLInputObjectType
static interface	GraphQLSchemaVisitor.InterfaceTypeVisitorEnvironment	A GraphQLSchemaVisitorEnvironment environment specific to GraphQLInterfaceType
static interface	GraphQLSchemaVisitor.ObjectVisitorEnvironment	A GraphQLSchemaVisitorEnvironment environment specific to GraphQLObjectType
static interface	GraphQLSchemaVisitor.ScalarTypeVisitorEnvironment	A GraphQLSchemaVisitorEnvironment environment specific to GraphQLScalarType
static interface	GraphQLSchemaVisitor.SchemaElementVisitorEnvironment	A GraphQLSchemaVisitorEnvironment environment specific to GraphQLSchemaElement
static interface	GraphQLSchemaVisitor.UnionTypeVisitorEnvironment	A GraphQLSchemaVisitorEnvironment environment specific to GraphQLUnionType

Method Summary

Modifier and Type	Method	Description
default GraphQLTypeVisitor	toTypeVisitor()	This allows you to turn this smarter visitor into the base GraphQLTypeVisitor interface
default GraphQLSchemaTraversalControl	visitAppliedDirective(GraphQLAppliedDirective appliedDirective, GraphQLSchemaVisitor.AppliedDirectiveVisitorEnvironment environment)	Called when visiting a GraphQLAppliedDirective in the schema
default GraphQLSchemaTraversalControl	visitAppliedDirectiveArgument(GraphQLAppliedDirectiveArgument appliedDirectiveArgument, GraphQLSchemaVisitor.AppliedDirectiveArgumentVisitorEnvironment environment)	Called when visiting a GraphQLAppliedDirectiveArgument in the schema
default GraphQLSchemaTraversalControl	visitArgument(GraphQLArgument argument, GraphQLSchemaVisitor.ArgumentVisitorEnvironment environment)	Called when visiting a GraphQLArgument in the schema
default GraphQLSchemaTraversalControl	visitDirective(GraphQLDirective directive, GraphQLSchemaVisitor.DirectiveVisitorEnvironment environment)	Called when visiting a GraphQLArgument in the schema
default GraphQLSchemaTraversalControl	visitEnumType(GraphQLEnumType enumType, GraphQLSchemaVisitor.EnumTypeVisitorEnvironment environment)	Called when visiting a GraphQLEnumType in the schema
default GraphQLSchemaTraversalControl	visitEnumValueDefinition(GraphQLEnumValueDefinition enumValueDefinition, GraphQLSchemaVisitor.EnumValueDefinitionVisitorEnvironment environment)	Called when visiting a GraphQLEnumValueDefinition in the schema
default GraphQLSchemaTraversalControl	visitFieldDefinition(GraphQLFieldDefinition fieldDefinition, GraphQLSchemaVisitor.FieldDefinitionVisitorEnvironment environment)	Called when visiting a GraphQLFieldDefinition in the schema
default GraphQLSchemaTraversalControl	visitInputObjectField(GraphQLInputObjectField inputObjectField, GraphQLSchemaVisitor.InputObjectFieldVisitorEnvironment environment)	Called when visiting a GraphQLInputObjectField in the schema
default GraphQLSchemaTraversalControl	visitInputObjectType(GraphQLInputObjectType inputObjectType, GraphQLSchemaVisitor.InputObjectTypeVisitorEnvironment environment)	Called when visiting a GraphQLInputObjectType in the schema
default GraphQLSchemaTraversalControl	visitInterfaceType(GraphQLInterfaceType interfaceType, GraphQLSchemaVisitor.InterfaceTypeVisitorEnvironment environment)	Called when visiting a GraphQLInterfaceType in the schema
default GraphQLSchemaTraversalControl	visitObjectType(GraphQLObjectType objectType, GraphQLSchemaVisitor.ObjectVisitorEnvironment environment)	Called when visiting a GraphQLObjectType in the schema
default GraphQLSchemaTraversalControl	visitScalarType(GraphQLScalarType scalarType, GraphQLSchemaVisitor.ScalarTypeVisitorEnvironment environment)	Called when visiting a GraphQLScalarType in the schema
default GraphQLSchemaTraversalControl	visitSchemaElement(GraphQLSchemaElement schemaElement, GraphQLSchemaVisitor.SchemaElementVisitorEnvironment environment)	Called when visiting any GraphQLSchemaElement in the schema.
default GraphQLSchemaTraversalControl	visitUnionType(GraphQLUnionType unionType, GraphQLSchemaVisitor.UnionTypeVisitorEnvironment environment)	Called when visiting a GraphQLUnionType in the schema

Method Details

visitAppliedDirective

default GraphQLSchemaTraversalControl visitAppliedDirective(GraphQLAppliedDirective appliedDirective,
 GraphQLSchemaVisitor.AppliedDirectiveVisitorEnvironment environment)

Called when visiting a GraphQLAppliedDirective in the schema

Parameters:

appliedDirective - the schema element being visited

environment - the visiting environment

Returns:

a control value which is typically GraphQLSchemaVisitorEnvironment.ok()}

visitAppliedDirectiveArgument

default GraphQLSchemaTraversalControl visitAppliedDirectiveArgument(GraphQLAppliedDirectiveArgument appliedDirectiveArgument,
 GraphQLSchemaVisitor.AppliedDirectiveArgumentVisitorEnvironment environment)

Called when visiting a GraphQLAppliedDirectiveArgument in the schema

Parameters:

appliedDirectiveArgument - the schema element being visited

environment - the visiting environment

Returns:

a control value which is typically GraphQLSchemaVisitorEnvironment.ok()}

visitArgument

default GraphQLSchemaTraversalControl visitArgument(GraphQLArgument argument,
 GraphQLSchemaVisitor.ArgumentVisitorEnvironment environment)

Called when visiting a GraphQLArgument in the schema

Parameters:

argument - the schema element being visited

environment - the visiting environment

Returns:

a control value which is typically GraphQLSchemaVisitorEnvironment.ok()}

visitDirective

default GraphQLSchemaTraversalControl visitDirective(GraphQLDirective directive,
 GraphQLSchemaVisitor.DirectiveVisitorEnvironment environment)

Called when visiting a GraphQLArgument in the schema

Parameters:

directive - the schema element being visited

environment - the visiting environment

Returns:

a control value which is typically GraphQLSchemaVisitorEnvironment.ok()}

visitEnumType

default GraphQLSchemaTraversalControl visitEnumType(GraphQLEnumType enumType,
 GraphQLSchemaVisitor.EnumTypeVisitorEnvironment environment)

Called when visiting a GraphQLEnumType in the schema

Parameters:

enumType - the schema element being visited

environment - the visiting environment

Returns:

a control value which is typically GraphQLSchemaVisitorEnvironment.ok()}

visitEnumValueDefinition

default GraphQLSchemaTraversalControl visitEnumValueDefinition(GraphQLEnumValueDefinition enumValueDefinition,
 GraphQLSchemaVisitor.EnumValueDefinitionVisitorEnvironment environment)

Called when visiting a GraphQLEnumValueDefinition in the schema

Parameters:

enumValueDefinition - the schema element being visited

environment - the visiting environment

Returns:

a control value which is typically GraphQLSchemaVisitorEnvironment.ok()}

visitFieldDefinition

default GraphQLSchemaTraversalControl visitFieldDefinition(GraphQLFieldDefinition fieldDefinition,
 GraphQLSchemaVisitor.FieldDefinitionVisitorEnvironment environment)

Called when visiting a GraphQLFieldDefinition in the schema

Parameters:

fieldDefinition - the schema element being visited

environment - the visiting environment

Returns:

a control value which is typically GraphQLSchemaVisitorEnvironment.ok()}

visitInputObjectField

default GraphQLSchemaTraversalControl visitInputObjectField(GraphQLInputObjectField inputObjectField,
 GraphQLSchemaVisitor.InputObjectFieldVisitorEnvironment environment)

Called when visiting a GraphQLInputObjectField in the schema

Parameters:

inputObjectField - the schema element being visited

environment - the visiting environment

Returns:

a control value which is typically GraphQLSchemaVisitorEnvironment.ok()}

visitInputObjectType

default GraphQLSchemaTraversalControl visitInputObjectType(GraphQLInputObjectType inputObjectType,
 GraphQLSchemaVisitor.InputObjectTypeVisitorEnvironment environment)

Called when visiting a GraphQLInputObjectType in the schema

Parameters:

inputObjectType - the schema element being visited

environment - the visiting environment

Returns:

a control value which is typically GraphQLSchemaVisitorEnvironment.ok()}

visitInterfaceType

default GraphQLSchemaTraversalControl visitInterfaceType(GraphQLInterfaceType interfaceType,
 GraphQLSchemaVisitor.InterfaceTypeVisitorEnvironment environment)

Called when visiting a GraphQLInterfaceType in the schema

Parameters:

interfaceType - the schema element being visited

environment - the visiting environment

Returns:

a control value which is typically GraphQLSchemaVisitorEnvironment.ok()}

visitObjectType

default GraphQLSchemaTraversalControl visitObjectType(GraphQLObjectType objectType,
 GraphQLSchemaVisitor.ObjectVisitorEnvironment environment)

Called when visiting a GraphQLObjectType in the schema

Parameters:

objectType - the schema element being visited

environment - the visiting environment

Returns:

a control value which is typically GraphQLSchemaVisitorEnvironment.ok()}

visitScalarType

default GraphQLSchemaTraversalControl visitScalarType(GraphQLScalarType scalarType,
 GraphQLSchemaVisitor.ScalarTypeVisitorEnvironment environment)

Called when visiting a GraphQLScalarType in the schema

Parameters:

scalarType - the schema element being visited

environment - the visiting environment

Returns:

a control value which is typically GraphQLSchemaVisitorEnvironment.ok()}

visitUnionType

default GraphQLSchemaTraversalControl visitUnionType(GraphQLUnionType unionType,
 GraphQLSchemaVisitor.UnionTypeVisitorEnvironment environment)

Called when visiting a GraphQLUnionType in the schema

Parameters:

unionType - the schema element being visited

environment - the visiting environment

Returns:

a control value which is typically GraphQLSchemaVisitorEnvironment.ok()}

visitSchemaElement

default GraphQLSchemaTraversalControl visitSchemaElement(GraphQLSchemaElement schemaElement,
 GraphQLSchemaVisitor.SchemaElementVisitorEnvironment environment)

Called when visiting any GraphQLSchemaElement in the schema. Since every element in the schema is a schema element, this visitor method will be called back for every element in the schema

Parameters:

schemaElement - the schema element being visited

environment - the visiting environment

Returns:

a control value which is typically GraphQLSchemaVisitorEnvironment.ok()}

toTypeVisitor

default GraphQLTypeVisitor toTypeVisitor()

This allows you to turn this smarter visitor into the base GraphQLTypeVisitor interface

Returns:

a type visitor