graphql

Class GraphQL

java.lang.Object

graphql.GraphQL

@PublicApi
public class GraphQL
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GraphQL.Builder

Constructor Summary

Constructors

Constructor and Description
GraphQL(GraphQLSchema graphQLSchema) Deprecated. use the newGraphQL(GraphQLSchema) builder instead. This will be removed in a future version.
GraphQL(GraphQLSchema graphQLSchema, ExecutionStrategy queryStrategy) Deprecated. use the newGraphQL(GraphQLSchema) builder instead. This will be removed in a future version.
GraphQL(GraphQLSchema graphQLSchema, ExecutionStrategy queryStrategy, ExecutionStrategy mutationStrategy) Deprecated. use the newGraphQL(GraphQLSchema) builder instead. This will be removed in a future version.
GraphQL(GraphQLSchema graphQLSchema, ExecutionStrategy queryStrategy, ExecutionStrategy mutationStrategy, ExecutionStrategy subscriptionStrategy) Deprecated. use the newGraphQL(GraphQLSchema) builder instead. This will be removed in a future version.

Method Summary

Modifier and Type	Method and Description
ExecutionResult	execute(ExecutionInput.Builder executionInputBuilder) Executes the graphql query using the provided input object builder
ExecutionResult	execute(ExecutionInput executionInput) Executes the graphql query using the provided input object
ExecutionResult	execute(java.lang.String query) Executes the specified graphql query/mutation/subscription
ExecutionResult	execute(java.lang.String query, java.lang.Object context) Deprecated. Use execute(ExecutionInput)
ExecutionResult	execute(java.lang.String query, java.lang.Object context, java.util.Map<java.lang.String,java.lang.Object> variables) Deprecated. Use execute(ExecutionInput)
ExecutionResult	execute(java.lang.String query, java.lang.String operationName, java.lang.Object context) Deprecated. Use execute(ExecutionInput)
ExecutionResult	execute(java.lang.String query, java.lang.String operationName, java.lang.Object context, java.util.Map<java.lang.String,java.lang.Object> variables) Deprecated. Use execute(ExecutionInput)
ExecutionResult	execute(java.util.function.UnaryOperator<ExecutionInput.Builder> builderFunction) Executes the graphql query using calling the builder function and giving it a new builder.
java.util.concurrent.CompletableFuture<ExecutionResult>	executeAsync(ExecutionInput.Builder executionInputBuilder) Executes the graphql query using the provided input object builder
java.util.concurrent.CompletableFuture<ExecutionResult>	executeAsync(ExecutionInput executionInput) Executes the graphql query using the provided input object
java.util.concurrent.CompletableFuture<ExecutionResult>	executeAsync(java.util.function.UnaryOperator<ExecutionInput.Builder> builderFunction) Executes the graphql query using the provided input object builder
static GraphQL.Builder	newGraphQL(GraphQLSchema graphQLSchema) Helps you build a GraphQL object ready to execute queries

Methods inherited from class java.lang.Object

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

Constructor Detail

GraphQL

public GraphQL(GraphQLSchema graphQLSchema)

Deprecated. use the newGraphQL(GraphQLSchema) builder instead. This will be removed in a future version.

A GraphQL object ready to execute queries

Parameters:

graphQLSchema - the schema to use

GraphQL

public GraphQL(GraphQLSchema graphQLSchema,
               ExecutionStrategy queryStrategy)

Deprecated. use the newGraphQL(GraphQLSchema) builder instead. This will be removed in a future version.

A GraphQL object ready to execute queries

Parameters:

graphQLSchema - the schema to use

queryStrategy - the query execution strategy to use

GraphQL

public GraphQL(GraphQLSchema graphQLSchema,
               ExecutionStrategy queryStrategy,
               ExecutionStrategy mutationStrategy)

Deprecated. use the newGraphQL(GraphQLSchema) builder instead. This will be removed in a future version.

A GraphQL object ready to execute queries

Parameters:

graphQLSchema - the schema to use

queryStrategy - the query execution strategy to use

mutationStrategy - the mutation execution strategy to use

GraphQL

public GraphQL(GraphQLSchema graphQLSchema,
               ExecutionStrategy queryStrategy,
               ExecutionStrategy mutationStrategy,
               ExecutionStrategy subscriptionStrategy)

Deprecated. use the newGraphQL(GraphQLSchema) builder instead. This will be removed in a future version.

A GraphQL object ready to execute queries

Parameters:

graphQLSchema - the schema to use

queryStrategy - the query execution strategy to use

mutationStrategy - the mutation execution strategy to use

subscriptionStrategy - the subscription execution strategy to use

Method Detail

newGraphQL

public static GraphQL.Builder newGraphQL(GraphQLSchema graphQLSchema)

Helps you build a GraphQL object ready to execute queries

Parameters:

graphQLSchema - the schema to use

Returns:

a builder of GraphQL objects

execute

public ExecutionResult execute(java.lang.String query)

Executes the specified graphql query/mutation/subscription

Parameters:

query - the query/mutation/subscription

Returns:

an ExecutionResult which can include errors

execute

@Deprecated
public ExecutionResult execute(java.lang.String query,
                                           java.lang.Object context)

Deprecated. Use execute(ExecutionInput)

Info: This sets context = root to be backwards compatible.

Parameters:

query - the query/mutation/subscription

context - custom object provided to each DataFetcher

Returns:

an ExecutionResult which can include errors

execute

@Deprecated
public ExecutionResult execute(java.lang.String query,
                                           java.lang.String operationName,
                                           java.lang.Object context)

Deprecated. Use execute(ExecutionInput)

Info: This sets context = root to be backwards compatible.

Parameters:

query - the query/mutation/subscription

operationName - the name of the operation to execute

context - custom object provided to each DataFetcher

Returns:

an ExecutionResult which can include errors

execute

@Deprecated
public ExecutionResult execute(java.lang.String query,
                                           java.lang.Object context,
                                           java.util.Map<java.lang.String,java.lang.Object> variables)

Deprecated. Use execute(ExecutionInput)

Info: This sets context = root to be backwards compatible.

Parameters:

query - the query/mutation/subscription

context - custom object provided to each DataFetcher

variables - variable values uses as argument

Returns:

an ExecutionResult which can include errors

execute

@Deprecated
public ExecutionResult execute(java.lang.String query,
                                           java.lang.String operationName,
                                           java.lang.Object context,
                                           java.util.Map<java.lang.String,java.lang.Object> variables)

Deprecated. Use execute(ExecutionInput)

Info: This sets context = root to be backwards compatible.

Parameters:

query - the query/mutation/subscription

operationName - name of the operation to execute

context - custom object provided to each DataFetcher

variables - variable values uses as argument

Returns:

an ExecutionResult which can include errors

execute

public ExecutionResult execute(ExecutionInput.Builder executionInputBuilder)

Executes the graphql query using the provided input object builder

Parameters:

executionInputBuilder - ExecutionInput.Builder

Returns:

an ExecutionResult which can include errors

execute

public ExecutionResult execute(java.util.function.UnaryOperator<ExecutionInput.Builder> builderFunction)

Executes the graphql query using calling the builder function and giving it a new builder.

This allows a lambda style like :

 
    ExecutionResult result = graphql.execute(input -> input.query("{hello}").root(startingObj).context(contextObj));
 
 

Parameters:

builderFunction - a function that is given a ExecutionInput.Builder

Returns:

an ExecutionResult which can include errors

execute

public ExecutionResult execute(ExecutionInput executionInput)

Executes the graphql query using the provided input object

Parameters:

executionInput - ExecutionInput

Returns:

an ExecutionResult which can include errors

executeAsync

public java.util.concurrent.CompletableFuture<ExecutionResult> executeAsync(ExecutionInput.Builder executionInputBuilder)

Executes the graphql query using the provided input object builder

This will return a promise (aka CompletableFuture) to provide a ExecutionResult which is the result of executing the provided query.

Parameters:

executionInputBuilder - ExecutionInput.Builder

Returns:

a promise to an ExecutionResult which can include errors

executeAsync

public java.util.concurrent.CompletableFuture<ExecutionResult> executeAsync(java.util.function.UnaryOperator<ExecutionInput.Builder> builderFunction)

Executes the graphql query using the provided input object builder

This will return a promise (aka CompletableFuture) to provide a ExecutionResult which is the result of executing the provided query.

This allows a lambda style like :

 
    ExecutionResult result = graphql.execute(input -> input.query("{hello}").root(startingObj).context(contextObj));
 
 

Parameters:

builderFunction - a function that is given a ExecutionInput.Builder

Returns:

a promise to an ExecutionResult which can include errors

executeAsync

public java.util.concurrent.CompletableFuture<ExecutionResult> executeAsync(ExecutionInput executionInput)

Executes the graphql query using the provided input object

This will return a promise (aka CompletableFuture) to provide a ExecutionResult which is the result of executing the provided query.

Parameters:

executionInput - ExecutionInput

Returns:

a promise to an ExecutionResult which can include errors