graphql.schema

Class GraphQLTypeReference

java.lang.Object

graphql.schema.GraphQLTypeReference

All Implemented Interfaces:

GraphQLInputType, GraphQLOutputType, GraphQLType

@PublicApi
public class GraphQLTypeReference
extends java.lang.Object
implements GraphQLType, GraphQLOutputType, GraphQLInputType

A special type to allow a object/interface types to reference itself. It's replaced with the real type object when the schema is built.

Constructor Summary

Constructors

Constructor and Description
GraphQLTypeReference(java.lang.String name)

Method Summary

Modifier and Type	Method and Description
TraversalControl	accept(TraverserContext<GraphQLType> context, GraphQLTypeVisitor visitor) Double-dispatch entry point.
java.lang.String	getName()
static GraphQLTypeReference	typeRef(java.lang.String typeName) A factory method for creating type references so that when used with static imports allows more readable code such as .type(typeRef(GraphQLString))

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface graphql.schema.GraphQLType

getChildren

Constructor Detail

GraphQLTypeReference

public GraphQLTypeReference(java.lang.String name)

Method Detail

typeRef

public static GraphQLTypeReference typeRef(java.lang.String typeName)

A factory method for creating type references so that when used with static imports allows more readable code such as .type(typeRef(GraphQLString))

Parameters:

typeName - the name of the type to reference

Returns:

a GraphQLTypeReference of that named type

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

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.