Package graphql.normalized

Class ExecutableNormalizedOperationToAstCompiler

java.lang.Object

graphql.normalized.ExecutableNormalizedOperationToAstCompiler

@PublicApi
public class ExecutableNormalizedOperationToAstCompiler
extends java.lang.Object

This class can take a list of ExecutableNormalizedFields and compiling out a normalised operation Document that would represent how those fields may be executed.

This is essentially the reverse of ExecutableNormalizedOperationFactory which takes operation text and makes ExecutableNormalizedFields from it, this takes ExecutableNormalizedFields and makes operation text from it.

You could for example send that operation text onto to some other graphql server if it has the same schema as the one provided.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ExecutableNormalizedOperationToAstCompiler.CompilerResult	The result is a Document and a map of variables that would go with that document.

Constructor Summary

Constructors

Constructor	Description
ExecutableNormalizedOperationToAstCompiler()

Method Summary

Modifier and Type	Method	Description
static ExecutableNormalizedOperationToAstCompiler.CompilerResult	compileToDocument(@NotNull GraphQLSchema schema, OperationDefinition.Operation operationKind, @Nullable java.lang.String operationName, @NotNull java.util.List<ExecutableNormalizedField> topLevelFields, @NotNull java.util.Map<ExecutableNormalizedField,QueryDirectives> normalizedFieldToQueryDirectives, @Nullable VariablePredicate variablePredicate)	This will compile an operation text Document with possibly variables from the given ExecutableNormalizedFields
static ExecutableNormalizedOperationToAstCompiler.CompilerResult	compileToDocument(@NotNull GraphQLSchema schema, OperationDefinition.Operation operationKind, @Nullable java.lang.String operationName, @NotNull java.util.List<ExecutableNormalizedField> topLevelFields, @Nullable VariablePredicate variablePredicate)	This will compile an operation text Document with possibly variables from the given ExecutableNormalizedFields
static ExecutableNormalizedOperationToAstCompiler.CompilerResult	compileToDocumentWithDeferSupport(@NotNull GraphQLSchema schema, OperationDefinition.Operation operationKind, @Nullable java.lang.String operationName, @NotNull java.util.List<ExecutableNormalizedField> topLevelFields, @NotNull java.util.Map<ExecutableNormalizedField,QueryDirectives> normalizedFieldToQueryDirectives, @Nullable VariablePredicate variablePredicate)	This will compile an operation text Document with possibly variables from the given ExecutableNormalizedFields, with support for the experimental @defer directive.
static ExecutableNormalizedOperationToAstCompiler.CompilerResult	compileToDocumentWithDeferSupport(@NotNull GraphQLSchema schema, OperationDefinition.Operation operationKind, @Nullable java.lang.String operationName, @NotNull java.util.List<ExecutableNormalizedField> topLevelFields, @Nullable VariablePredicate variablePredicate)	This will compile an operation text Document with possibly variables from the given ExecutableNormalizedFields, with support for the experimental @defer directive.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExecutableNormalizedOperationToAstCompiler

public ExecutableNormalizedOperationToAstCompiler()

Method Detail

compileToDocument

public static ExecutableNormalizedOperationToAstCompiler.CompilerResult compileToDocument(@NotNull
                                                                                          @NotNull GraphQLSchema schema,
                                                                                          @NotNull
                                                                                          OperationDefinition.Operation operationKind,
                                                                                          @Nullable
                                                                                          @Nullable java.lang.String operationName,
                                                                                          @NotNull
                                                                                          @NotNull java.util.List<ExecutableNormalizedField> topLevelFields,
                                                                                          @Nullable
                                                                                          @Nullable VariablePredicate variablePredicate)

This will compile an operation text Document with possibly variables from the given ExecutableNormalizedFields

The VariablePredicate is used called to decide if the given argument values should be made into a variable OR inlined into the operation text as a graphql literal.

Parameters:

schema - the graphql schema to use

operationKind - the kind of operation

operationName - the name of the operation to use

topLevelFields - the top level ExecutableNormalizedFields to start from

variablePredicate - the variable predicate that decides if arguments turn into variables or not during compilation

Returns:

a ExecutableNormalizedOperationToAstCompiler.CompilerResult object

compileToDocument

public static ExecutableNormalizedOperationToAstCompiler.CompilerResult compileToDocument(@NotNull
                                                                                          @NotNull GraphQLSchema schema,
                                                                                          @NotNull
                                                                                          OperationDefinition.Operation operationKind,
                                                                                          @Nullable
                                                                                          @Nullable java.lang.String operationName,
                                                                                          @NotNull
                                                                                          @NotNull java.util.List<ExecutableNormalizedField> topLevelFields,
                                                                                          @NotNull
                                                                                          @NotNull java.util.Map<ExecutableNormalizedField,QueryDirectives> normalizedFieldToQueryDirectives,
                                                                                          @Nullable
                                                                                          @Nullable VariablePredicate variablePredicate)

This will compile an operation text Document with possibly variables from the given ExecutableNormalizedFields

The VariablePredicate is used called to decide if the given argument values should be made into a variable OR inlined into the operation text as a graphql literal.

Parameters:

schema - the graphql schema to use

operationKind - the kind of operation

operationName - the name of the operation to use

topLevelFields - the top level ExecutableNormalizedFields to start from

normalizedFieldToQueryDirectives - the map of normalized field to query directives

variablePredicate - the variable predicate that decides if arguments turn into variables or not during compilation

Returns:

a ExecutableNormalizedOperationToAstCompiler.CompilerResult object

compileToDocumentWithDeferSupport

@ExperimentalApi
public static ExecutableNormalizedOperationToAstCompiler.CompilerResult compileToDocumentWithDeferSupport(@NotNull
                                                                                                          @NotNull GraphQLSchema schema,
                                                                                                          @NotNull
                                                                                                          OperationDefinition.Operation operationKind,
                                                                                                          @Nullable
                                                                                                          @Nullable java.lang.String operationName,
                                                                                                          @NotNull
                                                                                                          @NotNull java.util.List<ExecutableNormalizedField> topLevelFields,
                                                                                                          @Nullable
                                                                                                          @Nullable VariablePredicate variablePredicate)

This will compile an operation text Document with possibly variables from the given ExecutableNormalizedFields, with support for the experimental @defer directive.

The VariablePredicate is used called to decide if the given argument values should be made into a variable OR inlined into the operation text as a graphql literal.

Parameters:

schema - the graphql schema to use

operationKind - the kind of operation

operationName - the name of the operation to use

topLevelFields - the top level ExecutableNormalizedFields to start from

variablePredicate - the variable predicate that decides if arguments turn into variables or not during compilation

Returns:

a ExecutableNormalizedOperationToAstCompiler.CompilerResult object

See Also:

compileToDocument(GraphQLSchema, OperationDefinition.Operation, String, List, VariablePredicate)

compileToDocumentWithDeferSupport

@ExperimentalApi
public static ExecutableNormalizedOperationToAstCompiler.CompilerResult compileToDocumentWithDeferSupport(@NotNull
                                                                                                          @NotNull GraphQLSchema schema,
                                                                                                          @NotNull
                                                                                                          OperationDefinition.Operation operationKind,
                                                                                                          @Nullable
                                                                                                          @Nullable java.lang.String operationName,
                                                                                                          @NotNull
                                                                                                          @NotNull java.util.List<ExecutableNormalizedField> topLevelFields,
                                                                                                          @NotNull
                                                                                                          @NotNull java.util.Map<ExecutableNormalizedField,QueryDirectives> normalizedFieldToQueryDirectives,
                                                                                                          @Nullable
                                                                                                          @Nullable VariablePredicate variablePredicate)

This will compile an operation text Document with possibly variables from the given ExecutableNormalizedFields, with support for the experimental @defer directive.

The VariablePredicate is used called to decide if the given argument values should be made into a variable OR inlined into the operation text as a graphql literal.

Parameters:

schema - the graphql schema to use

operationKind - the kind of operation

operationName - the name of the operation to use

topLevelFields - the top level ExecutableNormalizedFields to start from

normalizedFieldToQueryDirectives - the map of normalized field to query directives

variablePredicate - the variable predicate that decides if arguments turn into variables or not during compilation

Returns:

a ExecutableNormalizedOperationToAstCompiler.CompilerResult object

See Also:

compileToDocument(GraphQLSchema, OperationDefinition.Operation, String, List, Map, VariablePredicate)