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

Method Summary

Modifier and Type	Method and Description
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()
TypeResolver	getTypeResolver()
static GraphQLInterfaceType.Builder	newInterface()
java.lang.String	toString()

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

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

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)

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

getTypeResolver

public TypeResolver getTypeResolver()

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

newInterface

public static GraphQLInterfaceType.Builder newInterface()