java.lang.Object
- graphql.schema.GraphQLInterfaceType

All Implemented Interfaces:

GraphQLCompositeType, GraphQLDirectiveContainer, GraphQLFieldsContainer, GraphQLImplementingType, GraphQLNamedOutputType, GraphQLNamedSchemaElement, GraphQLNamedType, GraphQLNullableType, GraphQLOutputType, GraphQLSchemaElement, GraphQLType, GraphQLUnmodifiedType
```
@PublicApi
public class GraphQLInterfaceType
extends java.lang.Object
implements GraphQLNamedType, GraphQLCompositeType, GraphQLUnmodifiedType, GraphQLNullableType, GraphQLDirectiveContainer, GraphQLImplementingType
```
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 https://graphql.org/learn/schema/#interfaces for more details on the concept.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class GraphQLInterfaceType.Builder

Field Summary

Fields
Modifier and Type Field Description

static java.lang.String CHILD_FIELD_DEFINITIONS

static java.lang.String CHILD_INTERFACES
- Fields inherited from interface graphql.schema.GraphQLDirectiveContainer
  CHILD_APPLIED_DIRECTIVES, CHILD_DIRECTIVES

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`TraversalControl`	`accept(TraverserContext<GraphQLSchemaElement> context, GraphQLTypeVisitor visitor)`
`GraphQLSchemaElement`	`copy()`	Each GraphQLSchemaElement should make a copy of itself when this is called.
`boolean`	`equals(java.lang.Object o)`	No GraphQLSchemaElement implements `equals` because we need object identity to treat a GraphQLSchema as an abstract graph.
`java.util.Map<java.lang.String,java.util.List<GraphQLAppliedDirective>>`	`getAllAppliedDirectivesByName()`	This will return a Map of the all directives that are associated with a `GraphQLNamedSchemaElement`, including both repeatable and non-repeatable directives.
`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.
`GraphQLAppliedDirective`	`getAppliedDirective(java.lang.String directiveName)`	Returns a non-repeatable directive with the provided name.
`java.util.List<GraphQLAppliedDirective>`	`getAppliedDirectives()`	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.
`java.util.List<GraphQLSchemaElement>`	`getChildren()`
`SchemaElementChildrenContainer`	`getChildrenWithTypeReferences()`
`InterfaceTypeDefinition`	`getDefinition()`	The AST `Node` this schema element is based on.
`java.lang.String`	`getDescription()`
`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.
`java.util.Map<java.lang.String,GraphQLDirective>`	`getDirectivesByName()`	This will return a Map of the non repeatable directives that are associated with a `GraphQLNamedSchemaElement`.
`java.util.List<InterfaceTypeExtensionDefinition>`	`getExtensionDefinitions()`
`GraphQLFieldDefinition`	`getFieldDefinition(java.lang.String name)`
`java.util.List<GraphQLFieldDefinition>`	`getFieldDefinitions()`
`java.util.List<GraphQLNamedOutputType>`	`getInterfaces()`
`java.lang.String`	`getName()`
`int`	`hashCode()`	No GraphQLSchemaElement implements `equals/hashCode` because we need object identity to treat a GraphQLSchema as an abstract graph.
`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, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface graphql.schema.GraphQLDirectiveContainer
getAppliedDirectives, getDirectives, hasAppliedDirective, hasDirective

Methods inherited from interface graphql.schema.GraphQLFieldsContainer
getField, getFields

- Field Detail
  - CHILD_FIELD_DEFINITIONS
```
public static final java.lang.String CHILD_FIELD_DEFINITIONS
```
    See Also:
    
    Constant Field Values
  - CHILD_INTERFACES
```
public static final java.lang.String CHILD_INTERFACES
```
    See Also:
    
    Constant Field Values
- 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
    
    Returns:
    
    the name of this element. This cant be null
  - getDescription
```
public java.lang.String getDescription()
```
    Specified by:
    
    getDescription in interface GraphQLNamedSchemaElement
    
    Returns:
    
    the description of this element. This can be null
  - 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()
```
    Description copied from interface: GraphQLDirectiveContainer
    
    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.
    
    Specified by:
    
    getDirectives in interface GraphQLDirectiveContainer
    
    Returns:
    
    a list of all the directives associated with this named schema element
  - getDirectivesByName
```
public java.util.Map<java.lang.String,GraphQLDirective> getDirectivesByName()
```
    Description copied from interface: GraphQLDirectiveContainer
    
    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.
    
    Specified by:
    
    getDirectivesByName in interface GraphQLDirectiveContainer
    
    Returns:
    
    a map of non repeatable directives by directive name.
  - getAllDirectivesByName
```
public java.util.Map<java.lang.String,java.util.List<GraphQLDirective>> getAllDirectivesByName()
```
    Description copied from interface: GraphQLDirectiveContainer
    
    This will return a Map of the all directives that are associated with a GraphQLNamedSchemaElement, including both repeatable and non repeatable directives.
    
    Specified by:
    
    getAllDirectivesByName in interface GraphQLDirectiveContainer
    
    Returns:
    
    a map of all directives by directive name
  - getDirective
```
public GraphQLDirective getDirective(java.lang.String directiveName)
```
    Description copied from interface: GraphQLDirectiveContainer
    
    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.
    
    Specified by:
    
    getDirective in interface GraphQLDirectiveContainer
    
    Parameters:
    
    directiveName - the name of the directive to retrieve
    
    Returns:
    
    the directive or null if there is not one with that name
  - getAppliedDirectives
```
public java.util.List<GraphQLAppliedDirective> getAppliedDirectives()
```
    Description copied from interface: GraphQLDirectiveContainer
    
    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.
    
    Specified by:
    
    getAppliedDirectives in interface GraphQLDirectiveContainer
    
    Returns:
    
    a list of all the directives associated with this named schema element
  - getAllAppliedDirectivesByName
```
public java.util.Map<java.lang.String,java.util.List<GraphQLAppliedDirective>> getAllAppliedDirectivesByName()
```
    Description copied from interface: GraphQLDirectiveContainer
    
    This will return a Map of the all directives that are associated with a GraphQLNamedSchemaElement, including both repeatable and non-repeatable directives.
    
    Specified by:
    
    getAllAppliedDirectivesByName in interface GraphQLDirectiveContainer
    
    Returns:
    
    a map of all directives by directive name
  - getAppliedDirective
```
public GraphQLAppliedDirective getAppliedDirective(java.lang.String directiveName)
```
    Description copied from interface: GraphQLDirectiveContainer
    
    Returns a non-repeatable directive with the provided name.
    
    Specified by:
    
    getAppliedDirective in interface GraphQLDirectiveContainer
    
    Parameters:
    
    directiveName - the name of the directive to retrieve
    
    Returns:
    
    the directive or null if there is not one with that name
  - 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
  - copy
```
public GraphQLSchemaElement copy()
```
    Description copied from interface: GraphQLSchemaElement
    
    Each GraphQLSchemaElement should make a copy of itself when this is called. The copy should be included its current contents as they currently exist into a new object.
    
    Specified by:
    
    copy in interface GraphQLSchemaElement
    
    Returns:
    
    a copy of this element
  - 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
  - getInterfaces
```
public java.util.List<GraphQLNamedOutputType> getInterfaces()
```
    Specified by:
    
    getInterfaces in interface GraphQLImplementingType
    
    Returns:
    
    This returns GraphQLInterface or GraphQLTypeReference instances, if the type references are not resolved yet. After they are resolved it contains only GraphQLInterface. Reference resolving happens when a full schema is built.
  - equals
```
public final boolean equals(java.lang.Object o)
```
    No GraphQLSchemaElement implements `equals` because we need object identity to treat a GraphQLSchema as an abstract graph.
    
    Specified by:
    
    equals in interface GraphQLSchemaElement
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    
    o - the reference object with which to compare.
    
    Returns:
    
    true if this object is the same as the obj argument; false otherwise.
  - hashCode
```
public final int hashCode()
```
    No GraphQLSchemaElement implements `equals/hashCode` because we need object identity to treat a GraphQLSchema as an abstract graph.
    
    Specified by:
    
    hashCode in interface GraphQLSchemaElement
    
    Overrides:
    
    hashCode in class java.lang.Object
    
    Returns:
    
    a hash code value for this object.
  - newInterface
```
public static GraphQLInterfaceType.Builder newInterface()
```
  - newInterface
```
public static GraphQLInterfaceType.Builder newInterface(GraphQLInterfaceType existing)
```

Modifier and Type	Field	Description
`static java.lang.String`	`CHILD_FIELD_DEFINITIONS`
`static java.lang.String`	`CHILD_INTERFACES`

Class GraphQLInterfaceType

Nested Class Summary

Field Summary

Fields inherited from interface graphql.schema.GraphQLDirectiveContainer

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface graphql.schema.GraphQLDirectiveContainer

Methods inherited from interface graphql.schema.GraphQLFieldsContainer

Field Detail

CHILD_FIELD_DEFINITIONS

CHILD_INTERFACES

Method Detail

getFieldDefinition

getFieldDefinitions

getName

getDescription

getDefinition

getExtensionDefinitions

getDirectives

getDirectivesByName

getAllDirectivesByName

getDirective

getAppliedDirectives

getAllAppliedDirectivesByName

getAppliedDirective

toString

transform

copy

accept

getChildren

getChildrenWithTypeReferences

withNewChildren

getInterfaces

equals

hashCode

newInterface

newInterface