Package graphql

Class Directives

java.lang.Object

graphql.Directives

@PublicApi
public class Directives
extends Object

The directives that are understood by graphql-java

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BOOLEAN
static final DirectiveDefinition	DEFER_DIRECTIVE_DEFINITION
static final GraphQLDirective	DeferDirective	The @defer directive can be used to defer sending data for a fragment until later in the query.
static final DirectiveDefinition	DEPRECATED_DIRECTIVE_DEFINITION
static final GraphQLDirective	DeprecatedDirective	The "deprecated" directive is special and is always available in a graphql schema
static final DirectiveDefinition	EXPERIMENTAL_DISABLE_ERROR_PROPAGATION_DIRECTIVE_DEFINITION
static final GraphQLDirective	ExperimentalDisableErrorPropagationDirective
static final DirectiveDefinition	INCLUDE_DIRECTIVE_DEFINITION
static final GraphQLDirective	IncludeDirective
static final String	NO_LONGER_SUPPORTED
static final DirectiveDefinition	ONE_OF_DIRECTIVE_DEFINITION
static final GraphQLDirective	OneOfDirective
static final DirectiveDefinition	SKIP_DIRECTIVE_DEFINITION
static final GraphQLDirective	SkipDirective
static final DirectiveDefinition	SPECIFIED_BY_DIRECTIVE_DEFINITION
static final GraphQLDirective	SpecifiedByDirective	The "specifiedBy" directive allows to provide a specification URL for a Scalar
static final String	STRING

Constructor Summary

Constructors

Constructor	Description
Directives()

Method Summary

Modifier and Type	Method	Description
static boolean	isExperimentalDisableErrorPropagationDirectiveEnabled()	This can be used to get the state the `@experimental_disableErrorPropagation` directive support on a JVM wide basis .
static void	setExperimentalDisableErrorPropagationEnabled(boolean flag)	This can be used to disable the `@experimental_disableErrorPropagation` directive support on a JVM wide basis in case your server implementation does NOT want to act on this directive ever.

Methods inherited from class java.lang.Object

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

Field Details

DEPRECATED_DIRECTIVE_DEFINITION

public static final DirectiveDefinition DEPRECATED_DIRECTIVE_DEFINITION

INCLUDE_DIRECTIVE_DEFINITION

public static final DirectiveDefinition INCLUDE_DIRECTIVE_DEFINITION

SKIP_DIRECTIVE_DEFINITION

public static final DirectiveDefinition SKIP_DIRECTIVE_DEFINITION

SPECIFIED_BY_DIRECTIVE_DEFINITION

public static final DirectiveDefinition SPECIFIED_BY_DIRECTIVE_DEFINITION

ONE_OF_DIRECTIVE_DEFINITION

@ExperimentalApi
public static final DirectiveDefinition ONE_OF_DIRECTIVE_DEFINITION

DEFER_DIRECTIVE_DEFINITION

@ExperimentalApi
public static final DirectiveDefinition DEFER_DIRECTIVE_DEFINITION

EXPERIMENTAL_DISABLE_ERROR_PROPAGATION_DIRECTIVE_DEFINITION

@ExperimentalApi
public static final DirectiveDefinition EXPERIMENTAL_DISABLE_ERROR_PROPAGATION_DIRECTIVE_DEFINITION

BOOLEAN

public static final String BOOLEAN

See Also:

• Constant Field Values

STRING

public static final String STRING

See Also:

• Constant Field Values

NO_LONGER_SUPPORTED

public static final String NO_LONGER_SUPPORTED

See Also:

• Constant Field Values

DeferDirective

@ExperimentalApi
public static final GraphQLDirective DeferDirective

The @defer directive can be used to defer sending data for a fragment until later in the query. This is an opt-in directive that is not available unless it is explicitly put into the schema.

This implementation is based on the state of Defer/Stream PR More specifically at the state of this commit

The execution behaviour should match what we get from running Apollo Server 4.9.5 with graphql-js v17.0.0-alpha.2

IncludeDirective

public static final GraphQLDirective IncludeDirective

SkipDirective

public static final GraphQLDirective SkipDirective

DeprecatedDirective

public static final GraphQLDirective DeprecatedDirective

The "deprecated" directive is special and is always available in a graphql schema

See the GraphQL specification for @deprecated

SpecifiedByDirective

public static final GraphQLDirective SpecifiedByDirective

The "specifiedBy" directive allows to provide a specification URL for a Scalar

OneOfDirective

@ExperimentalApi
public static final GraphQLDirective OneOfDirective

ExperimentalDisableErrorPropagationDirective

@ExperimentalApi
public static final GraphQLDirective ExperimentalDisableErrorPropagationDirective

Constructor Details

Directives

public Directives()

Method Details

isExperimentalDisableErrorPropagationDirectiveEnabled

public static boolean isExperimentalDisableErrorPropagationDirectiveEnabled()

This can be used to get the state the `@experimental_disableErrorPropagation` directive support on a JVM wide basis .

Returns:

true if the `@experimental_disableErrorPropagation` directive will be respected

setExperimentalDisableErrorPropagationEnabled

public static void setExperimentalDisableErrorPropagationEnabled(boolean flag)

This can be used to disable the `@experimental_disableErrorPropagation` directive support on a JVM wide basis in case your server implementation does NOT want to act on this directive ever.

Parameters:

flag - the desired state of the flag