Package graphql.execution.instrumentation.parameters

Class InstrumentationFieldParameters

java.lang.Object

graphql.execution.instrumentation.parameters.InstrumentationFieldParameters

Direct Known Subclasses:

InstrumentationFieldFetchParameters

@PublicApi
public class InstrumentationFieldParameters
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 InstrumentationState	instrumentationState

Constructor Summary

Constructors

Constructor	Description
InstrumentationFieldParameters(ExecutionContext executionContext, Supplier<ExecutionStepInfo> executionStepInfo)
InstrumentationFieldParameters(ExecutionContext executionContext, Supplier<ExecutionStepInfo> executionStepInfo, InstrumentationState instrumentationState)

Method Summary

Modifier and Type	Method	Description
ExecutionContext	getExecutionContext()
ExecutionStepInfo	getExecutionStepInfo()
GraphQLFieldDefinition	getField()
<T extends InstrumentationState> T	getInstrumentationState()	Deprecated. state is now passed in direct to instrumentation methods
InstrumentationFieldParameters	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

instrumentationState

private final InstrumentationState instrumentationState

Constructor Details

InstrumentationFieldParameters

public InstrumentationFieldParameters(ExecutionContext executionContext,
 Supplier<ExecutionStepInfo> executionStepInfo)

InstrumentationFieldParameters

InstrumentationFieldParameters(ExecutionContext executionContext,
 Supplier<ExecutionStepInfo> executionStepInfo,
 InstrumentationState instrumentationState)

Method Details

withNewState

@Deprecated
public InstrumentationFieldParameters 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()

getField

public GraphQLFieldDefinition getField()

getExecutionStepInfo

public ExecutionStepInfo getExecutionStepInfo()

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)