graphql.schema

Class GraphQLDirective

java.lang.Object

graphql.schema.GraphQLDirective

All Implemented Interfaces:

GraphQLNamedSchemaElement, GraphQLSchemaElement

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

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

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CHILD_ARGUMENTS

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) Deprecated. Use the Builder

Method Summary

Modifier and Type	Method and Description
TraversalControl	accept(TraverserContext<GraphQLSchemaElement> context, GraphQLTypeVisitor visitor)
GraphQLArgument	getArgument(java.lang.String name)
java.util.List<GraphQLArgument>	getArguments()
java.util.List<GraphQLSchemaElement>	getChildren()
SchemaElementChildrenContainer	getChildrenWithTypeReferences()
DirectiveDefinition	getDefinition() The AST Node this schema element is based on.
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()
GraphQLDirective	withNewChildren(SchemaElementChildrenContainer newChildren)

Methods inherited from class java.lang.Object

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

Field Detail

CHILD_ARGUMENTS

public static final java.lang.String CHILD_ARGUMENTS

See Also:

Constant Field Values

Constructor Detail

GraphQLDirective

@Deprecated
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)

Deprecated. Use the Builder

Method Detail

getName

public java.lang.String getName()

Specified by:

getName in interface GraphQLNamedSchemaElement

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()

Specified by:

getDescription in interface GraphQLNamedSchemaElement

getDefinition

public DirectiveDefinition getDefinition()

Description copied from interface: GraphQLNamedSchemaElement

The AST Node this schema element is based on. Is null if the GraphQLSchema is not based on a SDL document. Some elements also have additional extension Nodes. See for example GraphQLObjectType.getExtensionDefinitions()

Specified by:

getDefinition in interface GraphQLNamedSchemaElement

Returns:

Node which this element is based on. Can be null.

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<GraphQLSchemaElement> context,
                               GraphQLTypeVisitor visitor)

Specified by:

accept in interface GraphQLSchemaElement

getChildren

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

Specified by:

getChildren in interface GraphQLSchemaElement

getChildrenWithTypeReferences

public SchemaElementChildrenContainer getChildrenWithTypeReferences()

Specified by:

getChildrenWithTypeReferences in interface GraphQLSchemaElement

withNewChildren

public GraphQLDirective withNewChildren(SchemaElementChildrenContainer newChildren)

Specified by:

withNewChildren in interface GraphQLSchemaElement

newDirective

public static GraphQLDirective.Builder newDirective()

newDirective

public static GraphQLDirective.Builder newDirective(GraphQLDirective existing)