com.apollographql.apollo.api.cache.http

Interface HttpCacheStore

public interface HttpCacheStore

CacheStore is an abstraction for a cache store that is used to read, modify or delete http responses.

Method Summary

Modifier and Type	Method and Description
HttpCacheRecord	cacheRecord(String cacheKey) Returns ResponseCacheRecord for the entry named cacheKey or null if it doesn't exist or is not currently readable.
HttpCacheRecordEditor	cacheRecordEditor(String cacheKey) Returns an editor for the entry named cacheKey or null if another edit is in progress.
void	delete() Closes the cache and deletes all of its stored values.
void	remove(String cacheKey) Drops the entry for key if it exists and can be removed.

Method Detail

cacheRecord

@Nullable
HttpCacheRecord cacheRecord(@Nonnull
                                      String cacheKey)
                               throws IOException

Returns ResponseCacheRecord for the entry named cacheKey or null if it doesn't exist or is not currently readable.

Parameters:

cacheKey - the name of the entry

Returns:

ResponseCacheRecord

Throws:

IOException

cacheRecordEditor

@Nullable
HttpCacheRecordEditor cacheRecordEditor(@Nonnull
                                                  String cacheKey)
                                           throws IOException

Returns an editor for the entry named cacheKey or null if another edit is in progress.

Parameters:

cacheKey - the entry to edit.

Returns:

HttpCacheRecordEditor to use for editing the entry

Throws:

IOException

remove

void remove(@Nonnull
            String cacheKey)
     throws IOException

Drops the entry for key if it exists and can be removed. If the entry for key is currently being edited, that edit will complete normally but its value will not be stored.

Throws:

IOException

delete

void delete()
     throws IOException

Closes the cache and deletes all of its stored values. This will delete all files in the cache directory including files that weren't created by the cache.

Throws:

IOException