com.apollographql.apollo.cache.normalized.lru

Class LruNormalizedCache

java.lang.Object

com.apollographql.apollo.cache.normalized.NormalizedCache

com.apollographql.apollo.cache.normalized.lru.LruNormalizedCache

public final class LruNormalizedCache
extends NormalizedCache

A NormalizedCache backed by an in memory Cache. Can be configured with an optional secondaryCache NormalizedCache, which will be used as a backup if a Record is not present in the primary cache. A common configuration is to have secondary SQL cache.

Method Summary

Modifier and Type	Method and Description
void	clearAll() Clears all records from the cache.
void	clearPrimaryCache() Clears all records from the in-memory LRU cache.
void	clearSecondaryCache() Clear all records from the secondary cache.
Record	loadRecord(java.lang.String key, CacheHeaders cacheHeaders)
java.util.Set<java.lang.String>	merge(Record apolloRecord, CacheHeaders cacheHeaders)
NormalizedCache	secondaryCache()

Methods inherited from class com.apollographql.apollo.cache.normalized.NormalizedCache

loadRecords, merge, recordAdapter

Methods inherited from class java.lang.Object

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

Method Detail

secondaryCache

@Nullable
public NormalizedCache secondaryCache()

loadRecord

@Nullable
public Record loadRecord(@Nonnull
                                   java.lang.String key,
                                   @Nonnull
                                   CacheHeaders cacheHeaders)

Specified by:

loadRecord in class NormalizedCache

Parameters:

key - The key of the record to read.

cacheHeaders - The cache headers associated with the request which generated this record.

Returns:

The Record for key. If not present return null.

merge

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

Specified by:

merge in class NormalizedCache

Parameters:

apolloRecord - The Record to merge.

cacheHeaders - The CacheHeaders associated with the request which generated this record.

Returns:

A set of record field keys that have changed. This set is returned by Record.mergeWith(Record).

clearAll

public void clearAll()

Description copied from class: NormalizedCache

Clears all records from the cache. Clients should call ApolloClient.clearNormalizedCache() for a thread-safe access to this method.

Specified by:

clearAll in class NormalizedCache

clearPrimaryCache

public void clearPrimaryCache()

Clears all records from the in-memory LRU cache. The secondary cache will *not* be cleared. This method is **not** guaranteed to be thread safe. It should be run inside a write transaction in ApolloStore, obtained from ApolloClient.apolloStore().

clearSecondaryCache

public void clearSecondaryCache()

Clear all records from the secondary cache. Records in the in-memory LRU cache will remain. This method is **not** guaranteed to be thread safe. It should be run inside a write transaction in ApolloStore, obtained from ApolloClient.apolloStore().