io.leangen.graphql.generator

Class OperationMapper

java.lang.Object

io.leangen.graphql.generator.OperationMapper

public class OperationMapper
extends Object

Drives the work of mapping Java structures into their GraphQL representations.

While the task of mapping types is delegated to instances of TypeMapper, selection of mappers, construction and attachment of resolvers (modeled by DataFetchers in graphql-java), and other universal tasks are encapsulated in this class.

Constructor Summary

Constructors

Constructor and Description
OperationMapper(BuildContext buildContext)

Method Summary

Modifier and Type	Method and Description
List<graphql.schema.GraphQLDirective>	getDirectives()
List<graphql.schema.GraphQLFieldDefinition>	getMutations() Fetches all the mapped GraphQL fields representing mutations, ready to be attached to the root mutation type.
List<graphql.schema.GraphQLFieldDefinition>	getQueries() Fetches all the mapped GraphQL fields representing top-level queries, ready to be attached to the root query type.
List<graphql.schema.GraphQLFieldDefinition>	getSubscriptions()
graphql.schema.GraphQLDirective	toGraphQLDirective(Directive directive, BuildContext buildContext)
graphql.schema.GraphQLFieldDefinition	toGraphQLField(Operation operation, BuildContext buildContext) Maps a single operation to a GraphQL output field (as queries in GraphQL are nothing but fields of the root operation type).
graphql.schema.GraphQLInputObjectField	toGraphQLInputField(InputField inputField, BuildContext buildContext) Maps a single field/property to a GraphQL input field.
graphql.schema.GraphQLInputType	toGraphQLInputType(AnnotatedType javaType, BuildContext buildContext)
graphql.schema.GraphQLInputType	toGraphQLInputType(AnnotatedType javaType, Set<Class<? extends TypeMapper>> mappersToSkip, BuildContext buildContext) Maps a Java type to a GraphQL input type.
graphql.schema.GraphQLOutputType	toGraphQLType(AnnotatedType javaType, BuildContext buildContext)
graphql.schema.GraphQLOutputType	toGraphQLType(AnnotatedType javaType, Set<Class<? extends TypeMapper>> mappersToSkip, BuildContext buildContext) Maps a Java type to a GraphQL output type.

Methods inherited from class java.lang.Object

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

Constructor Detail

OperationMapper

public OperationMapper(BuildContext buildContext)

Parameters:

buildContext - The shared context containing all the global information needed for mapping

Method Detail

toGraphQLField

public graphql.schema.GraphQLFieldDefinition toGraphQLField(Operation operation,
                                                            BuildContext buildContext)

Maps a single operation to a GraphQL output field (as queries in GraphQL are nothing but fields of the root operation type).

Parameters:

operation - The operation to map to a GraphQL output field

buildContext - The shared context containing all the global information needed for mapping

Returns:

GraphQL output field representing the given operation

toGraphQLType

public graphql.schema.GraphQLOutputType toGraphQLType(AnnotatedType javaType,
                                                      BuildContext buildContext)

toGraphQLType

public graphql.schema.GraphQLOutputType toGraphQLType(AnnotatedType javaType,
                                                      Set<Class<? extends TypeMapper>> mappersToSkip,
                                                      BuildContext buildContext)

Maps a Java type to a GraphQL output type. Delegates most of the work to applicable TypeMappers.

See TypeMapper.toGraphQLType(AnnotatedType, OperationMapper, java.util.Set, BuildContext)

Parameters:

javaType - The Java type that is to be mapped to a GraphQL output type

buildContext - The shared context containing all the global information needed for mapping

Returns:

GraphQL output type corresponding to the given Java type

toGraphQLInputField

public graphql.schema.GraphQLInputObjectField toGraphQLInputField(InputField inputField,
                                                                  BuildContext buildContext)

Maps a single field/property to a GraphQL input field.

Parameters:

inputField - The field/property to map to a GraphQL input field

buildContext - The shared context containing all the global information needed for mapping

Returns:

GraphQL input field representing the given field/property

toGraphQLInputType

public graphql.schema.GraphQLInputType toGraphQLInputType(AnnotatedType javaType,
                                                          BuildContext buildContext)

toGraphQLInputType

public graphql.schema.GraphQLInputType toGraphQLInputType(AnnotatedType javaType,
                                                          Set<Class<? extends TypeMapper>> mappersToSkip,
                                                          BuildContext buildContext)

Maps a Java type to a GraphQL input type. Delegates most of the work to applicable TypeMappers.

See TypeMapper.toGraphQLInputType(AnnotatedType, OperationMapper, java.util.Set, BuildContext)

Parameters:

javaType - The Java type that is to be mapped to a GraphQL input type

buildContext - The shared context containing all the global information needed for mapping

Returns:

GraphQL input type corresponding to the given Java type

toGraphQLDirective

public graphql.schema.GraphQLDirective toGraphQLDirective(Directive directive,
                                                          BuildContext buildContext)

getQueries

public List<graphql.schema.GraphQLFieldDefinition> getQueries()

Fetches all the mapped GraphQL fields representing top-level queries, ready to be attached to the root query type.

Returns:

A list of GraphQL fields representing top-level queries

getMutations

public List<graphql.schema.GraphQLFieldDefinition> getMutations()

Fetches all the mapped GraphQL fields representing mutations, ready to be attached to the root mutation type.

Returns:

A list of GraphQL fields representing mutations

getSubscriptions

public List<graphql.schema.GraphQLFieldDefinition> getSubscriptions()

getDirectives

public List<graphql.schema.GraphQLDirective> getDirectives()