graphql.schema

Interface GraphQLDirectiveContainer

All Superinterfaces:

GraphQLNamedSchemaElement, GraphQLSchemaElement

All Known Subinterfaces:

GraphQLInputValueDefinition

All Known Implementing Classes:

GraphQLArgument, GraphQLEnumType, GraphQLEnumValueDefinition, GraphQLFieldDefinition, GraphQLInputObjectField, GraphQLInputObjectType, GraphQLInterfaceType, GraphQLObjectType, GraphQLScalarType, GraphQLUnionType

@PublicApi
public interface GraphQLDirectiveContainer
extends GraphQLNamedSchemaElement

Represents a graphql runtime type that can have GraphQLDirective's.

Directives can be repeatable and (by default) non repeatable.

There are access methods here that get the two different types.

See Also:

DirectiveDefinition, DirectiveDefinition.isRepeatable()

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.util.List<GraphQLDirective>>	getAllDirectivesByName() This will return a Map of the all directives that are associated with a GraphQLNamedSchemaElement, including both repeatable and non repeatable directives.
GraphQLDirective	getDirective(java.lang.String directiveName) Returns a non repeatable directive with the provided name.
java.util.List<GraphQLDirective>	getDirectives() This will return a list of all the directives that have been put on GraphQLNamedSchemaElement as a flat list, which may contain repeatable and non repeatable directives.
default java.util.List<GraphQLDirective>	getDirectives(java.lang.String directiveName) Returns all of the directives with the provided name, including repeatable and non repeatable directives.
java.util.Map<java.lang.String,GraphQLDirective>	getDirectivesByName() This will return a Map of the non repeatable directives that are associated with a GraphQLNamedSchemaElement.

Methods inherited from interface graphql.schema.GraphQLNamedSchemaElement

getDefinition, getDescription, getName

Methods inherited from interface graphql.schema.GraphQLSchemaElement

accept, equals, getChildren, getChildrenWithTypeReferences, hashCode, withNewChildren

Method Detail

getDirectives

java.util.List<GraphQLDirective> getDirectives()

This will return a list of all the directives that have been put on GraphQLNamedSchemaElement as a flat list, which may contain repeatable and non repeatable directives.

Returns:

a list of all the directives associated with this named schema element

getDirectivesByName

java.util.Map<java.lang.String,GraphQLDirective> getDirectivesByName()

This will return a Map of the non repeatable directives that are associated with a GraphQLNamedSchemaElement. Any repeatable directives will be filtered out of this map.

Returns:

a map of non repeatable directives by directive name.

getAllDirectivesByName

java.util.Map<java.lang.String,java.util.List<GraphQLDirective>> getAllDirectivesByName()

This will return a Map of the all directives that are associated with a GraphQLNamedSchemaElement, including both repeatable and non repeatable directives.

Returns:

a map of all directives by directive name

getDirective

GraphQLDirective getDirective(java.lang.String directiveName)

Returns a non repeatable directive with the provided name. This will throw a AssertException if the directive is a repeatable directive that has more then one instance.

Parameters:

directiveName - the name of the directive to retrieve

Returns:

the directive or null if there is not one with that name

getDirectives

default java.util.List<GraphQLDirective> getDirectives(java.lang.String directiveName)

Returns all of the directives with the provided name, including repeatable and non repeatable directives.

Parameters:

directiveName - the name of the directives to retrieve

Returns:

the directives or empty list if there is not one with that name