graphql.schema.impl

Class MultiReadOnlyGraphQLTypeVisitor

java.lang.Object

graphql.schema.impl.MultiReadOnlyGraphQLTypeVisitor

All Implemented Interfaces:

GraphQLTypeVisitor

public class MultiReadOnlyGraphQLTypeVisitor
extends java.lang.Object
implements GraphQLTypeVisitor

A delegating type visitor that allows you to call N visitors in a list and always continues via TraversalControl.CONTINUE

Constructor Summary

Constructors

Constructor and Description
MultiReadOnlyGraphQLTypeVisitor(java.util.List<GraphQLTypeVisitor> visitors)

Method Summary

Modifier and Type	Method and Description
TraversalControl	changeNode(TraverserContext<GraphQLSchemaElement> context, GraphQLSchemaElement newChangedNode) This helper method can be used to "change" a node when returning control from this visitor
TraversalControl	deleteNode(TraverserContext<GraphQLSchemaElement> context) This helper method can be used to "delete" the current node when returning control from this visitor
TraversalControl	insertAfter(TraverserContext<GraphQLSchemaElement> context, GraphQLSchemaElement toInsertAfter) This helper method can be used to "insert a new node" AFTER the current node when returning control from this visitor
TraversalControl	insertBefore(TraverserContext<GraphQLSchemaElement> context, GraphQLSchemaElement toInsertBefore) This helper method can be used to "insert a new node" BEFORE the current node when returning control from this visitor
TraversalControl	visitBackRef(TraverserContext<GraphQLSchemaElement> context) Called when a node is visited more than once within a context.
TraversalControl	visitGraphQLAppliedDirective(GraphQLAppliedDirective node, TraverserContext<GraphQLSchemaElement> context) This method will be called when a directive is applied to a schema element.
TraversalControl	visitGraphQLAppliedDirectiveArgument(GraphQLAppliedDirectiveArgument node, TraverserContext<GraphQLSchemaElement> context)
TraversalControl	visitGraphQLArgument(GraphQLArgument node, TraverserContext<GraphQLSchemaElement> context)
TraversalControl	visitGraphQLCompositeType(GraphQLCompositeType node, TraverserContext<GraphQLSchemaElement> context)
TraversalControl	visitGraphQLDirective(GraphQLDirective node, TraverserContext<GraphQLSchemaElement> context) This method will be called twice.
TraversalControl	visitGraphQLDirectiveContainer(GraphQLDirectiveContainer node, TraverserContext<GraphQLSchemaElement> context)
TraversalControl	visitGraphQLEnumType(GraphQLEnumType node, TraverserContext<GraphQLSchemaElement> context)
TraversalControl	visitGraphQLEnumValueDefinition(GraphQLEnumValueDefinition node, TraverserContext<GraphQLSchemaElement> context)
TraversalControl	visitGraphQLFieldDefinition(GraphQLFieldDefinition node, TraverserContext<GraphQLSchemaElement> context)
TraversalControl	visitGraphQLFieldsContainer(GraphQLFieldsContainer node, TraverserContext<GraphQLSchemaElement> context)
TraversalControl	visitGraphQLInputFieldsContainer(GraphQLInputFieldsContainer node, TraverserContext<GraphQLSchemaElement> context)
TraversalControl	visitGraphQLInputObjectField(GraphQLInputObjectField node, TraverserContext<GraphQLSchemaElement> context)
TraversalControl	visitGraphQLInputObjectType(GraphQLInputObjectType node, TraverserContext<GraphQLSchemaElement> context)
TraversalControl	visitGraphQLInputType(GraphQLInputType node, TraverserContext<GraphQLSchemaElement> context)
TraversalControl	visitGraphQLInterfaceType(GraphQLInterfaceType node, TraverserContext<GraphQLSchemaElement> context)
TraversalControl	visitGraphQLList(GraphQLList node, TraverserContext<GraphQLSchemaElement> context)
TraversalControl	visitGraphQLModifiedType(GraphQLModifiedType node, TraverserContext<GraphQLSchemaElement> context)
TraversalControl	visitGraphQLNonNull(GraphQLNonNull node, TraverserContext<GraphQLSchemaElement> context)
TraversalControl	visitGraphQLNullableType(GraphQLNullableType node, TraverserContext<GraphQLSchemaElement> context)
TraversalControl	visitGraphQLObjectType(GraphQLObjectType node, TraverserContext<GraphQLSchemaElement> context)
TraversalControl	visitGraphQLOutputType(GraphQLOutputType node, TraverserContext<GraphQLSchemaElement> context)
TraversalControl	visitGraphQLScalarType(GraphQLScalarType node, TraverserContext<GraphQLSchemaElement> context)
TraversalControl	visitGraphQLTypeReference(GraphQLTypeReference node, TraverserContext<GraphQLSchemaElement> context)
TraversalControl	visitGraphQLUnionType(GraphQLUnionType node, TraverserContext<GraphQLSchemaElement> context)
TraversalControl	visitGraphQLUnmodifiedType(GraphQLUnmodifiedType node, TraverserContext<GraphQLSchemaElement> context)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MultiReadOnlyGraphQLTypeVisitor

public MultiReadOnlyGraphQLTypeVisitor(java.util.List<GraphQLTypeVisitor> visitors)

Method Detail

visitGraphQLAppliedDirective

public TraversalControl visitGraphQLAppliedDirective(GraphQLAppliedDirective node,
                                                     TraverserContext<GraphQLSchemaElement> context)

Description copied from interface: GraphQLTypeVisitor

This method will be called when a directive is applied to a schema element. The TraverserContext.getParentNode() will be the schema element that this is applied to. The graphql-java code base is trying to slowly move away from using GraphQLDirectives when they really should be GraphQLAppliedDirectives

Specified by:

visitGraphQLAppliedDirective in interface GraphQLTypeVisitor

Parameters:

node - the applied directive

context - the traversal context

Returns:

how to control the visitation processing

visitGraphQLAppliedDirectiveArgument

public TraversalControl visitGraphQLAppliedDirectiveArgument(GraphQLAppliedDirectiveArgument node,
                                                             TraverserContext<GraphQLSchemaElement> context)

Specified by:

visitGraphQLAppliedDirectiveArgument in interface GraphQLTypeVisitor

visitGraphQLArgument

public TraversalControl visitGraphQLArgument(GraphQLArgument node,
                                             TraverserContext<GraphQLSchemaElement> context)

Specified by:

visitGraphQLArgument in interface GraphQLTypeVisitor

visitGraphQLInterfaceType

public TraversalControl visitGraphQLInterfaceType(GraphQLInterfaceType node,
                                                  TraverserContext<GraphQLSchemaElement> context)

Specified by:

visitGraphQLInterfaceType in interface GraphQLTypeVisitor

visitGraphQLEnumType

public TraversalControl visitGraphQLEnumType(GraphQLEnumType node,
                                             TraverserContext<GraphQLSchemaElement> context)

Specified by:

visitGraphQLEnumType in interface GraphQLTypeVisitor

visitGraphQLEnumValueDefinition

public TraversalControl visitGraphQLEnumValueDefinition(GraphQLEnumValueDefinition node,
                                                        TraverserContext<GraphQLSchemaElement> context)

Specified by:

visitGraphQLEnumValueDefinition in interface GraphQLTypeVisitor

visitGraphQLFieldDefinition

public TraversalControl visitGraphQLFieldDefinition(GraphQLFieldDefinition node,
                                                    TraverserContext<GraphQLSchemaElement> context)

Specified by:

visitGraphQLFieldDefinition in interface GraphQLTypeVisitor

visitGraphQLDirective

public TraversalControl visitGraphQLDirective(GraphQLDirective node,
                                              TraverserContext<GraphQLSchemaElement> context)

Description copied from interface: GraphQLTypeVisitor

This method will be called twice. Once for a directive definition in a schema and then do each time a directive is applied to a schema element When it's applied to a schema element then TraverserContext.getParentNode() will be the schema element that this is applied to. The graphql-java code base is trying to slowly move away from using GraphQLDirectives when they really should be GraphQLAppliedDirectives and this is another place that has been left in. In the future this behavior will change and this will only visit directive definitions of a schema, not where they are applied.

Specified by:

visitGraphQLDirective in interface GraphQLTypeVisitor

Parameters:

node - the directive

context - the traversal context

Returns:

how to control the visitation processing

visitGraphQLInputObjectField

public TraversalControl visitGraphQLInputObjectField(GraphQLInputObjectField node,
                                                     TraverserContext<GraphQLSchemaElement> context)

Specified by:

visitGraphQLInputObjectField in interface GraphQLTypeVisitor

visitGraphQLInputObjectType

public TraversalControl visitGraphQLInputObjectType(GraphQLInputObjectType node,
                                                    TraverserContext<GraphQLSchemaElement> context)

Specified by:

visitGraphQLInputObjectType in interface GraphQLTypeVisitor

visitGraphQLList

public TraversalControl visitGraphQLList(GraphQLList node,
                                         TraverserContext<GraphQLSchemaElement> context)

Specified by:

visitGraphQLList in interface GraphQLTypeVisitor

visitGraphQLNonNull

public TraversalControl visitGraphQLNonNull(GraphQLNonNull node,
                                            TraverserContext<GraphQLSchemaElement> context)

Specified by:

visitGraphQLNonNull in interface GraphQLTypeVisitor

visitGraphQLObjectType

public TraversalControl visitGraphQLObjectType(GraphQLObjectType node,
                                               TraverserContext<GraphQLSchemaElement> context)

Specified by:

visitGraphQLObjectType in interface GraphQLTypeVisitor

visitGraphQLScalarType

public TraversalControl visitGraphQLScalarType(GraphQLScalarType node,
                                               TraverserContext<GraphQLSchemaElement> context)

Specified by:

visitGraphQLScalarType in interface GraphQLTypeVisitor

visitGraphQLTypeReference

public TraversalControl visitGraphQLTypeReference(GraphQLTypeReference node,
                                                  TraverserContext<GraphQLSchemaElement> context)

Specified by:

visitGraphQLTypeReference in interface GraphQLTypeVisitor

visitGraphQLUnionType

public TraversalControl visitGraphQLUnionType(GraphQLUnionType node,
                                              TraverserContext<GraphQLSchemaElement> context)

Specified by:

visitGraphQLUnionType in interface GraphQLTypeVisitor

visitBackRef

public TraversalControl visitBackRef(TraverserContext<GraphQLSchemaElement> context)

Description copied from interface: GraphQLTypeVisitor

Called when a node is visited more than once within a context. TraverserContext.thisNode() contains the node

Specified by:

visitBackRef in interface GraphQLTypeVisitor

Parameters:

context - the traversal context

Returns:

by default CONTINUE

visitGraphQLModifiedType

public TraversalControl visitGraphQLModifiedType(GraphQLModifiedType node,
                                                 TraverserContext<GraphQLSchemaElement> context)

Specified by:

visitGraphQLModifiedType in interface GraphQLTypeVisitor

visitGraphQLCompositeType

public TraversalControl visitGraphQLCompositeType(GraphQLCompositeType node,
                                                  TraverserContext<GraphQLSchemaElement> context)

Specified by:

visitGraphQLCompositeType in interface GraphQLTypeVisitor

visitGraphQLDirectiveContainer

public TraversalControl visitGraphQLDirectiveContainer(GraphQLDirectiveContainer node,
                                                       TraverserContext<GraphQLSchemaElement> context)

Specified by:

visitGraphQLDirectiveContainer in interface GraphQLTypeVisitor

visitGraphQLFieldsContainer

public TraversalControl visitGraphQLFieldsContainer(GraphQLFieldsContainer node,
                                                    TraverserContext<GraphQLSchemaElement> context)

Specified by:

visitGraphQLFieldsContainer in interface GraphQLTypeVisitor

visitGraphQLInputFieldsContainer

public TraversalControl visitGraphQLInputFieldsContainer(GraphQLInputFieldsContainer node,
                                                         TraverserContext<GraphQLSchemaElement> context)

Specified by:

visitGraphQLInputFieldsContainer in interface GraphQLTypeVisitor

visitGraphQLInputType

public TraversalControl visitGraphQLInputType(GraphQLInputType node,
                                              TraverserContext<GraphQLSchemaElement> context)

Specified by:

visitGraphQLInputType in interface GraphQLTypeVisitor

visitGraphQLNullableType

public TraversalControl visitGraphQLNullableType(GraphQLNullableType node,
                                                 TraverserContext<GraphQLSchemaElement> context)

Specified by:

visitGraphQLNullableType in interface GraphQLTypeVisitor

visitGraphQLOutputType

public TraversalControl visitGraphQLOutputType(GraphQLOutputType node,
                                               TraverserContext<GraphQLSchemaElement> context)

Specified by:

visitGraphQLOutputType in interface GraphQLTypeVisitor

visitGraphQLUnmodifiedType

public TraversalControl visitGraphQLUnmodifiedType(GraphQLUnmodifiedType node,
                                                   TraverserContext<GraphQLSchemaElement> context)

Specified by:

visitGraphQLUnmodifiedType in interface GraphQLTypeVisitor

changeNode

public TraversalControl changeNode(TraverserContext<GraphQLSchemaElement> context,
                                   GraphQLSchemaElement newChangedNode)

Description copied from interface: GraphQLTypeVisitor

This helper method can be used to "change" a node when returning control from this visitor

Specified by:

changeNode in interface GraphQLTypeVisitor

Parameters:

context - the current traversal context

newChangedNode - the new to be changed at this place

Returns:

this will always sent back TraversalControl.CONTINUE

deleteNode

public TraversalControl deleteNode(TraverserContext<GraphQLSchemaElement> context)

Description copied from interface: GraphQLTypeVisitor

This helper method can be used to "delete" the current node when returning control from this visitor

Specified by:

deleteNode in interface GraphQLTypeVisitor

Parameters:

context - the current traversal context which is pointing to the current node to be deleted

Returns:

this will always sent back TraversalControl.CONTINUE

insertAfter

public TraversalControl insertAfter(TraverserContext<GraphQLSchemaElement> context,
                                    GraphQLSchemaElement toInsertAfter)

Description copied from interface: GraphQLTypeVisitor

This helper method can be used to "insert a new node" AFTER the current node when returning control from this visitor

Specified by:

insertAfter in interface GraphQLTypeVisitor

Parameters:

context - the current traversal context

toInsertAfter - the new to be inserted AFTER this current code

Returns:

this will always sent back TraversalControl.CONTINUE

insertBefore

public TraversalControl insertBefore(TraverserContext<GraphQLSchemaElement> context,
                                     GraphQLSchemaElement toInsertBefore)

Description copied from interface: GraphQLTypeVisitor

This helper method can be used to "insert a new node" BEFORE the current node when returning control from this visitor

Specified by:

insertBefore in interface GraphQLTypeVisitor

Parameters:

context - the current traversal context

toInsertBefore - the new to be inserted BEFORE this current code

Returns:

this will always sent back TraversalControl.CONTINUE