graphql.schema

Class GraphQLInterfaceType

java.lang.Object

graphql.schema.GraphQLInterfaceType

All Implemented Interfaces:

GraphQLCompositeType, GraphQLDirectiveContainer, GraphQLFieldsContainer, GraphQLNamedOutputType, GraphQLNamedSchemaElement, GraphQLNamedType, GraphQLNullableType, GraphQLOutputType, GraphQLSchemaElement, GraphQLType, GraphQLUnmodifiedType

@PublicApi
public class GraphQLInterfaceType
extends java.lang.Object
implements GraphQLNamedType, 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

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CHILD_DIRECTIVES
static java.lang.String	CHILD_FIELD_DEFINITIONS

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.
GraphQLInterfaceType(java.lang.String name, java.lang.String description, java.util.List<GraphQLFieldDefinition> fieldDefinitions, TypeResolver typeResolver, java.util.List<GraphQLDirective> directives, InterfaceTypeDefinition definition, java.util.List<InterfaceTypeExtensionDefinition> extensionDefinitions)

Method Summary

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

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

Field Detail

CHILD_FIELD_DEFINITIONS

public static final java.lang.String CHILD_FIELD_DEFINITIONS

See Also:

Constant Field Values

CHILD_DIRECTIVES

public static final java.lang.String CHILD_DIRECTIVES

See Also:

Constant Field Values

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

GraphQLInterfaceType

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

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 GraphQLNamedSchemaElement

getDescription

public java.lang.String getDescription()

Specified by:

getDescription in interface GraphQLNamedSchemaElement

getDefinition

public InterfaceTypeDefinition 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.

getExtensionDefinitions

public java.util.List<InterfaceTypeExtensionDefinition> getExtensionDefinitions()

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<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 GraphQLInterfaceType withNewChildren(SchemaElementChildrenContainer newChildren)

Specified by:

withNewChildren in interface GraphQLSchemaElement

newInterface

public static GraphQLInterfaceType.Builder newInterface()

newInterface

public static GraphQLInterfaceType.Builder newInterface(GraphQLInterfaceType existing)