com.apollographql.apollo.api

Class ResponseField

java.lang.Object

com.apollographql.apollo.api.ResponseField

Direct Known Subclasses:

ResponseField.CustomTypeField

public class ResponseField
extends Object

Field is an abstraction for a field in a graphQL operation. Field can refer to: GraphQL Scalar Types, Objects or List. For a complete list of types that a Field object can refer to see ResponseField.Type class.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ResponseField.BooleanCondition Abstraction for boolean condition
static class	ResponseField.Condition Abstraction for condition to be associated with field
static class	ResponseField.CustomTypeField Abstraction for a Field representing a custom GraphQL scalar type.
static class	ResponseField.Type An abstraction for the field types
static class	ResponseField.TypeNameCondition Abstraction for type name condition

Method Summary

Modifier and Type	Method and Description
Map<String,Object>	arguments()
String	cacheKey(Operation.Variables variables)
List<ResponseField.Condition>	conditions()
String	fieldName()
static ResponseField	forBoolean(String responseName, String fieldName, Map<String,Object> arguments, boolean optional, List<ResponseField.Condition> conditions) Factory method for creating a Field instance representing ResponseField.Type.BOOLEAN.
static ResponseField.CustomTypeField	forCustomType(String responseName, String fieldName, Map<String,Object> arguments, boolean optional, ScalarType scalarType, List<ResponseField.Condition> conditions) Factory method for creating a Field instance representing a custom GraphQL Scalar type, ResponseField.Type.CUSTOM
static ResponseField	forDouble(String responseName, String fieldName, Map<String,Object> arguments, boolean optional, List<ResponseField.Condition> conditions) Factory method for creating a Field instance representing ResponseField.Type.DOUBLE.
static ResponseField	forEnum(String responseName, String fieldName, Map<String,Object> arguments, boolean optional, List<ResponseField.Condition> conditions) Factory method for creating a Field instance representing ResponseField.Type.ENUM.
static ResponseField	forFragment(String responseName, String fieldName, List<String> typeConditions) Factory method for creating a Field instance representing ResponseField.Type.FRAGMENT.
static ResponseField	forInlineFragment(String responseName, String fieldName, List<String> typeConditions) Factory method for creating a Field instance representing ResponseField.Type.INLINE_FRAGMENT.
static ResponseField	forInt(String responseName, String fieldName, Map<String,Object> arguments, boolean optional, List<ResponseField.Condition> conditions) Factory method for creating a Field instance representing ResponseField.Type.INT.
static ResponseField	forList(String responseName, String fieldName, Map<String,Object> arguments, boolean optional, List<ResponseField.Condition> conditions) Factory method for creating a Field instance representing ResponseField.Type.LIST.
static ResponseField	forLong(String responseName, String fieldName, Map<String,Object> arguments, boolean optional, List<ResponseField.Condition> conditions) Factory method for creating a Field instance representing ResponseField.Type.LONG.
static ResponseField	forObject(String responseName, String fieldName, Map<String,Object> arguments, boolean optional, List<ResponseField.Condition> conditions) Factory method for creating a Field instance representing a custom ResponseField.Type.OBJECT.
static ResponseField	forString(String responseName, String fieldName, Map<String,Object> arguments, boolean optional, List<ResponseField.Condition> conditions) Factory method for creating a Field instance representing ResponseField.Type.STRING.
boolean	optional()
Object	resolveArgument(String name, Operation.Variables variables) Resolve field argument value by name.
String	responseName()
ResponseField.Type	type()

Methods inherited from class java.lang.Object

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

Method Detail

forString

public static ResponseField forString(String responseName,
                                      String fieldName,
                                      Map<String,Object> arguments,
                                      boolean optional,
                                      List<ResponseField.Condition> conditions)

Factory method for creating a Field instance representing ResponseField.Type.STRING.

Parameters:

responseName - alias for the result of a field

fieldName - name of the field in the GraphQL operation

arguments - arguments to be passed along with the field

optional - whether the arguments passed along are optional or required

conditions - list of conditions for this field

Returns:

Field instance representing ResponseField.Type.STRING

forInt

public static ResponseField forInt(String responseName,
                                   String fieldName,
                                   Map<String,Object> arguments,
                                   boolean optional,
                                   List<ResponseField.Condition> conditions)

Factory method for creating a Field instance representing ResponseField.Type.INT.

Parameters:

responseName - alias for the result of a field

fieldName - name of the field in the GraphQL operation

arguments - arguments to be passed along with the field

optional - whether the arguments passed along are optional or required

conditions - list of conditions for this field

Returns:

Field instance representing ResponseField.Type.INT

forLong

public static ResponseField forLong(String responseName,
                                    String fieldName,
                                    Map<String,Object> arguments,
                                    boolean optional,
                                    List<ResponseField.Condition> conditions)

Factory method for creating a Field instance representing ResponseField.Type.LONG.

Parameters:

responseName - alias for the result of a field

fieldName - name of the field in the GraphQL operation

arguments - arguments to be passed along with the field

optional - whether the arguments passed along are optional or required

conditions - list of conditions for this field

Returns:

Field instance representing ResponseField.Type.LONG

forDouble

public static ResponseField forDouble(String responseName,
                                      String fieldName,
                                      Map<String,Object> arguments,
                                      boolean optional,
                                      List<ResponseField.Condition> conditions)

Factory method for creating a Field instance representing ResponseField.Type.DOUBLE.

Parameters:

responseName - alias for the result of a field

fieldName - name of the field in the GraphQL operation

arguments - arguments to be passed along with the field

optional - whether the arguments passed along are optional or required

conditions - list of conditions for this field

Returns:

Field instance representing ResponseField.Type.DOUBLE

forBoolean

public static ResponseField forBoolean(String responseName,
                                       String fieldName,
                                       Map<String,Object> arguments,
                                       boolean optional,
                                       List<ResponseField.Condition> conditions)

Factory method for creating a Field instance representing ResponseField.Type.BOOLEAN.

Parameters:

responseName - alias for the result of a field

fieldName - name of the field in the GraphQL operation

arguments - arguments to be passed along with the field

optional - whether the arguments passed along are optional or required

conditions - list of conditions for this field

Returns:

Field instance representing ResponseField.Type.BOOLEAN

forEnum

public static ResponseField forEnum(String responseName,
                                    String fieldName,
                                    Map<String,Object> arguments,
                                    boolean optional,
                                    List<ResponseField.Condition> conditions)

Factory method for creating a Field instance representing ResponseField.Type.ENUM.

Parameters:

responseName - alias for the result of a field

fieldName - name of the field in the GraphQL operation

arguments - arguments to be passed along with the field

optional - whether the arguments passed along are optional or required

conditions - list of conditions for this field

Returns:

Field instance representing ResponseField.Type.ENUM

forObject

public static ResponseField forObject(String responseName,
                                      String fieldName,
                                      Map<String,Object> arguments,
                                      boolean optional,
                                      List<ResponseField.Condition> conditions)

Factory method for creating a Field instance representing a custom ResponseField.Type.OBJECT.

Parameters:

responseName - alias for the result of a field

fieldName - name of the field in the GraphQL operation

arguments - arguments to be passed along with the field

optional - whether the arguments passed along are optional or required

conditions - list of conditions for this field

Returns:

Field instance representing custom ResponseField.Type.OBJECT

forList

public static ResponseField forList(String responseName,
                                    String fieldName,
                                    Map<String,Object> arguments,
                                    boolean optional,
                                    List<ResponseField.Condition> conditions)

Factory method for creating a Field instance representing ResponseField.Type.LIST.

Parameters:

responseName - alias for the result of a field

fieldName - name of the field in the GraphQL operation

arguments - arguments to be passed along with the field

optional - whether the arguments passed along are optional or required

conditions - list of conditions for this field

Returns:

Field instance representing ResponseField.Type.LIST

forCustomType

public static ResponseField.CustomTypeField forCustomType(String responseName,
                                                          String fieldName,
                                                          Map<String,Object> arguments,
                                                          boolean optional,
                                                          ScalarType scalarType,
                                                          List<ResponseField.Condition> conditions)

Factory method for creating a Field instance representing a custom GraphQL Scalar type, ResponseField.Type.CUSTOM

Parameters:

responseName - alias for the result of a field

fieldName - name of the field in the GraphQL operation

arguments - arguments to be passed along with the field

optional - whether the arguments passed along are optional or required

scalarType - the custom scalar type of the field

conditions - list of conditions for this field

Returns:

Field instance representing ResponseField.Type.CUSTOM

forFragment

public static ResponseField forFragment(String responseName,
                                        String fieldName,
                                        List<String> typeConditions)

Factory method for creating a Field instance representing ResponseField.Type.FRAGMENT.

Parameters:

responseName - alias for the result of a field

fieldName - name of the field in the GraphQL operation

typeConditions - conditional GraphQL types

Returns:

Field instance representing ResponseField.Type.FRAGMENT

forInlineFragment

public static ResponseField forInlineFragment(String responseName,
                                              String fieldName,
                                              List<String> typeConditions)

Factory method for creating a Field instance representing ResponseField.Type.INLINE_FRAGMENT.

Parameters:

responseName - alias for the result of a field

fieldName - name of the field in the GraphQL operation

typeConditions - conditional GraphQL types

Returns:

Field instance representing ResponseField.Type.INLINE_FRAGMENT

type

public ResponseField.Type type()

responseName

public String responseName()

fieldName

public String fieldName()

arguments

public Map<String,Object> arguments()

optional

public boolean optional()

conditions

public List<ResponseField.Condition> conditions()

cacheKey

public String cacheKey(Operation.Variables variables)

resolveArgument

@Nullable
public Object resolveArgument(@Nonnull
                                        String name,
                                        @Nonnull
                                        Operation.Variables variables)

Resolve field argument value by name. If argument represents a references to the variable, it will be resolved from provided operation variables values.

Parameters:

name - argument name

variables - values of operation variables

Returns:

resolved argument value