graphql.annotations

Interface TypeFunction

All Known Implementing Classes:

BatchedTypeFunction, DefaultTypeFunction

public interface TypeFunction

A GraphQLType builder for java types.

Method Summary

Modifier and Type	Method and Description
default graphql.schema.GraphQLType	buildType(java.lang.Class<?> aClass, java.lang.reflect.AnnotatedType annotatedType) Build a GraphQLType object from a java type.
graphql.schema.GraphQLType	buildType(java.lang.String typeName, java.lang.Class<?> aClass, java.lang.reflect.AnnotatedType annotatedType) Build a GraphQLType object from a java type.
boolean	canBuildType(java.lang.Class<?> aClass, java.lang.reflect.AnnotatedType annotatedType) Get whether this builder handles the given type.
default java.lang.String	getTypeName(java.lang.Class<?> aClass, java.lang.reflect.AnnotatedType annotatedType) Get the graphql type name that will be used to build the type.

Method Detail

getTypeName

default java.lang.String getTypeName(java.lang.Class<?> aClass,
                                     java.lang.reflect.AnnotatedType annotatedType)

Get the graphql type name that will be used to build the type. The type name is passed to the buildType(java.lang.Class<?>, java.lang.reflect.AnnotatedType) method when building the type.

Parameters:

aClass - The java type to build the type name for

annotatedType - The AnnotatedType of the java type, which may be a {link AnnotatedParameterizedType}

Returns:

The graphql type name

canBuildType

boolean canBuildType(java.lang.Class<?> aClass,
                     java.lang.reflect.AnnotatedType annotatedType)

Get whether this builder handles the given type.

Parameters:

aClass - The java type to build the type name for

annotatedType - The AnnotatedType of the java type, which may be a {link AnnotatedParameterizedType}

Returns:

True if this builder can build the type

buildType

default graphql.schema.GraphQLType buildType(java.lang.Class<?> aClass,
                                             java.lang.reflect.AnnotatedType annotatedType)

Build a GraphQLType object from a java type. This is a convenience method for calling buildType(String, Class, AnnotatedType) without a type name.

Parameters:

aClass - The java type to build the type name for

annotatedType - The AnnotatedType of the java type, which may be a {link AnnotatedParameterizedType}

Returns:

The built GraphQLType

buildType

graphql.schema.GraphQLType buildType(java.lang.String typeName,
                                     java.lang.Class<?> aClass,
                                     java.lang.reflect.AnnotatedType annotatedType)

Build a GraphQLType object from a java type.

Parameters:

typeName - The name to give the graphql type

aClass - The java type to build the type name for

annotatedType - The AnnotatedType of the java type, which may be a {link AnnotatedParameterizedType}

Returns:

The built GraphQLType