com.apollographql.apollo.cache.normalized

Class NormalizedCache

java.lang.Object

com.apollographql.apollo.cache.normalized.NormalizedCache

Direct Known Subclasses:

LruNormalizedCache, OptimisticNormalizedCache

public abstract class NormalizedCache
extends java.lang.Object

A provider of Record for reading requests from cache. To serialize a Record to a standardized form use #recordAdapter() which handles call custom scalar types registered on the ApolloClient. If a NormalizedCache cannot return all the records needed to read a response, it will be considered a cache miss. A NormalizedCache is recommended to implement support for CacheHeaders specified in ApolloCacheHeaders. A NormalizedCache can choose to store records in any manner. See LruNormalizedCache for a in memory cache.

Constructor Summary

Constructors

Constructor and Description
NormalizedCache()

Method Summary

Modifier and Type	Method and Description
NormalizedCache	chain(NormalizedCache cache)
abstract void	clearAll() Clears all records from the cache.
java.util.Map<java.lang.Class,java.util.Map<java.lang.String,Record>>	dump()
abstract Record	loadRecord(java.lang.String key, CacheHeaders cacheHeaders)
java.util.Collection<Record>	loadRecords(java.util.Collection<java.lang.String> keys, CacheHeaders cacheHeaders) Calls through to loadRecord(String, CacheHeaders).
java.util.Set<java.lang.String>	merge(java.util.Collection<Record> recordSet, CacheHeaders cacheHeaders) Calls through to merge(Record, CacheHeaders).
java.util.Set<java.lang.String>	merge(Record record, CacheHeaders cacheHeaders)
com.apollographql.apollo.api.internal.Optional<NormalizedCache>	nextCache()
protected abstract java.util.Set<java.lang.String>	performMerge(Record apolloRecord, CacheHeaders cacheHeaders)
static java.lang.String	prettifyDump(java.util.Map<java.lang.Class,java.util.Map<java.lang.String,Record>> dump)
boolean	remove(CacheKey cacheKey) Remove cached record by the key
abstract boolean	remove(CacheKey cacheKey, boolean cascade) Remove cached record by the key

Methods inherited from class java.lang.Object

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

Constructor Detail

NormalizedCache

public NormalizedCache()

Method Detail

loadRecord

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

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.

loadRecords

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

Calls through to loadRecord(String, CacheHeaders). Implementations should override this method if the underlying storage technology can offer an optimized manner to read multiple records.

Parameters:

keys - The set of Record keys to read.

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

merge

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

Parameters:

record - 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).

merge

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

Calls through to merge(Record, CacheHeaders). Implementations should override this method if the underlying storage technology can offer an optimized manner to store multiple records.

Parameters:

recordSet - The set of Records 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).

performMerge

@NotNull
protected abstract java.util.Set<java.lang.String> performMerge(@NotNull
                                                                         Record apolloRecord,
                                                                         @NotNull
                                                                         CacheHeaders cacheHeaders)

clearAll

public abstract void clearAll()

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

remove

public boolean remove(@NotNull
                      CacheKey cacheKey)

Remove cached record by the key

Parameters:

cacheKey - of record to be removed

Returns:

true if record with such key was successfully removed, false otherwise

remove

public abstract boolean remove(@NotNull
                               CacheKey cacheKey,
                               boolean cascade)

Remove cached record by the key

Parameters:

cacheKey - of record to be removed

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

Returns:

true if record with such key was successfully removed, false otherwise

chain

public final NormalizedCache chain(@NotNull
                                   NormalizedCache cache)

nextCache

public final com.apollographql.apollo.api.internal.Optional<NormalizedCache> nextCache()

dump

public java.util.Map<java.lang.Class,java.util.Map<java.lang.String,Record>> dump()

prettifyDump

public static java.lang.String prettifyDump(java.util.Map<java.lang.Class,java.util.Map<java.lang.String,Record>> dump)