graphql.annotations

Interface GraphQLAnnotationsProcessor

All Known Implementing Classes:

GraphQLAnnotations

public interface GraphQLAnnotationsProcessor

Method Summary

Modifier and Type	Method and Description
graphql.schema.GraphQLInterfaceType.Builder	getIfaceBuilder(java.lang.Class<?> iface) This will examine the class and return a GraphQLInterfaceType.Builder ready for further definition
graphql.schema.GraphQLInputObjectType	getInputObject(graphql.schema.GraphQLObjectType graphQLType, java.lang.String newNamePrefix) This will turn a GraphQLObjectType into a corresponding GraphQLInputObjectType
graphql.schema.GraphQLType	getInterface(java.lang.Class<?> iface) This will examine the class and if its annotated with GraphQLUnion it will return a GraphQLUnionType.Builder, if its annotated with GraphQLTypeResolver it will return a GraphQLObjectType otherwise it will return a GraphQLInterfaceType.Builder.
graphql.schema.GraphQLObjectType	getObject(java.lang.Class<?> object) This will examine the object class and return a GraphQLObjectType representation
graphql.schema.GraphQLObjectType.Builder	getObjectBuilder(java.lang.Class<?> object) This will examine the object class and return a GraphQLObjectType.Builder ready for further definition
graphql.schema.GraphQLOutputType	getObjectOrRef(java.lang.Class<?> object) This will examine the object class and return a GraphQLOutputType representation which may be a GraphQLObjectType or a GraphQLTypeReference
graphql.schema.GraphQLUnionType.Builder	getUnionBuilder(java.lang.Class<?> iface) This will examine the class and return a GraphQLUnionType.Builder ready for further definition

Method Detail

getInterface

graphql.schema.GraphQLType getInterface(java.lang.Class<?> iface)
                                 throws GraphQLAnnotationsException

This will examine the class and if its annotated with GraphQLUnion it will return a GraphQLUnionType.Builder, if its annotated with GraphQLTypeResolver it will return a GraphQLObjectType otherwise it will return a GraphQLInterfaceType.Builder.

Parameters:

iface - interface to examine

Returns:

a GraphQLType that represents that interface

Throws:

GraphQLAnnotationsException - if the interface cannot be examined

java.lang.IllegalArgumentException - if iface is not an interface

getUnionBuilder

graphql.schema.GraphQLUnionType.Builder getUnionBuilder(java.lang.Class<?> iface)
                                                 throws GraphQLAnnotationsException,
                                                        java.lang.IllegalArgumentException

This will examine the class and return a GraphQLUnionType.Builder ready for further definition

Parameters:

iface - interface to examine

Returns:

a GraphQLUnionType.Builder

Throws:

GraphQLAnnotationsException - if the class cannot be examined

java.lang.IllegalArgumentException - if iface is not an interface

getIfaceBuilder

graphql.schema.GraphQLInterfaceType.Builder getIfaceBuilder(java.lang.Class<?> iface)
                                                     throws GraphQLAnnotationsException,
                                                            java.lang.IllegalArgumentException

This will examine the class and return a GraphQLInterfaceType.Builder ready for further definition

Parameters:

iface - interface to examine

Returns:

a GraphQLInterfaceType.Builder

Throws:

GraphQLAnnotationsException - if the class cannot be examined

java.lang.IllegalArgumentException - if iface is not an interface

getObject

graphql.schema.GraphQLObjectType getObject(java.lang.Class<?> object)
                                    throws GraphQLAnnotationsException

This will examine the object class and return a GraphQLObjectType representation

Parameters:

object - the object class to examine

Returns:

a GraphQLObjectType that represents that object class

Throws:

GraphQLAnnotationsException - if the object class cannot be examined

getObjectOrRef

graphql.schema.GraphQLOutputType getObjectOrRef(java.lang.Class<?> object)
                                         throws GraphQLAnnotationsException

This will examine the object class and return a GraphQLOutputType representation which may be a GraphQLObjectType or a GraphQLTypeReference

Parameters:

object - the object class to examine

Returns:

a GraphQLOutputType that represents that object class

Throws:

GraphQLAnnotationsException - if the object class cannot be examined

getObjectBuilder

graphql.schema.GraphQLObjectType.Builder getObjectBuilder(java.lang.Class<?> object)
                                                   throws GraphQLAnnotationsException

This will examine the object class and return a GraphQLObjectType.Builder ready for further definition

Parameters:

object - the object class to examine

Returns:

a GraphQLObjectType.Builder that represents that object class

Throws:

GraphQLAnnotationsException - if the object class cannot be examined

getInputObject

graphql.schema.GraphQLInputObjectType getInputObject(graphql.schema.GraphQLObjectType graphQLType,
                                                     java.lang.String newNamePrefix)

This will turn a GraphQLObjectType into a corresponding GraphQLInputObjectType

Parameters:

graphQLType - the graphql object type

newNamePrefix - since graphql types MUST be unique, this prefix will be applied to the new input types

Returns:

a GraphQLInputObjectType