com.apollographql.apollo.api

Class Field

java.lang.Object

com.apollographql.apollo.api.Field

Direct Known Subclasses:

Field.ConditionalTypeField, Field.CustomTypeField, Field.ObjectField, Field.ObjectListField, Field.ScalarListField

public class Field
extends java.lang.Object

Field is an abstraction for a field in a graphQL operation. For example, in the following graphQL query, Field represents abstraction for field 'name':

 
  {
      hero {
        name
      }
  }
      
 

Field can refer to: GraphQL Scalar Types, Objects or List. For a complete list of types that a Field object can refer to see Field.Type class.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Field.ConditionalTypeField Abstraction for a Field representing a conditional type.
static interface	Field.ConditionalTypeReader<T>
static class	Field.CustomTypeField Abstraction for a Field representing a custom GraphQL scalar type.
static interface	Field.ListItemReader
static interface	Field.ListReader<T>
static class	Field.ObjectField Abstraction for a Field representing a custom Object type.
static class	Field.ObjectListField Abstraction for a Field representing a list of custom Objects.
static interface	Field.ObjectReader<T>
static class	Field.ScalarListField Abstraction for a Field representing a list of GraphQL scalar types.
static class	Field.Type An abstraction for the field types

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Object>	arguments()
java.lang.String	cacheKey(Operation.Variables variables)
java.lang.String	fieldName()
static Field	forBoolean(java.lang.String responseName, java.lang.String fieldName, java.util.Map<java.lang.String,java.lang.Object> arguments, boolean optional) Factory method for creating a Field instance representing Field.Type.BOOLEAN.
static <T> Field	forConditionalType(java.lang.String responseName, java.lang.String fieldName, Field.ConditionalTypeReader<T> conditionalTypeReader) Factory method for creating a Field instance representing Field.Type.CONDITIONAL.
static Field	forCustomType(java.lang.String responseName, java.lang.String fieldName, java.util.Map<java.lang.String,java.lang.Object> arguments, boolean optional, ScalarType scalarType) Factory method for creating a Field instance representing a custom GraphQL Scalar type, Field.Type.CUSTOM
static Field	forDouble(java.lang.String responseName, java.lang.String fieldName, java.util.Map<java.lang.String,java.lang.Object> arguments, boolean optional) Factory method for creating a Field instance representing Field.Type.DOUBLE.
static Field	forInt(java.lang.String responseName, java.lang.String fieldName, java.util.Map<java.lang.String,java.lang.Object> arguments, boolean optional) Factory method for creating a Field instance representing Field.Type.INT.
static <T> Field	forList(java.lang.String responseName, java.lang.String fieldName, java.util.Map<java.lang.String,java.lang.Object> arguments, boolean optional, Field.ListReader<T> listReader) Factory method for creating a Field instance representing Field.Type.SCALAR_LIST.
static <T> Field	forList(java.lang.String responseName, java.lang.String fieldName, java.util.Map<java.lang.String,java.lang.Object> arguments, boolean optional, Field.ObjectReader<T> objectReader) Factory method for creating a Field instance representing Field.Type.OBJECT_LIST.
static Field	forLong(java.lang.String responseName, java.lang.String fieldName, java.util.Map<java.lang.String,java.lang.Object> arguments, boolean optional) Factory method for creating a Field instance representing Field.Type.LONG.
static <T> Field	forObject(java.lang.String responseName, java.lang.String fieldName, java.util.Map<java.lang.String,java.lang.Object> arguments, boolean optional, Field.ObjectReader<T> objectReader) Factory method for creating a Field instance representing a custom Field.Type.OBJECT.
static Field	forString(java.lang.String responseName, java.lang.String fieldName, java.util.Map<java.lang.String,java.lang.Object> arguments, boolean optional) Factory method for creating a Field instance representing Field.Type.STRING.
boolean	optional()
java.lang.Object	resolveArgument(java.lang.String name, Operation.Variables variables) Resolve field argument value by name.
java.lang.String	responseName()
Field.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 Field forString(java.lang.String responseName,
                              java.lang.String fieldName,
                              java.util.Map<java.lang.String,java.lang.Object> arguments,
                              boolean optional)

Factory method for creating a Field instance representing Field.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

Returns:

Field instance representing Field.Type.STRING

forInt

public static Field forInt(java.lang.String responseName,
                           java.lang.String fieldName,
                           java.util.Map<java.lang.String,java.lang.Object> arguments,
                           boolean optional)

Factory method for creating a Field instance representing Field.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

Returns:

Field instance representing Field.Type.INT

forLong

public static Field forLong(java.lang.String responseName,
                            java.lang.String fieldName,
                            java.util.Map<java.lang.String,java.lang.Object> arguments,
                            boolean optional)

Factory method for creating a Field instance representing Field.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

Returns:

Field instance representing Field.Type.LONG

forDouble

public static Field forDouble(java.lang.String responseName,
                              java.lang.String fieldName,
                              java.util.Map<java.lang.String,java.lang.Object> arguments,
                              boolean optional)

Factory method for creating a Field instance representing Field.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

Returns:

Field instance representing Field.Type.DOUBLE

forBoolean

public static Field forBoolean(java.lang.String responseName,
                               java.lang.String fieldName,
                               java.util.Map<java.lang.String,java.lang.Object> arguments,
                               boolean optional)

Factory method for creating a Field instance representing Field.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

Returns:

Field instance representing Field.Type.BOOLEAN

forObject

public static <T> Field forObject(java.lang.String responseName,
                                  java.lang.String fieldName,
                                  java.util.Map<java.lang.String,java.lang.Object> arguments,
                                  boolean optional,
                                  Field.ObjectReader<T> objectReader)

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

Type Parameters:

T - type of the custom 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

objectReader - converts the field response to the custom object type

Returns:

Field instance representing custom Field.Type.OBJECT

forList

public static <T> Field forList(java.lang.String responseName,
                                java.lang.String fieldName,
                                java.util.Map<java.lang.String,java.lang.Object> arguments,
                                boolean optional,
                                Field.ListReader<T> listReader)

Factory method for creating a Field instance representing Field.Type.SCALAR_LIST.

Type Parameters:

T - type of the scalar type

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

listReader - converts the field response to a list of GraphQL scalar types

Returns:

Field instance representing Field.Type.SCALAR_LIST

forList

public static <T> Field forList(java.lang.String responseName,
                                java.lang.String fieldName,
                                java.util.Map<java.lang.String,java.lang.Object> arguments,
                                boolean optional,
                                Field.ObjectReader<T> objectReader)

Factory method for creating a Field instance representing Field.Type.OBJECT_LIST.

Type Parameters:

T - type of the custom 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

objectReader - converts the field response to a list of custom object types

Returns:

Field instance representing Field.Type.OBJECT_LIST

forCustomType

public static Field forCustomType(java.lang.String responseName,
                                  java.lang.String fieldName,
                                  java.util.Map<java.lang.String,java.lang.Object> arguments,
                                  boolean optional,
                                  ScalarType scalarType)

Factory method for creating a Field instance representing a custom GraphQL Scalar type, Field.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

Returns:

Field instance representing Field.Type.CUSTOM

forConditionalType

public static <T> Field forConditionalType(java.lang.String responseName,
                                           java.lang.String fieldName,
                                           Field.ConditionalTypeReader<T> conditionalTypeReader)

Factory method for creating a Field instance representing Field.Type.CONDITIONAL.

Type Parameters:

T - type of the conditional

Parameters:

responseName - alias for the result of a field

fieldName - name of the field in the GraphQL operation

conditionalTypeReader - converts the field response to an optional type

Returns:

Field instance representing Field.Type.CONDITIONAL

type

public Field.Type type()

responseName

public java.lang.String responseName()

fieldName

public java.lang.String fieldName()

arguments

public java.util.Map<java.lang.String,java.lang.Object> arguments()

optional

public boolean optional()

cacheKey

public java.lang.String cacheKey(Operation.Variables variables)

resolveArgument

@Nullable
public java.lang.Object resolveArgument(@Nonnull
                                                  java.lang.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