com.graphql_java_generator.client.request

Class ObjectResponse

java.lang.Object

com.graphql_java_generator.client.request.ObjectResponse

public class ObjectResponse
extends Object

This class describes what response is expected from the GraphQL server. That is: the fields and sub-objects that the response from the GraphQL server should contain, for one GraphQL type.
The structure is recursive: a ObjectResponse itsled contains one or more ObjectResponse, to describe the Sub-object(s) that should be returned.
A ObjectResponse can not be created directly. You must use an Builder to create a ObjectResponse. This Builder allows to easily add fields, which can be scalars or sub-objects. And it validates for each the GraphQL schema is respected.
There are two types of ObjectResponse:

• Query ObjectResponse: a query ResponsDef is returned by the generated code. For instance, if your schema contains a QueryType type, a QueryType object will be generated. For each query in the GraphQL schema, this QueryType object contains two methods: a getter which returns the Builder for this query, and the method wich actually do the call to the GraphQL server for this query.
• Sub-object ObjectResponse: such a ObjectResponse allow you to define what's expected for a field that is actually an object. This field is a sub-object of the object owning this field. To link such a ObjectResponse, you'll use the Builder.withSubObject(String, ObjectResponse) or the Builder.withSubObject(String, String, ObjectResponse) method.

How to use the Builder

You'll first get a ObjectResponse from the generated QueryType (or whatever name you have in your GraphQL schema for the query object), and its method getXxxxResponseDef, where Xxxx is the name of the query into the QueryType.
On this Builder, you can call:

• One of the withField methods to add a scalar field to the expected response
• One of the withEntity methods to add a field whose type is not scalar. That is, to add a field whose type is an object defined in the GraphQL schema. The withEntity methods needs a ObjectResponse. To get this ObjectResponse, you'll create a Builder with one of the newSubObjectResponseDefBuilder methods.

Author:

EtienneSF

Method Summary

Modifier and Type	Method and Description
void	appendResponseQuery(StringBuilder sb) Retrieves the part of the query, which describes the fields that the GraphQL server should return.
String	getFieldAlias()
Class<?>	getFieldClass()
String	getFieldName()
static Builder	newQueryResponseDefBuilder(Class<?> clazz, String fieldName) Contruct a new Builder.
static Builder	newQueryResponseDefBuilder(Class<?> clazz, String fieldName, String fieldAlias) Contruct a new Builder
static Builder	newSubObjectBuilder(Class<?> clazz) Contruct a new Builder

Methods inherited from class java.lang.Object

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

Method Detail

newQueryResponseDefBuilder

public static Builder newQueryResponseDefBuilder(Class<?> clazz,
                                                 String fieldName)
                                          throws GraphQLRequestPreparationException

Contruct a new Builder. You can then call the withField or withSubObject methods to

Parameters:

clazz - The Class for which contains the field for which this ObjectResponse defines the expected response from the GraphQL server

fieldName - The name of the field for which this ObjectResponse defines the expected response from the GraphQL server. There will be no alias for this field in the request.

Returns:

Throws:

NullPointerException - If the fieldName is null

GraphQLRequestPreparationException - If the fieldName is not valid

newQueryResponseDefBuilder

public static Builder newQueryResponseDefBuilder(Class<?> clazz,
                                                 String fieldName,
                                                 String fieldAlias)
                                          throws GraphQLRequestPreparationException

Contruct a new Builder

Parameters:

clazz - The Class for which contains the field for which this ObjectResponse defines the expected response from the GraphQL server

fieldName - The name of the field for which this ObjectResponse defines the expected response from the GraphQL server

fieldAlias - The alias for this field. Typically necessay if you want to do two queries of the name within one server call

Returns:

Throws:

NullPointerException - If the fieldName is null

GraphQLRequestPreparationException - If the fieldName or the fieldAlias is not valid

newSubObjectBuilder

public static Builder newSubObjectBuilder(Class<?> clazz)

Contruct a new Builder

Parameters:

name -

Returns:

getFieldAlias

public String getFieldAlias()

getFieldClass

public Class<?> getFieldClass()

getFieldName

public String getFieldName()

appendResponseQuery

public void appendResponseQuery(StringBuilder sb)

Retrieves the part of the query, which describes the fields that the GraphQL server should return.
For instance, for the query: {hero(episode: NEWHOPE) {id name}}, the response definition is {id name}

Parameters:

sb - The StringBuilder where the response must be appended