Package graphql.execution.directives

Class QueryAppliedDirective

java.lang.Object

graphql.execution.directives.QueryAppliedDirective

@PublicApi
public class QueryAppliedDirective
extends Object

An applied directive represents the instance of a directive that is applied to a query element such as a field or fragment.

Originally graphql-java re-used the GraphQLDirective and GraphQLArgument classes to do both purposes. This was a modelling mistake. New QueryAppliedDirective and QueryAppliedDirectiveArgument classes have been introduced to better model when a directive is applied to a query element, as opposed to its schema definition itself.

See https://graphql.org/learn/queries/#directives for more details on the concept.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	QueryAppliedDirective.Builder

Method Summary

Modifier and Type	Method	Description
@Nullable QueryAppliedDirectiveArgument	getArgument(String name)
List<QueryAppliedDirectiveArgument>	getArguments()
@Nullable Directive	getDefinition()
@Nullable String	getDescription()
@NonNull String	getName()
static QueryAppliedDirective.Builder	newDirective()
static QueryAppliedDirective.Builder	newDirective(QueryAppliedDirective existing)
String	toString()
QueryAppliedDirective	transform(Consumer<QueryAppliedDirective.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.

Methods inherited from class java.lang.Object

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

Method Details

getName

public @NonNull String getName()

getDescription

public @Nullable String getDescription()

getArguments

public List<QueryAppliedDirectiveArgument> getArguments()

getArgument

public @Nullable QueryAppliedDirectiveArgument getArgument(String name)

getDefinition

public @Nullable Directive getDefinition()

toString

public String toString()

Overrides:

toString in class Object

transform

public QueryAppliedDirective transform(Consumer<QueryAppliedDirective.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

newDirective

public static QueryAppliedDirective.Builder newDirective()

newDirective

public static QueryAppliedDirective.Builder newDirective(QueryAppliedDirective existing)