Package graphql.schema

Class SchemaTransformer

java.lang.Object

graphql.schema.SchemaTransformer

@PublicApi
public class SchemaTransformer
extends java.lang.Object

Transforms a GraphQLSchema object by calling bac on a provided visitor.

To change a GraphQLSchemaElement node in the schema you need to return GraphQLTypeVisitor.changeNode(TraverserContext, GraphQLSchemaElement) which instructs the schema transformer to change that element upon leaving that visitor method.

 
  public TraversalControl visitGraphQLObjectType(GraphQLObjectType objectType, TraverserContext<GraphQLSchemaElement> context) {
      GraphQLObjectType newObjectType = mkSomeNewNode(objectType);
      return changeNode(context, newObjectType);
  }
  
 

To delete an element use GraphQLTypeVisitor.deleteNode(TraverserContext)

 
  public TraversalControl visitGraphQLObjectType(GraphQLObjectType objectType, TraverserContext<GraphQLSchemaElement> context) {
      return deleteNode(context, objectType);
  }
  
 

To insert elements use either GraphQLTypeVisitor.insertAfter(TraverserContext, GraphQLSchemaElement) or GraphQLTypeVisitor.insertBefore(TraverserContext, GraphQLSchemaElement) which will insert the new node before or after the current node being visited

 
  public TraversalControl visitGraphQLObjectType(GraphQLObjectType objectType, TraverserContext<GraphQLSchemaElement> context) {
      GraphQLObjectType newObjectType = mkSomeNewNode();
      return insertAfter(context, newObjectType);
  }
  
 

Constructor Summary

Constructors

Constructor	Description
SchemaTransformer()

Method Summary

Modifier and Type	Method	Description
GraphQLSchema	transform(GraphQLSchema schema, GraphQLTypeVisitor visitor)
GraphQLSchema	transform(GraphQLSchema schema, GraphQLTypeVisitor visitor, java.util.function.Consumer<GraphQLSchema.Builder> postTransformation)
<T extends GraphQLSchemaElement> T	transform(T schemaElement, GraphQLTypeVisitor visitor)
static GraphQLSchema	transformSchema(GraphQLSchema schema, GraphQLTypeVisitor visitor)	Transforms a GraphQLSchema and returns a new GraphQLSchema object.
static GraphQLSchema	transformSchema(GraphQLSchema schema, GraphQLTypeVisitor visitor, java.util.function.Consumer<GraphQLSchema.Builder> postTransformation)	Transforms a GraphQLSchema and returns a new GraphQLSchema object.
static <T extends GraphQLSchemaElement> T	transformSchema(T schemaElement, GraphQLTypeVisitor visitor)	Transforms a GraphQLSchemaElement and returns a new element.

Methods inherited from class java.lang.Object

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

Constructor Detail

SchemaTransformer

public SchemaTransformer()

Method Detail

transformSchema

public static GraphQLSchema transformSchema(GraphQLSchema schema,
                                            GraphQLTypeVisitor visitor)

Transforms a GraphQLSchema and returns a new GraphQLSchema object.

Parameters:

schema - the schema to transform

visitor - the visitor call back

Returns:

a new GraphQLSchema instance.

transformSchema

public static GraphQLSchema transformSchema(GraphQLSchema schema,
                                            GraphQLTypeVisitor visitor,
                                            java.util.function.Consumer<GraphQLSchema.Builder> postTransformation)

Transforms a GraphQLSchema and returns a new GraphQLSchema object.

Parameters:

schema - the schema to transform

visitor - the visitor call back

postTransformation - a callback that can be as a final step to the schema

Returns:

a new GraphQLSchema instance.

transformSchema

public static <T extends GraphQLSchemaElement> T transformSchema(T schemaElement,
                                                                 GraphQLTypeVisitor visitor)

Transforms a GraphQLSchemaElement and returns a new element.

Type Parameters:

T - for two

Parameters:

schemaElement - the schema element to transform

visitor - the visitor call back

Returns:

a new GraphQLSchemaElement instance.

transform

public GraphQLSchema transform(GraphQLSchema schema,
                               GraphQLTypeVisitor visitor)

transform

public GraphQLSchema transform(GraphQLSchema schema,
                               GraphQLTypeVisitor visitor,
                               java.util.function.Consumer<GraphQLSchema.Builder> postTransformation)

transform

public <T extends GraphQLSchemaElement> T transform(T schemaElement,
                                                    GraphQLTypeVisitor visitor)