Package graphql.schema

Class SchemaTraverser

java.lang.Object

graphql.schema.SchemaTraverser

@PublicApi
public class SchemaTraverser
extends Object

Constructor Summary

Constructors

Constructor	Description
SchemaTraverser()
SchemaTraverser(Function<? super GraphQLSchemaElement,? extends List<GraphQLSchemaElement>> getChildren)

Method Summary

Modifier and Type	Method	Description
TraverserResult	depthFirst(GraphQLTypeVisitor graphQLTypeVisitor, GraphQLSchemaElement root)
TraverserResult	depthFirst(GraphQLTypeVisitor graphQLTypeVisitor, Collection<? extends GraphQLSchemaElement> roots)
TraverserResult	depthFirst(Traverser<GraphQLSchemaElement> traverser, graphql.schema.SchemaTraverser.TraverserDelegateVisitor traverserDelegateVisitor, Collection<? extends GraphQLSchemaElement> roots)
TraverserResult	depthFirstFullSchema(GraphQLTypeVisitor typeVisitor, GraphQLSchema schema)	This will visit all of the schema elements in the specified schema and invokes the visitor.
TraverserResult	depthFirstFullSchema(List<GraphQLTypeVisitor> typeVisitors, GraphQLSchema schema, Map<Class<?>,Object> rootVars)	This will visit all of the schema elements in the specified schema, invoking each visitor in turn.

Methods inherited from class java.lang.Object

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

Constructor Details

SchemaTraverser

public SchemaTraverser(Function<? super GraphQLSchemaElement,? extends List<GraphQLSchemaElement>> getChildren)

SchemaTraverser

public SchemaTraverser()

Method Details

depthFirstFullSchema

public TraverserResult depthFirstFullSchema(GraphQLTypeVisitor typeVisitor,
 GraphQLSchema schema)

This will visit all of the schema elements in the specified schema and invokes the visitor.

Parameters:

typeVisitor - a list of visitors to use

schema - the schema to visit

Returns:

a traversal result

depthFirstFullSchema

public TraverserResult depthFirstFullSchema(List<GraphQLTypeVisitor> typeVisitors,
 GraphQLSchema schema,
 Map<Class<?>,Object> rootVars)

This will visit all of the schema elements in the specified schema, invoking each visitor in turn.

Parameters:

typeVisitors - a list of visitors to use

schema - the schema to visit

rootVars - this sets up variables to be made available to the TraverserContext. This can be empty but not null

Returns:

a traversal result

depthFirst

public TraverserResult depthFirst(GraphQLTypeVisitor graphQLTypeVisitor,
 GraphQLSchemaElement root)

depthFirst

public TraverserResult depthFirst(GraphQLTypeVisitor graphQLTypeVisitor,
 Collection<? extends GraphQLSchemaElement> roots)

depthFirst

public TraverserResult depthFirst(Traverser<GraphQLSchemaElement> traverser,
 graphql.schema.SchemaTraverser.TraverserDelegateVisitor traverserDelegateVisitor,
 Collection<? extends GraphQLSchemaElement> roots)