graphql.annotations

Class GraphQLAnnotations

java.lang.Object

graphql.annotations.GraphQLAnnotations

All Implemented Interfaces:

GraphQLAnnotationsProcessor

public class GraphQLAnnotations
extends java.lang.Object
implements GraphQLAnnotationsProcessor

A utility class for extracting GraphQL data structures from annotated elements.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GraphQLAnnotations.GraphQLFieldDefinitionWrapper

Field Summary

Fields

Modifier and Type	Field and Description
protected TypeFunction	defaultTypeFunction
static GraphQLAnnotations	instance

Constructor Summary

Constructors

Constructor and Description
GraphQLAnnotations()
GraphQLAnnotations(TypeFunction defaultTypeFunction)

Method Summary

Modifier and Type	Method and Description
protected graphql.schema.GraphQLFieldDefinition	field(java.lang.reflect.Field field)
protected static graphql.schema.GraphQLFieldDefinition	field(java.lang.reflect.Method method)
protected java.util.Map<java.lang.String,java.lang.reflect.Field>	getAllFields(java.lang.Class c)
protected graphql.schema.GraphQLArgument	getArgument(java.lang.reflect.Parameter parameter, graphql.schema.GraphQLType t)
protected graphql.schema.GraphQLFieldDefinition	getField(java.lang.reflect.Field field)
protected graphql.schema.GraphQLFieldDefinition	getField(java.lang.reflect.Method method)
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
static GraphQLAnnotations	getInstance()
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
protected java.util.List<java.lang.reflect.Method>	getOrderedMethods(java.lang.Class c)
java.lang.String	getTypeName(java.lang.Class<?> objectClass)
java.util.Map<java.lang.String,graphql.schema.GraphQLType>	getTypeRegistry()
graphql.schema.GraphQLUnionType.Builder	getUnionBuilder(java.lang.Class<?> iface) This will examine the class and return a GraphQLUnionType.Builder ready for further definition
static graphql.schema.GraphQLType	iface(java.lang.Class<?> iface)
static graphql.schema.GraphQLInterfaceType.Builder	ifaceBuilder(java.lang.Class<?> iface)
static graphql.schema.GraphQLInputObjectType	inputObject(graphql.schema.GraphQLObjectType graphQLType, java.lang.String newNamePrefix)
static graphql.schema.GraphQLObjectType	object(java.lang.Class<?> object)
static graphql.schema.GraphQLObjectType.Builder	objectBuilder(java.lang.Class<?> object)
static void	register(TypeFunction typeFunction)
void	registerType(TypeFunction typeFunction)
void	setDefaultTypeFunction(TypeFunction function)
static graphql.schema.GraphQLUnionType.Builder	unionBuilder(java.lang.Class<?> iface)

Methods inherited from class java.lang.Object

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

Field Detail

instance

public static GraphQLAnnotations instance

defaultTypeFunction

protected TypeFunction defaultTypeFunction

Constructor Detail

GraphQLAnnotations

public GraphQLAnnotations()

GraphQLAnnotations

public GraphQLAnnotations(TypeFunction defaultTypeFunction)

Method Detail

getInstance

public static GraphQLAnnotations getInstance()

getInterface

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

Description copied from interface: GraphQLAnnotationsProcessor

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.

Specified by:

getInterface in interface GraphQLAnnotationsProcessor

Parameters:

iface - interface to examine

Returns:

a GraphQLType that represents that interface

Throws:

GraphQLAnnotationsException - if the interface cannot be examined

iface

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

Throws:

GraphQLAnnotationsException

getUnionBuilder

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

Description copied from interface: GraphQLAnnotationsProcessor

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

Specified by:

getUnionBuilder in interface GraphQLAnnotationsProcessor

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

unionBuilder

public static graphql.schema.GraphQLUnionType.Builder unionBuilder(java.lang.Class<?> iface)
                                                            throws GraphQLAnnotationsException

Throws:

GraphQLAnnotationsException

getTypeName

public java.lang.String getTypeName(java.lang.Class<?> objectClass)

getIfaceBuilder

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

Description copied from interface: GraphQLAnnotationsProcessor

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

Specified by:

getIfaceBuilder in interface GraphQLAnnotationsProcessor

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

ifaceBuilder

public static graphql.schema.GraphQLInterfaceType.Builder ifaceBuilder(java.lang.Class<?> iface)
                                                                throws GraphQLAnnotationsException,
                                                                       java.lang.IllegalAccessException

Throws:

GraphQLAnnotationsException

java.lang.IllegalAccessException

getObject

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

Description copied from interface: GraphQLAnnotationsProcessor

This will examine the object class and return a GraphQLObjectType representation

Specified by:

getObject in interface GraphQLAnnotationsProcessor

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

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

Description copied from interface: GraphQLAnnotationsProcessor

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

Specified by:

getObjectOrRef in interface GraphQLAnnotationsProcessor

Parameters:

object - the object class to examine

Returns:

a GraphQLOutputType that represents that object class

Throws:

GraphQLAnnotationsException - if the object class cannot be examined

object

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

Throws:

GraphQLAnnotationsException

getObjectBuilder

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

Description copied from interface: GraphQLAnnotationsProcessor

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

Specified by:

getObjectBuilder in interface GraphQLAnnotationsProcessor

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

objectBuilder

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

Throws:

GraphQLAnnotationsException

getOrderedMethods

protected java.util.List<java.lang.reflect.Method> getOrderedMethods(java.lang.Class c)

getAllFields

protected java.util.Map<java.lang.String,java.lang.reflect.Field> getAllFields(java.lang.Class c)

getField

protected graphql.schema.GraphQLFieldDefinition getField(java.lang.reflect.Field field)
                                                  throws GraphQLAnnotationsException

Throws:

GraphQLAnnotationsException

field

protected graphql.schema.GraphQLFieldDefinition field(java.lang.reflect.Field field)
                                               throws java.lang.IllegalAccessException,
                                                      java.lang.InstantiationException

Throws:

java.lang.IllegalAccessException

java.lang.InstantiationException

getField

protected graphql.schema.GraphQLFieldDefinition getField(java.lang.reflect.Method method)
                                                  throws GraphQLAnnotationsException

Throws:

GraphQLAnnotationsException

field

protected static graphql.schema.GraphQLFieldDefinition field(java.lang.reflect.Method method)
                                                      throws java.lang.InstantiationException,
                                                             java.lang.IllegalAccessException

Throws:

java.lang.InstantiationException

java.lang.IllegalAccessException

getInputObject

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

Description copied from interface: GraphQLAnnotationsProcessor

This will turn a GraphQLObjectType into a corresponding GraphQLInputObjectType

Specified by:

getInputObject in interface GraphQLAnnotationsProcessor

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

inputObject

public static graphql.schema.GraphQLInputObjectType inputObject(graphql.schema.GraphQLObjectType graphQLType,
                                                                java.lang.String newNamePrefix)

getArgument

protected graphql.schema.GraphQLArgument getArgument(java.lang.reflect.Parameter parameter,
                                                     graphql.schema.GraphQLType t)
                                              throws GraphQLAnnotationsException

Throws:

GraphQLAnnotationsException

setDefaultTypeFunction

public void setDefaultTypeFunction(TypeFunction function)

registerType

public void registerType(TypeFunction typeFunction)

register

public static void register(TypeFunction typeFunction)

getTypeRegistry

public java.util.Map<java.lang.String,graphql.schema.GraphQLType> getTypeRegistry()