graphql.schema

Class GraphQLInterfaceType

java.lang.Object

graphql.schema.GraphQLInterfaceType

All Implemented Interfaces:

GraphQLCompositeType, GraphQLDirectiveContainer, GraphQLFieldsContainer, GraphQLNullableType, GraphQLOutputType, GraphQLType, GraphQLUnmodifiedType

@PublicApi
public class GraphQLInterfaceType
extends java.lang.Object
implements GraphQLType, GraphQLOutputType, GraphQLFieldsContainer, GraphQLCompositeType, GraphQLUnmodifiedType, GraphQLNullableType, GraphQLDirectiveContainer

In graphql, an interface is an abstract type that defines the set of fields that a type must include to implement that interface. At runtime a TypeResolver is used to take an interface object value and decide what GraphQLObjectType represents this interface type. See http://graphql.org/learn/schema/#interfaces for more details on the concept.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GraphQLInterfaceType.Builder

Constructor Summary

Constructors

Constructor and Description
GraphQLInterfaceType(java.lang.String name, java.lang.String description, java.util.List<GraphQLFieldDefinition> fieldDefinitions, TypeResolver typeResolver) Deprecated. use the newInterface() builder pattern instead, as this constructor will be made private in a future version.
GraphQLInterfaceType(java.lang.String name, java.lang.String description, java.util.List<GraphQLFieldDefinition> fieldDefinitions, TypeResolver typeResolver, java.util.List<GraphQLDirective> directives, InterfaceTypeDefinition definition) Deprecated. use the newInterface() builder pattern instead, as this constructor will be made private in a future version.

Method Summary

Modifier and Type	Method and Description
TraversalControl	accept(TraverserContext<GraphQLType> context, GraphQLTypeVisitor visitor) Double-dispatch entry point.
java.util.List<GraphQLType>	getChildren()
InterfaceTypeDefinition	getDefinition()
java.lang.String	getDescription()
java.util.List<GraphQLDirective>	getDirectives()
GraphQLFieldDefinition	getFieldDefinition(java.lang.String name)
java.util.List<GraphQLFieldDefinition>	getFieldDefinitions()
java.lang.String	getName()
static GraphQLInterfaceType.Builder	newInterface()
static GraphQLInterfaceType.Builder	newInterface(GraphQLInterfaceType existing)
java.lang.String	toString()
GraphQLInterfaceType	transform(java.util.function.Consumer<GraphQLInterfaceType.Builder> builderConsumer) This helps you transform the current GraphQLInterfaceType 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

Methods inherited from interface graphql.schema.GraphQLDirectiveContainer

getDirective, getDirectivesByName

Constructor Detail

GraphQLInterfaceType

@Deprecated
public GraphQLInterfaceType(java.lang.String name,
                                        java.lang.String description,
                                        java.util.List<GraphQLFieldDefinition> fieldDefinitions,
                                        TypeResolver typeResolver)

Deprecated. use the newInterface() builder pattern instead, as this constructor will be made private in a future version.

Parameters:

name - the name

description - the description

fieldDefinitions - the fields

typeResolver - the type resolver function

GraphQLInterfaceType

@Deprecated
public GraphQLInterfaceType(java.lang.String name,
                                        java.lang.String description,
                                        java.util.List<GraphQLFieldDefinition> fieldDefinitions,
                                        TypeResolver typeResolver,
                                        java.util.List<GraphQLDirective> directives,
                                        InterfaceTypeDefinition definition)

Deprecated. use the newInterface() builder pattern instead, as this constructor will be made private in a future version.

Parameters:

name - the name

description - the description

fieldDefinitions - the fields

typeResolver - the type resolver function

directives - the directives on this type element

definition - the AST definition

Method Detail

getFieldDefinition

public GraphQLFieldDefinition getFieldDefinition(java.lang.String name)

Specified by:

getFieldDefinition in interface GraphQLFieldsContainer

getFieldDefinitions

public java.util.List<GraphQLFieldDefinition> getFieldDefinitions()

Specified by:

getFieldDefinitions in interface GraphQLFieldsContainer

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]*

getDescription

public java.lang.String getDescription()

getDefinition

public InterfaceTypeDefinition getDefinition()

getDirectives

public java.util.List<GraphQLDirective> getDirectives()

Specified by:

getDirectives in interface GraphQLDirectiveContainer

Returns:

a list of directives associated with the type or field

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

transform

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

This helps you transform the current GraphQLInterfaceType 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 object 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

newInterface

public static GraphQLInterfaceType.Builder newInterface()

newInterface

public static GraphQLInterfaceType.Builder newInterface(GraphQLInterfaceType existing)