Package graphql.execution.instrumentation.parameters

Class InstrumentationFieldCompleteParameters

java.lang.Object

graphql.execution.instrumentation.parameters.InstrumentationFieldCompleteParameters

@PublicApi
public class InstrumentationFieldCompleteParameters
extends Object

Parameters sent to Instrumentation methods

Field Summary

Fields

Modifier and Type	Field	Description
private final ExecutionContext	executionContext
private final Supplier<ExecutionStepInfo>	executionStepInfo
private final ExecutionStrategyParameters	executionStrategyParameters
private final Object	fetchedValue
private final InstrumentationState	instrumentationState

Constructor Summary

Constructors

Constructor	Description
InstrumentationFieldCompleteParameters(ExecutionContext executionContext, ExecutionStrategyParameters executionStrategyParameters, Supplier<ExecutionStepInfo> executionStepInfo, Object fetchedValue)
InstrumentationFieldCompleteParameters(ExecutionContext executionContext, ExecutionStrategyParameters executionStrategyParameters, Supplier<ExecutionStepInfo> executionStepInfo, Object fetchedValue, InstrumentationState instrumentationState)

Method Summary

Modifier and Type	Method	Description
ExecutionContext	getExecutionContext()
ExecutionStepInfo	getExecutionStepInfo()
ExecutionStrategyParameters	getExecutionStrategyParameters()
Object	getFetchedValue()
GraphQLFieldDefinition	getField()
<T extends InstrumentationState> T	getInstrumentationState()	Deprecated. state is now passed in direct to instrumentation methods
ExecutionStepInfo	getTypeInfo()	Deprecated.
InstrumentationFieldCompleteParameters	withNewState(InstrumentationState instrumentationState)	Deprecated. state is now passed in direct to instrumentation methods

Methods inherited from class java.lang.Object

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

Field Details

executionContext

private final ExecutionContext executionContext

executionStepInfo

private final Supplier<ExecutionStepInfo> executionStepInfo

fetchedValue

private final Object fetchedValue

instrumentationState

private final InstrumentationState instrumentationState

executionStrategyParameters

private final ExecutionStrategyParameters executionStrategyParameters

Constructor Details

InstrumentationFieldCompleteParameters

public InstrumentationFieldCompleteParameters(ExecutionContext executionContext,
 ExecutionStrategyParameters executionStrategyParameters,
 Supplier<ExecutionStepInfo> executionStepInfo,
 Object fetchedValue)

InstrumentationFieldCompleteParameters

InstrumentationFieldCompleteParameters(ExecutionContext executionContext,
 ExecutionStrategyParameters executionStrategyParameters,
 Supplier<ExecutionStepInfo> executionStepInfo,
 Object fetchedValue,
 InstrumentationState instrumentationState)

Method Details

withNewState

@Deprecated
public InstrumentationFieldCompleteParameters withNewState(InstrumentationState instrumentationState)

Deprecated.

state is now passed in direct to instrumentation methods

Returns a cloned parameters object with the new state

Parameters:

instrumentationState - the new state for this parameters object

Returns:

a new parameters object with the new state

getExecutionContext

public ExecutionContext getExecutionContext()

getExecutionStrategyParameters

public ExecutionStrategyParameters getExecutionStrategyParameters()

getField

public GraphQLFieldDefinition getField()

getTypeInfo

@Deprecated
public ExecutionStepInfo getTypeInfo()

Deprecated.

getExecutionStepInfo

public ExecutionStepInfo getExecutionStepInfo()

getFetchedValue

public Object getFetchedValue()

getInstrumentationState

@Deprecated
public <T extends InstrumentationState> T getInstrumentationState()

Deprecated.

state is now passed in direct to instrumentation methods

Previously the instrumentation parameters had access to the state created via Instrumentation.createState(InstrumentationCreateStateParameters) but now to save object allocations, the state is passed directly into instrumentation methods

Type Parameters:

T - for two

Returns:

the state created previously during a call to Instrumentation.createState(InstrumentationCreateStateParameters)