graphql.schema

Class GraphQLDirective

java.lang.Object

graphql.schema.GraphQLDirective

All Implemented Interfaces:

GraphQLType

@PublicApi
public class GraphQLDirective
extends java.lang.Object
implements GraphQLType

A directive can be used to modify the behavior of a graphql field or type. See http://graphql.org/learn/queries/#directives for more details on the concept.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GraphQLDirective.Builder

Constructor Summary

Constructors

Constructor and Description
GraphQLDirective(java.lang.String name, java.lang.String description, java.util.EnumSet<Introspection.DirectiveLocation> locations, java.util.List<GraphQLArgument> arguments, boolean onOperation, boolean onFragment, boolean onField)

Method Summary

Modifier and Type	Method and Description
TraversalControl	accept(TraverserContext<GraphQLType> context, GraphQLTypeVisitor visitor) Double-dispatch entry point.
GraphQLArgument	getArgument(java.lang.String name)
java.util.List<GraphQLArgument>	getArguments()
java.util.List<GraphQLType>	getChildren()
java.lang.String	getDescription()
java.lang.String	getName()
boolean	isOnField() Deprecated. Use validLocations()
boolean	isOnFragment() Deprecated. Use validLocations()
boolean	isOnOperation() Deprecated. Use validLocations()
static GraphQLDirective.Builder	newDirective()
static GraphQLDirective.Builder	newDirective(GraphQLDirective existing)
java.lang.String	toString()
GraphQLDirective	transform(java.util.function.Consumer<GraphQLDirective.Builder> builderConsumer) This helps you transform the current GraphQLDirective into another one by starting a builder with all the current values and allows you to transform it how you want.
java.util.EnumSet<Introspection.DirectiveLocation>	validLocations()

Methods inherited from class java.lang.Object

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

Constructor Detail

GraphQLDirective

public GraphQLDirective(java.lang.String name,
                        java.lang.String description,
                        java.util.EnumSet<Introspection.DirectiveLocation> locations,
                        java.util.List<GraphQLArgument> arguments,
                        boolean onOperation,
                        boolean onFragment,
                        boolean onField)

Method Detail

getName

public java.lang.String getName()

Specified by:

getName in interface GraphQLType

Returns:

the name of the type which MUST fit within the regular expression [_A-Za-z][_0-9A-Za-z]*

getArguments

public java.util.List<GraphQLArgument> getArguments()

getArgument

public GraphQLArgument getArgument(java.lang.String name)

validLocations

public java.util.EnumSet<Introspection.DirectiveLocation> validLocations()

isOnOperation

@Deprecated
public boolean isOnOperation()

Deprecated. Use validLocations()

Returns:

onOperation

isOnFragment

@Deprecated
public boolean isOnFragment()

Deprecated. Use validLocations()

Returns:

onFragment

isOnField

@Deprecated
public boolean isOnField()

Deprecated. Use validLocations()

Returns:

onField

getDescription

public java.lang.String getDescription()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

transform

public GraphQLDirective transform(java.util.function.Consumer<GraphQLDirective.Builder> builderConsumer)

This helps you transform the current GraphQLDirective into another one by starting a builder with all the current values and allows you to transform it how you want.

Parameters:

builderConsumer - the consumer code that will be given a builder to transform

Returns:

a new field based on calling build on that builder

accept

public TraversalControl accept(TraverserContext<GraphQLType> context,
                               GraphQLTypeVisitor visitor)

Description copied from interface: GraphQLType

Double-dispatch entry point. It allows to travers a given non-trivial graphQL type and move from root to nested or enclosed types. This implements similar pattern as Node, see accept(...) for more details about the pattern.

Specified by:

accept in interface GraphQLType

Parameters:

context - TraverserContext bound to this graphQL type object

visitor - Visitor instance that performs actual processing on the types(s)

Returns:

Result of Visitor's operation. Note! Visitor's operation might return special results to control traversal process.

getChildren

public java.util.List<GraphQLType> getChildren()

Specified by:

getChildren in interface GraphQLType

Returns:

returns all types directly associated with this node

newDirective

public static GraphQLDirective.Builder newDirective()

newDirective

public static GraphQLDirective.Builder newDirective(GraphQLDirective existing)