Interface QueryVisitorFieldEnvironment

All Known Implementing Classes:

QueryVisitorFieldEnvironmentImpl

@PublicApi
@NullMarked
public interface QueryVisitorFieldEnvironment

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	getArguments()
Field	getField()
GraphQLFieldDefinition	getFieldDefinition()
GraphQLFieldsContainer	getFieldsContainer()
@Nullable QueryVisitorFieldEnvironment	getParentEnvironment()
GraphQLOutputType	getParentType()
GraphQLSchema	getSchema()
@Nullable SelectionSetContainer<?>	getSelectionSetContainer()
TraverserContext<Node>	getTraverserContext()
boolean	isTypeNameIntrospectionField()

Method Details

getSchema

GraphQLSchema getSchema()

Returns:

the graphql schema in play

isTypeNameIntrospectionField

boolean isTypeNameIntrospectionField()

Returns:

true if the current field is __typename

getField

Field getField()

Returns:

the current Field

getFieldDefinition

GraphQLFieldDefinition getFieldDefinition()

getParentType

GraphQLOutputType getParentType()

Returns:

the parent output type of the current field.

getFieldsContainer

GraphQLFieldsContainer getFieldsContainer()

Returns:

the unmodified fields container fot the current type. This is the unwrapped version of getParentType() It is either GraphQLObjectType or GraphQLInterfaceType. because these are the only GraphQLFieldsContainer

Throws:

IllegalStateException - if the current field is __typename see isTypeNameIntrospectionField()

getParentEnvironment

@Nullable QueryVisitorFieldEnvironment getParentEnvironment()

getArguments

Map<String,Object> getArguments()

getSelectionSetContainer

@Nullable SelectionSetContainer<?> getSelectionSetContainer()

getTraverserContext

TraverserContext<Node> getTraverserContext()