com.apollographql.apollo.internal.cache.normalized

Class RealApolloStore

java.lang.Object

com.apollographql.apollo.internal.cache.normalized.RealApolloStore

All Implemented Interfaces:

ApolloStore, ReadableStore, WriteableStore

public final class RealApolloStore
extends java.lang.Object
implements ApolloStore, ReadableStore, WriteableStore

Nested Class Summary

Nested classes/interfaces inherited from interface com.apollographql.apollo.cache.normalized.ApolloStore

ApolloStore.RecordChangeSubscriber

Field Summary

Fields inherited from interface com.apollographql.apollo.cache.normalized.ApolloStore

NO_APOLLO_STORE

Constructor Summary

Constructors

Constructor and Description
RealApolloStore(NormalizedCache normalizedCache, CacheKeyResolver cacheKeyResolver, com.apollographql.apollo.api.ScalarTypeAdapters scalarTypeAdapters, java.util.concurrent.Executor dispatcher, com.apollographql.apollo.api.internal.ApolloLogger logger)

Method Summary

Modifier and Type	Method and Description
CacheKeyResolver	cacheKeyResolver()
ResponseNormalizer<Record>	cacheResponseNormalizer()
ApolloStoreOperation<java.lang.Boolean>	clearAll() Clear all records from this ApolloStore.
java.util.Set<java.lang.String>	merge(java.util.Collection<Record> recordSet, CacheHeaders cacheHeaders)
java.util.Set<java.lang.String>	merge(Record record, CacheHeaders cacheHeaders)
ResponseNormalizer<java.util.Map<java.lang.String,java.lang.Object>>	networkResponseNormalizer()
NormalizedCache	normalizedCache()
void	publish(java.util.Set<java.lang.String> changedKeys)
java.util.Collection<Record>	read(java.util.Collection<java.lang.String> keys, CacheHeaders cacheHeaders)
<D extends com.apollographql.apollo.api.Operation.Data,T,V extends com.apollographql.apollo.api.Operation.Variables> ApolloStoreOperation<T>	read(com.apollographql.apollo.api.Operation<D,T,V> operation) Read GraphQL operation from store.
<D extends com.apollographql.apollo.api.Operation.Data,T,V extends com.apollographql.apollo.api.Operation.Variables> ApolloStoreOperation<com.apollographql.apollo.api.Response<T>>	read(com.apollographql.apollo.api.Operation<D,T,V> operation, com.apollographql.apollo.api.internal.ResponseFieldMapper<D> responseFieldMapper, ResponseNormalizer<Record> responseNormalizer, CacheHeaders cacheHeaders) Read GraphQL operation response from store.
<F extends com.apollographql.apollo.api.GraphqlFragment> ApolloStoreOperation<F>	read(com.apollographql.apollo.api.internal.ResponseFieldMapper<F> responseFieldMapper, CacheKey cacheKey, com.apollographql.apollo.api.Operation.Variables variables) Read GraphQL fragment from store.
Record	read(java.lang.String key, CacheHeaders cacheHeaders)
<R> R	readTransaction(Transaction<ReadableStore,R> transaction) Run a operation inside a read-lock.
ApolloStoreOperation<java.lang.Boolean>	remove(CacheKey cacheKey) Remove cache record by the key
ApolloStoreOperation<java.lang.Boolean>	remove(CacheKey cacheKey, boolean cascade) Remove cache record by the key
ApolloStoreOperation<java.lang.Integer>	remove(java.util.List<CacheKey> cacheKeys) Remove cache records by the list of keys
ApolloStoreOperation<java.util.Set<java.lang.String>>	rollbackOptimisticUpdates(java.util.UUID mutationId) Rollback operation data optimistic updates.
ApolloStoreOperation<java.lang.Boolean>	rollbackOptimisticUpdatesAndPublish(java.util.UUID mutationId) Rollback operation data optimistic updates and publish changes of Records which have changed, that will notify any that depends on these Record to re-fetch.
void	subscribe(ApolloStore.RecordChangeSubscriber subscriber)
void	unsubscribe(ApolloStore.RecordChangeSubscriber subscriber)
ApolloStoreOperation<java.util.Set<java.lang.String>>	write(com.apollographql.apollo.api.GraphqlFragment fragment, CacheKey cacheKey, com.apollographql.apollo.api.Operation.Variables variables) Write fragment to the store.
<D extends com.apollographql.apollo.api.Operation.Data,T,V extends com.apollographql.apollo.api.Operation.Variables> ApolloStoreOperation<java.util.Set<java.lang.String>>	write(com.apollographql.apollo.api.Operation<D,T,V> operation, D operationData) Write operation to the store.
ApolloStoreOperation<java.lang.Boolean>	writeAndPublish(com.apollographql.apollo.api.GraphqlFragment fragment, CacheKey cacheKey, com.apollographql.apollo.api.Operation.Variables variables) Write fragment to the store and publish changes of Record which have changed, that will notify any ApolloQueryWatcher that depends on these Record to re-fetch.
<D extends com.apollographql.apollo.api.Operation.Data,T,V extends com.apollographql.apollo.api.Operation.Variables> ApolloStoreOperation<java.lang.Boolean>	writeAndPublish(com.apollographql.apollo.api.Operation<D,T,V> operation, D operationData) Write operation to the store and publish changes of Record which have changed, that will notify any ApolloQueryWatcher that depends on these Record to re-fetch.
<D extends com.apollographql.apollo.api.Operation.Data,T,V extends com.apollographql.apollo.api.Operation.Variables> ApolloStoreOperation<java.util.Set<java.lang.String>>	writeOptimisticUpdates(com.apollographql.apollo.api.Operation<D,T,V> operation, D operationData, java.util.UUID mutationId) Write operation data to the optimistic store.
<D extends com.apollographql.apollo.api.Operation.Data,T,V extends com.apollographql.apollo.api.Operation.Variables> ApolloStoreOperation<java.lang.Boolean>	writeOptimisticUpdatesAndPublish(com.apollographql.apollo.api.Operation<D,T,V> operation, D operationData, java.util.UUID mutationId) Write operation data to the optimistic store and publish changes of Records which have changed, that will notify any that depends on these Record to re-fetch.
<R> R	writeTransaction(Transaction<WriteableStore,R> transaction) Run a operation inside a write-lock.

Methods inherited from class java.lang.Object

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

Constructor Detail

RealApolloStore

public RealApolloStore(@NotNull
                       NormalizedCache normalizedCache,
                       @NotNull
                       CacheKeyResolver cacheKeyResolver,
                       @NotNull
                       com.apollographql.apollo.api.ScalarTypeAdapters scalarTypeAdapters,
                       @NotNull
                       java.util.concurrent.Executor dispatcher,
                       @NotNull
                       com.apollographql.apollo.api.internal.ApolloLogger logger)

Method Detail

networkResponseNormalizer

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

Specified by:

networkResponseNormalizer in interface ApolloStore

Returns:

The ResponseNormalizer used to generate normalized records from the network.

cacheResponseNormalizer

public ResponseNormalizer<Record> cacheResponseNormalizer()

Specified by:

cacheResponseNormalizer in interface ApolloStore

Returns:

The ResponseNormalizer used to generate normalized records from the cache.

subscribe

public void subscribe(ApolloStore.RecordChangeSubscriber subscriber)

Specified by:

subscribe in interface ApolloStore

unsubscribe

public void unsubscribe(ApolloStore.RecordChangeSubscriber subscriber)

Specified by:

unsubscribe in interface ApolloStore

publish

public void publish(@NotNull
                    java.util.Set<java.lang.String> changedKeys)

Specified by:

publish in interface ApolloStore

Parameters:

changedKeys - A set of keys of Record which have changed.

clearAll

@NotNull
public ApolloStoreOperation<java.lang.Boolean> clearAll()

Description copied from interface: ApolloStore

Clear all records from this ApolloStore.

Specified by:

clearAll in interface ApolloStore

Returns:

to be performed, that will be resolved with true if all records was successfully removed, false otherwise

remove

@NotNull
public ApolloStoreOperation<java.lang.Boolean> remove(@NotNull
                                                               CacheKey cacheKey)

Description copied from interface: ApolloStore

Remove cache record by the key

Specified by:

remove in interface ApolloStore

Parameters:

cacheKey - of record to be removed

Returns:

to be performed, that will be resolved with true if record with such key was successfully removed, false otherwise

remove

@NotNull
public ApolloStoreOperation<java.lang.Boolean> remove(@NotNull
                                                               CacheKey cacheKey,
                                                               boolean cascade)

Description copied from interface: ApolloStore

Remove cache record by the key

Specified by:

remove in interface ApolloStore

Parameters:

cacheKey - of record to be removed

cascade - defines if remove operation is propagated to the referenced entities

Returns:

to be performed, that will be resolved with true if record with such key was successfully removed, false otherwise

remove

@NotNull
public ApolloStoreOperation<java.lang.Integer> remove(@NotNull
                                                               java.util.List<CacheKey> cacheKeys)

Description copied from interface: ApolloStore

Remove cache records by the list of keys

Specified by:

remove in interface ApolloStore

Parameters:

cacheKeys - keys of records to be removed

Returns:

to be performed, that will be resolved with the count of records been removed

readTransaction

public <R> R readTransaction(Transaction<ReadableStore,R> transaction)

Description copied from interface: ApolloStore

Run a operation inside a read-lock. Blocks until read-lock is acquired.

Specified by:

readTransaction in interface ApolloStore

Type Parameters:

R - The result type of this read operation.

Parameters:

transaction - A code block to run once the read lock is acquired.

Returns:

A result from the read operation.

writeTransaction

public <R> R writeTransaction(Transaction<WriteableStore,R> transaction)

Description copied from interface: ApolloStore

Run a operation inside a write-lock. Blocks until write-lock is acquired.

Specified by:

writeTransaction in interface ApolloStore

Type Parameters:

R - The result type of this write operation.

Parameters:

transaction - A code block to run once the write lock is acquired.

Returns:

A result from the write operation.

normalizedCache

public NormalizedCache normalizedCache()

Specified by:

normalizedCache in interface ApolloStore

Returns:

The NormalizedCache which backs this ApolloStore.

read

@Nullable
public Record read(@NotNull
                             java.lang.String key,
                             @NotNull
                             CacheHeaders cacheHeaders)

Specified by:

read in interface ReadableStore

read

@NotNull
public java.util.Collection<Record> read(@NotNull
                                                  java.util.Collection<java.lang.String> keys,
                                                  @NotNull
                                                  CacheHeaders cacheHeaders)

Specified by:

read in interface ReadableStore

merge

@NotNull
public java.util.Set<java.lang.String> merge(@NotNull
                                                      java.util.Collection<Record> recordSet,
                                                      @NotNull
                                                      CacheHeaders cacheHeaders)

Specified by:

merge in interface WriteableStore

merge

public java.util.Set<java.lang.String> merge(Record record,
                                             @NotNull
                                             CacheHeaders cacheHeaders)

Specified by:

merge in interface WriteableStore

cacheKeyResolver

public CacheKeyResolver cacheKeyResolver()

Specified by:

cacheKeyResolver in interface ApolloStore

Returns:

the CacheKeyResolver used for resolving field cache keys

read

@NotNull
public <D extends com.apollographql.apollo.api.Operation.Data,T,V extends com.apollographql.apollo.api.Operation.Variables> ApolloStoreOperation<T> read(@NotNull
                                                                                                                                                                  com.apollographql.apollo.api.Operation<D,T,V> operation)

Description copied from interface: ApolloStore

Read GraphQL operation from store.

Specified by:

read in interface ApolloStore

Type Parameters:

D - type of GraphQL operation data

T - type operation cached data will be wrapped with

V - type of operation variables

Parameters:

operation - to be read

Returns:

to be performed, that will be resolved with cached data for specified operation

read

@NotNull
public <D extends com.apollographql.apollo.api.Operation.Data,T,V extends com.apollographql.apollo.api.Operation.Variables> ApolloStoreOperation<com.apollographql.apollo.api.Response<T>> read(@NotNull
                                                                                                                                                                                                         com.apollographql.apollo.api.Operation<D,T,V> operation,
                                                                                                                                                                                                         @NotNull
                                                                                                                                                                                                         com.apollographql.apollo.api.internal.ResponseFieldMapper<D> responseFieldMapper,
                                                                                                                                                                                                         @NotNull
                                                                                                                                                                                                         ResponseNormalizer<Record> responseNormalizer,
                                                                                                                                                                                                         @NotNull
                                                                                                                                                                                                         CacheHeaders cacheHeaders)

Description copied from interface: ApolloStore

Read GraphQL operation response from store.

Specified by:

read in interface ApolloStore

Type Parameters:

D - type of GraphQL operation data

T - type operation cached data will be wrapped with

V - type of operation variables

Parameters:

operation - response of which should be read

responseFieldMapper - ResponseFieldMapper to be used for field mapping

responseNormalizer - ResponseNormalizer to be used when reading cached response

cacheHeaders - CacheHeaders to be used when reading cached response

Returns:

to be performed, that will be resolved with cached response for specified operation

read

@NotNull
public <F extends com.apollographql.apollo.api.GraphqlFragment> ApolloStoreOperation<F> read(@NotNull
                                                                                                      com.apollographql.apollo.api.internal.ResponseFieldMapper<F> responseFieldMapper,
                                                                                                      @NotNull
                                                                                                      CacheKey cacheKey,
                                                                                                      @NotNull
                                                                                                      com.apollographql.apollo.api.Operation.Variables variables)

Description copied from interface: ApolloStore

Read GraphQL fragment from store.

Specified by:

read in interface ApolloStore

Type Parameters:

F - type of fragment to be read

Parameters:

responseFieldMapper - ResponseFieldMapper to be used for field mapping

cacheKey - CacheKey to be used to find cache record for the fragment

variables - Operation.Variables required for fragment arguments resolving

Returns:

to be performed, that will be resolved with cached fragment data

write

@NotNull
public <D extends com.apollographql.apollo.api.Operation.Data,T,V extends com.apollographql.apollo.api.Operation.Variables> ApolloStoreOperation<java.util.Set<java.lang.String>> write(@NotNull
                                                                                                                                                                                                 com.apollographql.apollo.api.Operation<D,T,V> operation,
                                                                                                                                                                                                 @NotNull
                                                                                                                                                                                                 D operationData)

Description copied from interface: ApolloStore

Write operation to the store.

Specified by:

write in interface ApolloStore

Type Parameters:

D - type of GraphQL operation data

T - type operation cached data will be wrapped with

V - type of operation variables

Parameters:

operation - Operation response data of which should be written to the store

operationData - Operation.Data operation response data to be written to the store

Returns:

to be performed, that will be resolved with set of keys of Record which have changed

writeAndPublish

@NotNull
public <D extends com.apollographql.apollo.api.Operation.Data,T,V extends com.apollographql.apollo.api.Operation.Variables> ApolloStoreOperation<java.lang.Boolean> writeAndPublish(@NotNull
                                                                                                                                                                                             com.apollographql.apollo.api.Operation<D,T,V> operation,
                                                                                                                                                                                             @NotNull
                                                                                                                                                                                             D operationData)

Description copied from interface: ApolloStore

Write operation to the store and publish changes of Record which have changed, that will notify any ApolloQueryWatcher that depends on these Record to re-fetch.

Specified by:

writeAndPublish in interface ApolloStore

Type Parameters:

D - type of GraphQL operation data

T - type operation cached data will be wrapped with

V - type of operation variables

Parameters:

operation - Operation response data of which should be written to the store

operationData - Operation.Data operation response data to be written to the store

Returns:

to be performed

write

@NotNull
public ApolloStoreOperation<java.util.Set<java.lang.String>> write(@NotNull
                                                                            com.apollographql.apollo.api.GraphqlFragment fragment,
                                                                            @NotNull
                                                                            CacheKey cacheKey,
                                                                            @NotNull
                                                                            com.apollographql.apollo.api.Operation.Variables variables)

Description copied from interface: ApolloStore

Write fragment to the store.

Specified by:

write in interface ApolloStore

Parameters:

fragment - data to be written to the store

cacheKey - CacheKey to be used as root record key

Returns:

to be performed, that will be resolved with set of keys of Record which have changed

writeAndPublish

@NotNull
public ApolloStoreOperation<java.lang.Boolean> writeAndPublish(@NotNull
                                                                        com.apollographql.apollo.api.GraphqlFragment fragment,
                                                                        @NotNull
                                                                        CacheKey cacheKey,
                                                                        @NotNull
                                                                        com.apollographql.apollo.api.Operation.Variables variables)

Description copied from interface: ApolloStore

Write fragment to the store and publish changes of Record which have changed, that will notify any ApolloQueryWatcher that depends on these Record to re-fetch.

Specified by:

writeAndPublish in interface ApolloStore

Parameters:

fragment - data to be written to the store

cacheKey - CacheKey to be used as root record key

Returns:

to be performed

writeOptimisticUpdates

@NotNull
public <D extends com.apollographql.apollo.api.Operation.Data,T,V extends com.apollographql.apollo.api.Operation.Variables> ApolloStoreOperation<java.util.Set<java.lang.String>> writeOptimisticUpdates(@NotNull
                                                                                                                                                                                                                  com.apollographql.apollo.api.Operation<D,T,V> operation,
                                                                                                                                                                                                                  @NotNull
                                                                                                                                                                                                                  D operationData,
                                                                                                                                                                                                                  @NotNull
                                                                                                                                                                                                                  java.util.UUID mutationId)

Description copied from interface: ApolloStore

Write operation data to the optimistic store.

Specified by:

writeOptimisticUpdates in interface ApolloStore

Parameters:

operation - Operation response data of which should be written to the store

operationData - Operation.Data operation response data to be written to the store

mutationId - mutation unique identifier

Returns:

to be performed, that will be resolved with set of keys of Record which have changed

writeOptimisticUpdatesAndPublish

@NotNull
public <D extends com.apollographql.apollo.api.Operation.Data,T,V extends com.apollographql.apollo.api.Operation.Variables> ApolloStoreOperation<java.lang.Boolean> writeOptimisticUpdatesAndPublish(@NotNull
                                                                                                                                                                                                              com.apollographql.apollo.api.Operation<D,T,V> operation,
                                                                                                                                                                                                              @NotNull
                                                                                                                                                                                                              D operationData,
                                                                                                                                                                                                              @NotNull
                                                                                                                                                                                                              java.util.UUID mutationId)

Description copied from interface: ApolloStore

Write operation data to the optimistic store and publish changes of Records which have changed, that will notify any that depends on these Record to re-fetch.

Specified by:

writeOptimisticUpdatesAndPublish in interface ApolloStore

Parameters:

operation - Operation response data of which should be written to the store

operationData - Operation.Data operation response data to be written to the store

mutationId - mutation unique identifier

Returns:

to be performed

rollbackOptimisticUpdates

@NotNull
public ApolloStoreOperation<java.util.Set<java.lang.String>> rollbackOptimisticUpdates(@NotNull
                                                                                                java.util.UUID mutationId)

Description copied from interface: ApolloStore

Rollback operation data optimistic updates.

Specified by:

rollbackOptimisticUpdates in interface ApolloStore

Parameters:

mutationId - mutation unique identifier

Returns:

to be performed

rollbackOptimisticUpdatesAndPublish

@NotNull
public ApolloStoreOperation<java.lang.Boolean> rollbackOptimisticUpdatesAndPublish(@NotNull
                                                                                            java.util.UUID mutationId)

Description copied from interface: ApolloStore

Rollback operation data optimistic updates and publish changes of Records which have changed, that will notify any that depends on these Record to re-fetch.

Specified by:

rollbackOptimisticUpdatesAndPublish in interface ApolloStore

Parameters:

mutationId - mutation unique identifier

Returns:

to be performed, that will be resolved with set of keys of Record which have changed