com.apollographql.apollo

Interface CustomTypeAdapter<T>

public interface CustomTypeAdapter<T>

CustomTypeAdapter class represents the adapter for converting GraphQL custom scalar types to Java objects.

Defining a custom scalar type adapter

The GraphQL specification includes the following default scalar types: String, Int, Float and Boolean. But often use cases arise when support for custom scalar types is required and for those cases this class should be used to customize conversion. Here's an example of a type adapter for scalar type Date:

   {@code

  CustomTypeAdapter dateCustomTypeAdapter = new CustomTypeAdapter() {

Method Summary

Modifier and Type	Method and Description
T	decode(java.lang.String value) De-serializes the value to the custom scalar type.
java.lang.String	encode(T value) Serializes the custom scalar type to the corresponding string value.

Method Detail

decode

T decode(@Nonnull
         java.lang.String value)

De-serializes the value to the custom scalar type. Usually used in parsing the GraphQL response.

Parameters:

value - the value to de-serialize

Returns:

custom scalar type

encode

@Nonnull
java.lang.String encode(@Nonnull
                                 T value)

Serializes the custom scalar type to the corresponding string value. Usually used in serializing variables or input values.

Parameters:

value - the custom scalar type to serialize

Returns:

serialized string value