graphql.java.client.request

Class Builder

java.lang.Object

graphql.java.client.request.Builder

public class Builder
extends Object

This class is a Builder that'll help to build a ObjectResponse, which defines what should appear in the response from the GraphQL server.

Author:

EtienneSF

Method Summary

Modifier and Type	Method and Description
ObjectResponse	build() Returns the built ObjectResponse.
static String	getCamelCase(String name) Convert the given name, to a camel case name.
Builder	withField(String fieldName) Adds a scalar field with no alias, to the ObjectResponse we are building
Builder	withField(String fieldName, String alias) Adds a scalar field with an alias, to the ObjectResponse we are building
Builder	withQueryResponseDef(String queryResponseDef) Builds a ObjectResponse from a part of a GraphQL query.
Builder	withSubObject(String fieldName, ObjectResponse objectResponse) Adds a non scalar field (a subobject) without alias, to the ObjectResponse we are building
Builder	withSubObject(String fieldName, String fieldAlias, ObjectResponse subobjetResponseDef) Adds a scalar field (a subobject) with an alias, to the ObjectResponse we are building

Methods inherited from class java.lang.Object

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

Method Detail

withField

public Builder withField(String fieldName)
                  throws GraphQLRequestPreparationException

Adds a scalar field with no alias, to the ObjectResponse we are building

Parameters:

fieldName -

Returns:

The current builder, to allow the standard builder construction chain

Throws:

NullPointerException - If the fieldName is null

GraphQLRequestPreparationException - If the fieldName or the fieldAlias is not valid

withField

public Builder withField(String fieldName,
                         String alias)
                  throws GraphQLRequestPreparationException

Adds a scalar field with an alias, to the ObjectResponse we are building

Parameters:

fieldName -

alias -

Returns:

The current builder, to allow the standard builder construction chain

Throws:

NullPointerException - If the fieldName is null

GraphQLRequestPreparationException - If the fieldName or the fieldAlias is not valid

withSubObject

public Builder withSubObject(String fieldName,
                             ObjectResponse objectResponse)
                      throws GraphQLRequestPreparationException

Adds a non scalar field (a subobject) without alias, to the ObjectResponse we are building

Parameters:

fieldName -

alias -

Returns:

The current builder, to allow the standard builder construction chain

Throws:

NullPointerException - If the fieldName is null

GraphQLRequestPreparationException - If the fieldName or the fieldAlias is not valid

withSubObject

public Builder withSubObject(String fieldName,
                             String fieldAlias,
                             ObjectResponse subobjetResponseDef)
                      throws GraphQLRequestPreparationException

Adds a scalar field (a subobject) with an alias, to the ObjectResponse we are building

Parameters:

fieldName -

alias -

Returns:

The current builder, to allow the standard builder construction chain

Throws:

NullPointerException - If the fieldName is null

GraphQLRequestPreparationException - If the fieldName or the fieldAlias is not valid

build

public ObjectResponse build()
                     throws GraphQLRequestPreparationException

Returns the built ObjectResponse. If no field (either scalar or suboject) has been added, then all scalar fields are added.

Returns:

Throws:

GraphQLRequestPreparationException

withQueryResponseDef

public Builder withQueryResponseDef(String queryResponseDef)
                             throws GraphQLRequestPreparationException

Builds a ObjectResponse from a part of a GraphQL query. This part define what's expected as a response for the field of the current ObjectResponse for this builder.

Parameters:

queryResponseDef - A part of a response, for instance (for the hero query of the Star Wars GraphQL schema): "{ id name friends{name}}"
No special character are allowed (linefeed...).
This parameter can be a null or an empty string. In this case, all scalar fields are added.

episode -

Returns:

Throws:

GraphQLRequestPreparationException

getCamelCase

public static String getCamelCase(String name)

Convert the given name, to a camel case name. Currenly very simple : it puts the first character in lower case.

Returns: