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, java.util.Map<com.apollographql.apollo.api.ScalarType,CustomTypeAdapter> customTypeAdapters, ApolloLogger logger)

Method Summary

Modifier and Type	Method and Description
CacheKeyResolver	cacheKeyResolver()
ResponseNormalizer<Record>	cacheResponseNormalizer()
void	clearAll() Clear all records from this ApolloStore.
java.util.Set<java.lang.String>	merge(java.util.Collection<Record> recordSet, 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> 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> com.apollographql.apollo.api.Response<T>	read(com.apollographql.apollo.api.Operation<D,T,V> operation, com.apollographql.apollo.api.ResponseFieldMapper<D> responseFieldMapper, ResponseNormalizer<Record> responseNormalizer, CacheHeaders cacheHeaders) Read GraphQL operation response from store.
<F extends com.apollographql.apollo.api.GraphqlFragment> F	read(com.apollographql.apollo.api.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.
void	subscribe(ApolloStore.RecordChangeSubscriber subscriber)
void	unsubscribe(ApolloStore.RecordChangeSubscriber subscriber)
<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(@Nonnull
                       NormalizedCache normalizedCache,
                       @Nonnull
                       CacheKeyResolver cacheKeyResolver,
                       @Nonnull
                       java.util.Map<com.apollographql.apollo.api.ScalarType,CustomTypeAdapter> customTypeAdapters,
                       @Nonnull
                       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(@Nonnull
                    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

public void clearAll()

Description copied from interface: ApolloStore

Clear all records from this ApolloStore.

Specified by:

clearAll in interface ApolloStore

Specified by:

clearAll in interface WriteableStore

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(@Nonnull
                             java.lang.String key,
                             @Nonnull
                             CacheHeaders cacheHeaders)

Specified by:

read in interface ReadableStore

read

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

Specified by:

read in interface ReadableStore

merge

@Nonnull
public java.util.Set<java.lang.String> merge(@Nonnull
                                                      java.util.Collection<Record> recordSet,
                                                      @Nonnull
                                                      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

@Nullable
public <D extends com.apollographql.apollo.api.Operation.Data,T,V extends com.apollographql.apollo.api.Operation.Variables> T read(@Nonnull
                                                                                                                                             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:

cached data for specified operation

read

@Nonnull
public <D extends com.apollographql.apollo.api.Operation.Data,T,V extends com.apollographql.apollo.api.Operation.Variables> com.apollographql.apollo.api.Response<T> read(@Nonnull
                                                                                                                                                                                   com.apollographql.apollo.api.Operation<D,T,V> operation,
                                                                                                                                                                                   @Nonnull
                                                                                                                                                                                   com.apollographql.apollo.api.ResponseFieldMapper<D> responseFieldMapper,
                                                                                                                                                                                   @Nonnull
                                                                                                                                                                                   ResponseNormalizer<Record> responseNormalizer,
                                                                                                                                                                                   @Nonnull
                                                                                                                                                                                   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:

cached response for specified operation

read

@Nullable
public <F extends com.apollographql.apollo.api.GraphqlFragment> F read(@Nonnull
                                                                                 com.apollographql.apollo.api.ResponseFieldMapper<F> responseFieldMapper,
                                                                                 @Nonnull
                                                                                 CacheKey cacheKey,
                                                                                 @Nonnull
                                                                                 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