Class Directives

src/main/java/graphql/Directives.java:42–333

The directives that are understood by graphql-java

 * The directives that are understood by graphql-java
 */
@PublicApi
@NullMarked
public class Directives {

    private static final String DEPRECATED = "deprecated";
    private static final String INCLUDE = "include";
    private static final String SKIP = "skip";
    private static final String SPECIFIED_BY = "specifiedBy";
    private static final String ONE_OF = "oneOf";
    private static final String DEFER = "defer";
    private static final String EXPERIMENTAL_DISABLE_ERROR_PROPAGATION = "experimental_disableErrorPropagation";

    public static final DirectiveDefinition DEPRECATED_DIRECTIVE_DEFINITION;
    public static final DirectiveDefinition INCLUDE_DIRECTIVE_DEFINITION;
    public static final DirectiveDefinition SKIP_DIRECTIVE_DEFINITION;
    public static final DirectiveDefinition SPECIFIED_BY_DIRECTIVE_DEFINITION;
    @ExperimentalApi
    public static final DirectiveDefinition ONE_OF_DIRECTIVE_DEFINITION;
    @ExperimentalApi
    public static final DirectiveDefinition DEFER_DIRECTIVE_DEFINITION;
    @ExperimentalApi
    public static final DirectiveDefinition EXPERIMENTAL_DISABLE_ERROR_PROPAGATION_DIRECTIVE_DEFINITION;

    public static final String BOOLEAN = "Boolean";
    public static final String STRING = "String";
    public static final String NO_LONGER_SUPPORTED = "No longer supported";

    static {
        DEPRECATED_DIRECTIVE_DEFINITION = DirectiveDefinition.newDirectiveDefinition()
                .name(DEPRECATED)
                .directiveLocation(newDirectiveLocation().name(FIELD_DEFINITION.name()).build())
                .directiveLocation(newDirectiveLocation().name(ENUM_VALUE.name()).build())
                .directiveLocation(newDirectiveLocation().name(ARGUMENT_DEFINITION.name()).build())
                .directiveLocation(newDirectiveLocation().name(INPUT_FIELD_DEFINITION.name()).build())
                .description(createDescription("Marks the field, argument, input field or enum value as deprecated"))
                .inputValueDefinition(
                        newInputValueDefinition()
                                .name("reason")
                                .description(createDescription("The reason for the deprecation"))
                                .type(newNonNullType(newTypeName().name(STRING).build()).build())
                                .defaultValue(StringValue.newStringValue().value(NO_LONGER_SUPPORTED).build())
                                .build())
                .build();

        INCLUDE_DIRECTIVE_DEFINITION = DirectiveDefinition.newDirectiveDefinition()
                .name(INCLUDE)
                .directiveLocation(newDirectiveLocation().name(FRAGMENT_SPREAD.name()).build())
                .directiveLocation(newDirectiveLocation().name(INLINE_FRAGMENT.name()).build())
                .directiveLocation(newDirectiveLocation().name(FIELD.name()).build())
                .description(createDescription("Directs the executor to include this field or fragment only when the `if` argument is true"))
                .inputValueDefinition(
                        newInputValueDefinition()
                                .name("if")
                                .description(createDescription("Included when true."))
                                .type(newNonNullType(newTypeName().name(BOOLEAN).build()).build())
                                .build())
                .build();