Package graphql.execution

Class ExecutionStrategyParameters

java.lang.Object

graphql.execution.ExecutionStrategyParameters

@PublicApi
public class ExecutionStrategyParameters
extends java.lang.Object

The parameters that are passed to execution strategies

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ExecutionStrategyParameters.Builder

Method Summary

Modifier and Type	Method	Description
@Nullable DeferredCallContext	getDeferredCallContext()	Returns the deferred call context if we're in the scope of a deferred call.
ExecutionStepInfo	getExecutionStepInfo()
MergedField	getField()	This returns the current field in its query representations.
MergedSelectionSet	getFields()
java.lang.Object	getLocalContext()
NonNullableFieldValidator	getNonNullFieldValidator()
ExecutionStrategyParameters	getParent()
ResultPath	getPath()
java.lang.Object	getSource()
boolean	isInDeferredContext()	Returns true if we're in the scope of a deferred call.
static ExecutionStrategyParameters.Builder	newParameters()
static ExecutionStrategyParameters.Builder	newParameters(ExecutionStrategyParameters oldParameters)
java.lang.String	toString()
ExecutionStrategyParameters	transform(java.util.function.Consumer<ExecutionStrategyParameters.Builder> builderConsumer)

Methods inherited from class java.lang.Object

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

Method Detail

getExecutionStepInfo

public ExecutionStepInfo getExecutionStepInfo()

getSource

public java.lang.Object getSource()

getFields

public MergedSelectionSet getFields()

getNonNullFieldValidator

public NonNullableFieldValidator getNonNullFieldValidator()

getPath

public ResultPath getPath()

getLocalContext

public java.lang.Object getLocalContext()

getParent

public ExecutionStrategyParameters getParent()

getDeferredCallContext

@Nullable
public @Nullable DeferredCallContext getDeferredCallContext()

Returns the deferred call context if we're in the scope of a deferred call. A new DeferredCallContext is created for each @defer block, and is passed down to all fields within the deferred call.

     query {
        ... @defer {
            field1 {        # new DeferredCallContext created here
                field1a     # DeferredCallContext passed down to this field
            }
        }

        ... @defer {
            field2          # new DeferredCallContext created here
        }
     }
 

Returns:

the deferred call context or null if we're not in the scope of a deferred call

isInDeferredContext

public boolean isInDeferredContext()

Returns true if we're in the scope of a deferred call.

Returns:

true if we're in the scope of a deferred call

getField

public MergedField getField()

This returns the current field in its query representations.

Returns:

the current merged fields

transform

public ExecutionStrategyParameters transform(java.util.function.Consumer<ExecutionStrategyParameters.Builder> builderConsumer)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

newParameters

public static ExecutionStrategyParameters.Builder newParameters()

newParameters

public static ExecutionStrategyParameters.Builder newParameters(ExecutionStrategyParameters oldParameters)