graphql.schema

Class GraphQLObjectType

java.lang.Object

graphql.schema.GraphQLObjectType

All Implemented Interfaces:

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

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

This is the work horse type and represents an object with one or more field values that can be retrieved by the graphql system. Those fields can themselves by object types and so on until you reach the leaf nodes of the type tree represented by GraphQLScalarTypes. See http://graphql.org/learn/schema/#object-types-and-fields for more details on the concept.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GraphQLObjectType.Builder

Constructor Summary

Constructors

Constructor and Description
GraphQLObjectType(java.lang.String name, java.lang.String description, java.util.List<GraphQLFieldDefinition> fieldDefinitions, java.util.List<GraphQLOutputType> interfaces) Deprecated. use the newObject() builder pattern instead, as this constructor will be made private in a future version.
GraphQLObjectType(java.lang.String name, java.lang.String description, java.util.List<GraphQLFieldDefinition> fieldDefinitions, java.util.List<GraphQLOutputType> interfaces, java.util.List<GraphQLDirective> directives, ObjectTypeDefinition definition) Deprecated. use the newObject() 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()
ObjectTypeDefinition	getDefinition()
java.lang.String	getDescription()
java.util.List<GraphQLDirective>	getDirectives()
GraphQLFieldDefinition	getFieldDefinition(java.lang.String name)
java.util.List<GraphQLFieldDefinition>	getFieldDefinitions()
java.util.List<GraphQLOutputType>	getInterfaces()
java.lang.String	getName()
static GraphQLObjectType.Builder	newObject()
static GraphQLObjectType.Builder	newObject(GraphQLObjectType existing)
java.lang.String	toString()
GraphQLObjectType	transform(java.util.function.Consumer<GraphQLObjectType.Builder> builderConsumer) This helps you transform the current GraphQLObjectType 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

GraphQLObjectType

@Deprecated
public GraphQLObjectType(java.lang.String name,
                                     java.lang.String description,
                                     java.util.List<GraphQLFieldDefinition> fieldDefinitions,
                                     java.util.List<GraphQLOutputType> interfaces)

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

Parameters:

name - the name

description - the description

fieldDefinitions - the fields

interfaces - the possible interfaces

GraphQLObjectType

@Deprecated
public GraphQLObjectType(java.lang.String name,
                                     java.lang.String description,
                                     java.util.List<GraphQLFieldDefinition> fieldDefinitions,
                                     java.util.List<GraphQLOutputType> interfaces,
                                     java.util.List<GraphQLDirective> directives,
                                     ObjectTypeDefinition definition)

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

Parameters:

name - the name

description - the description

fieldDefinitions - the fields

interfaces - the possible interfaces

directives - the directives on this type element

definition - the AST definition

Method Detail

getDirectives

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

Specified by:

getDirectives in interface GraphQLDirectiveContainer

Returns:

a list of directives associated with the type or field

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

getInterfaces

public java.util.List<GraphQLOutputType> getInterfaces()

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.

getDescription

public java.lang.String getDescription()

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

getDefinition

public ObjectTypeDefinition getDefinition()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

transform

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

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

newObject

public static GraphQLObjectType.Builder newObject()

newObject

public static GraphQLObjectType.Builder newObject(GraphQLObjectType existing)