Package com.shopify.graphql.support

Class AbstractResponse<T extends AbstractResponse>

java.lang.Object

com.shopify.graphql.support.AbstractResponse<T>

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

__Directive, __EnumValue, __Field, __InputValue, __Schema, __Type, _EnumValue, _FieldGroup, _FieldShape, _GraphReport, _Path, _RDFNode, _Resource, _TestResult, _TypeShape, _ValidationReport, _ValidationResult, _ValidationResultSuggestion, ConstraintReificationShape, Graph, GraphType, Literal, MasterGraph, RootRDFQuery, User, WorkflowGraph

public abstract class AbstractResponse<T extends AbstractResponse>
extends Object
implements Serializable

Created by dylansmith on 2015-11-23.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
HashMap<String,Object>	optimisticData
HashMap<String,Object>	responseData

Constructor Summary

Constructors

Constructor	Description
AbstractResponse()

Method Summary

Modifier and Type	Method	Description
List<Node>	collectNodes()
Object	get(String field)	Gets a field as a raw object.
com.google.gson.JsonArray	getAsArray(String field)	Tries to deserialise and return the given JSON field as an Array.
Boolean	getAsBoolean(String field)	Tries to deserialise and return the given JSON field as a Boolean.
Double	getAsDouble(String field)	Tries to deserialise and return the given JSON field as a Double.
Integer	getAsInteger(String field)	Tries to deserialise and return the given JSON field as an Integer.
String	getAsString(String field)	Tries to deserialise and return the given JSON field as a String.
protected String	getFieldName(String key)
protected String	getKey(String field)
protected com.google.gson.JsonArray	jsonAsArray(com.google.gson.JsonElement element, String field)
protected Boolean	jsonAsBoolean(com.google.gson.JsonElement element, String field)
protected Double	jsonAsDouble(com.google.gson.JsonElement element, String field)
protected Integer	jsonAsInteger(com.google.gson.JsonElement element, String field)
protected com.google.gson.JsonObject	jsonAsObject(com.google.gson.JsonElement element, String field)
protected String	jsonAsString(com.google.gson.JsonElement element, String field)
protected void	readCustomField(String fieldName, com.google.gson.JsonElement element)	Tries to read a custom field from the GraphQL JSON response.
abstract boolean	unwrapsToObject(String key)
T	withAlias(String aliasSuffix)

Methods inherited from class java.lang.Object

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

Field Detail

responseData

public final HashMap<String,Object> responseData

optimisticData

public final HashMap<String,Object> optimisticData

Constructor Detail

AbstractResponse

public AbstractResponse()

Method Detail

withAlias

public T withAlias(String aliasSuffix)

get

public Object get(String field)

Gets a field as a raw object.

Parameters:

field - The name of the field.

Returns:

The raw object.

getAsString

public String getAsString(String field)
                   throws SchemaViolationError

Tries to deserialise and return the given JSON field as a String. The field itself is expected to be stored in the object data as a JsonElement, which is the case for custom simple fields.

Parameters:

field - The name of the field.

Returns:

The value of the field.

Throws:

SchemaViolationError - If the field cannot be converted to a String.

getAsInteger

public Integer getAsInteger(String field)
                     throws SchemaViolationError

Tries to deserialise and return the given JSON field as an Integer. The field itself is expected to be stored in the object data as a JsonElement, which is the case for custom simple fields.

Parameters:

field - The name of the field.

Returns:

The value of the field.

Throws:

SchemaViolationError - If the field cannot be converted to an Integer.

getAsDouble

public Double getAsDouble(String field)
                   throws SchemaViolationError

Tries to deserialise and return the given JSON field as a Double. The field itself is expected to be stored in the object data as a JsonElement, which is the case for custom simple fields.

Parameters:

field - The name of the field.

Returns:

The value of the field.

Throws:

SchemaViolationError - If the field cannot be converted to a Double.

getAsBoolean

public Boolean getAsBoolean(String field)
                     throws SchemaViolationError

Tries to deserialise and return the given JSON field as a Boolean. The field itself is expected to be stored in the object data as a JsonElement, which is the case for custom simple fields.

Parameters:

field - The name of the field.

Returns:

The value of the field.

Throws:

SchemaViolationError - If the field cannot be converted to a Boolean.

getAsArray

public com.google.gson.JsonArray getAsArray(String field)
                                     throws SchemaViolationError

Tries to deserialise and return the given JSON field as an Array. The field itself is expected to be stored in the object data as a JsonElement, which is the case for custom simple fields.

Parameters:

field - The name of the field.

Returns:

The value of the field.

Throws:

SchemaViolationError - If the field cannot be converted to an Array.

readCustomField

protected void readCustomField(String fieldName,
                               com.google.gson.JsonElement element)
                        throws SchemaViolationError

Tries to read a custom field from the GraphQL JSON response. The method throws a schema violation exception if the field name does not contain the _custom_ alias suffix added by the library, which would indicate that the field does not belong to the GraphQL Schema and was not explicitly requested as a custom field.

Parameters:

fieldName - The field name.

element - The JSON element parsed by the JSON deserialiser.

Throws:

SchemaViolationError - If the field name does not contain the _custom_ suffix.

getFieldName

protected String getFieldName(String key)

getKey

protected String getKey(String field)

jsonAsString

protected String jsonAsString(com.google.gson.JsonElement element,
                              String field)
                       throws SchemaViolationError

Throws:

SchemaViolationError

jsonAsInteger

protected Integer jsonAsInteger(com.google.gson.JsonElement element,
                                String field)
                         throws SchemaViolationError

Throws:

SchemaViolationError

jsonAsDouble

protected Double jsonAsDouble(com.google.gson.JsonElement element,
                              String field)
                       throws SchemaViolationError

Throws:

SchemaViolationError

jsonAsBoolean

protected Boolean jsonAsBoolean(com.google.gson.JsonElement element,
                                String field)
                         throws SchemaViolationError

Throws:

SchemaViolationError

jsonAsObject

protected com.google.gson.JsonObject jsonAsObject(com.google.gson.JsonElement element,
                                                  String field)
                                           throws SchemaViolationError

Throws:

SchemaViolationError

jsonAsArray

protected com.google.gson.JsonArray jsonAsArray(com.google.gson.JsonElement element,
                                                String field)
                                         throws SchemaViolationError

Throws:

SchemaViolationError

collectNodes

public List<Node> collectNodes()

unwrapsToObject

public abstract boolean unwrapsToObject(String key)