Package graphql.schema.visitor

Class GraphQLSchemaVisitorEnvironmentImpl<T extends GraphQLSchemaElement>

java.lang.Object

graphql.schema.visitor.GraphQLSchemaVisitorEnvironmentImpl<T>

All Implemented Interfaces:

GraphQLSchemaVisitorEnvironment<T>

Direct Known Subclasses:

GraphQLSchemaVisitorAdapter.AppliedDirectiveArgumentEnv, GraphQLSchemaVisitorAdapter.AppliedDirectiveEnv, GraphQLSchemaVisitorAdapter.ArgumentEnv, GraphQLSchemaVisitorAdapter.DirectiveEnv, GraphQLSchemaVisitorAdapter.EnumTypeEnv, GraphQLSchemaVisitorAdapter.EnumValueDefinitionEnv, GraphQLSchemaVisitorAdapter.FieldDefinitionEnv, GraphQLSchemaVisitorAdapter.InputObjectFieldEnv, GraphQLSchemaVisitorAdapter.InputObjectTypeEnv, GraphQLSchemaVisitorAdapter.InterfaceTypeEnv, GraphQLSchemaVisitorAdapter.ObjectEnv, GraphQLSchemaVisitorAdapter.ScalarTypeEnv, GraphQLSchemaVisitorAdapter.SchemaElementEnv, GraphQLSchemaVisitorAdapter.UnionTypeEnv

class GraphQLSchemaVisitorEnvironmentImpl<T extends GraphQLSchemaElement>
extends Object
implements GraphQLSchemaVisitorEnvironment<T>

Field Summary

Fields

Modifier and Type	Field	Description
protected final TraverserContext<GraphQLSchemaElement>	context

Constructor Summary

Constructors

Constructor	Description
GraphQLSchemaVisitorEnvironmentImpl(TraverserContext<GraphQLSchemaElement> context)

Method Summary

Modifier and Type	Method	Description
private @NotNull List<GraphQLSchemaElement>	buildParentsImpl(Predicate<GraphQLSchemaElement> predicate)
GraphQLSchemaTraversalControl	changeNode(T schemaElement)	Called to change the current node to the specific node
GraphQLSchemaTraversalControl	deleteNode()	Called to delete the current node
GraphQLCodeRegistry.Builder	getCodeRegistry()	This will return a value if the visitation call was via SchemaTransformer
T	getElement()
List<GraphQLSchemaElement>	getLeadingElements()	This returns the schema element that led to this element, eg a field is contained in a type which is pointed to be another field say.
GraphQLSchema	getSchema()
List<GraphQLSchemaElement>	getUnwrappedLeadingElements()	This returns the schema element that led to this element but with GraphQLModifiedType wrappers removed.
GraphQLSchemaTraversalControl	insertAfter(T toInsertAfter)	Called to insert the current schema element after the specified schema element
GraphQLSchemaTraversalControl	insertBefore(T toInsertBefore)	Called to insert the current schema element before the specified schema element
GraphQLSchemaTraversalControl	ok()
GraphQLSchemaTraversalControl	quit()

Methods inherited from class java.lang.Object

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

Field Details

context

protected final TraverserContext<GraphQLSchemaElement> context

Constructor Details

GraphQLSchemaVisitorEnvironmentImpl

GraphQLSchemaVisitorEnvironmentImpl(TraverserContext<GraphQLSchemaElement> context)

Method Details

getSchema

public GraphQLSchema getSchema()

Specified by:

getSchema in interface GraphQLSchemaVisitorEnvironment<T extends GraphQLSchemaElement>

Returns:

the schema that is being visited upon

getCodeRegistry

public GraphQLCodeRegistry.Builder getCodeRegistry()

Description copied from interface: GraphQLSchemaVisitorEnvironment

This will return a value if the visitation call was via SchemaTransformer

Specified by:

getCodeRegistry in interface GraphQLSchemaVisitorEnvironment<T extends GraphQLSchemaElement>

Returns:

a code registry builder

getElement

public T getElement()

Specified by:

getElement in interface GraphQLSchemaVisitorEnvironment<T extends GraphQLSchemaElement>

Returns:

the element that is being visited

getLeadingElements

public List<GraphQLSchemaElement> getLeadingElements()

Description copied from interface: GraphQLSchemaVisitorEnvironment

This returns the schema element that led to this element, eg a field is contained in a type which is pointed to be another field say.

Specified by:

getLeadingElements in interface GraphQLSchemaVisitorEnvironment<T extends GraphQLSchemaElement>

Returns:

a list of schema elements leading to this current element

getUnwrappedLeadingElements

public List<GraphQLSchemaElement> getUnwrappedLeadingElements()

Description copied from interface: GraphQLSchemaVisitorEnvironment

This returns the schema element that led to this element but with GraphQLModifiedType wrappers removed.

Specified by:

getUnwrappedLeadingElements in interface GraphQLSchemaVisitorEnvironment<T extends GraphQLSchemaElement>

Returns:

a list of schema elements leading to this current element

buildParentsImpl

@NotNull
private @NotNull List<GraphQLSchemaElement> buildParentsImpl(Predicate<GraphQLSchemaElement> predicate)

ok

public GraphQLSchemaTraversalControl ok()

Specified by:

ok in interface GraphQLSchemaVisitorEnvironment<T extends GraphQLSchemaElement>

Returns:

When returned the traversal will continue as planned.

quit

public GraphQLSchemaTraversalControl quit()

Specified by:

quit in interface GraphQLSchemaVisitorEnvironment<T extends GraphQLSchemaElement>

Returns:

When returned from a GraphQLSchemaVisitor's method, indicates exiting the traversal.

changeNode

public GraphQLSchemaTraversalControl changeNode(T schemaElement)

Description copied from interface: GraphQLSchemaVisitorEnvironment

Called to change the current node to the specific node

Specified by:

changeNode in interface GraphQLSchemaVisitorEnvironment<T extends GraphQLSchemaElement>

Parameters:

schemaElement - the schema element to change

Returns:

a control that changes the current node to a the given node

deleteNode

public GraphQLSchemaTraversalControl deleteNode()

Description copied from interface: GraphQLSchemaVisitorEnvironment

Called to delete the current node

Specified by:

deleteNode in interface GraphQLSchemaVisitorEnvironment<T extends GraphQLSchemaElement>

Returns:

a control that deletes the current node

insertAfter

public GraphQLSchemaTraversalControl insertAfter(T toInsertAfter)

Description copied from interface: GraphQLSchemaVisitorEnvironment

Called to insert the current schema element after the specified schema element

Specified by:

insertAfter in interface GraphQLSchemaVisitorEnvironment<T extends GraphQLSchemaElement>

Parameters:

toInsertAfter - the schema element to after before

Returns:

a control that inserts the given node after the current node

insertBefore

public GraphQLSchemaTraversalControl insertBefore(T toInsertBefore)

Description copied from interface: GraphQLSchemaVisitorEnvironment

Called to insert the current schema element before the specified schema element

Specified by:

insertBefore in interface GraphQLSchemaVisitorEnvironment<T extends GraphQLSchemaElement>

Parameters:

toInsertBefore - the schema element to insert before

Returns:

a control that inserts the given node before the current node