com.android.volley

Class AsyncCache

java.lang.Object

com.android.volley.AsyncCache

Direct Known Subclasses:

NoAsyncCache

public abstract class AsyncCache
extends java.lang.Object

Asynchronous equivalent to the Cache interface.

WARNING: This API is experimental and subject to breaking changes. Please see https://github.com/google/volley/wiki/Asynchronous-Volley for more details.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AsyncCache.OnGetCompleteCallback
static interface	AsyncCache.OnWriteCompleteCallback

Constructor Summary

Constructors

Constructor and Description
AsyncCache()

Method Summary

Modifier and Type	Method and Description
abstract void	clear(AsyncCache.OnWriteCompleteCallback callback) Clears the cache.
abstract void	get(java.lang.String key, AsyncCache.OnGetCompleteCallback callback) Retrieves an entry from the cache and sends it back through the AsyncCache.OnGetCompleteCallback.onGetComplete(com.android.volley.Cache.Entry) function
abstract void	initialize(AsyncCache.OnWriteCompleteCallback callback) Initializes the cache and calls AsyncCache.OnWriteCompleteCallback.onWriteComplete() after the operation is finished.
abstract void	invalidate(java.lang.String key, boolean fullExpire, AsyncCache.OnWriteCompleteCallback callback) Invalidates an entry in the cache and calls AsyncCache.OnWriteCompleteCallback.onWriteComplete() after the operation is finished.
abstract void	put(java.lang.String key, Cache.Entry entry, AsyncCache.OnWriteCompleteCallback callback) Writes a Cache.Entry to the cache, and calls AsyncCache.OnWriteCompleteCallback.onWriteComplete() after the operation is finished.
abstract void	remove(java.lang.String key, AsyncCache.OnWriteCompleteCallback callback) Removes a Cache.Entry from the cache, and calls AsyncCache.OnWriteCompleteCallback.onWriteComplete() after the operation is finished.

Methods inherited from class java.lang.Object

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

Constructor Detail

AsyncCache

public AsyncCache()

Method Detail

get

public abstract void get(java.lang.String key,
                         AsyncCache.OnGetCompleteCallback callback)

Retrieves an entry from the cache and sends it back through the AsyncCache.OnGetCompleteCallback.onGetComplete(com.android.volley.Cache.Entry) function

Parameters:

key - Cache key

callback - Callback that will be notified when the information has been retrieved

put

public abstract void put(java.lang.String key,
                         Cache.Entry entry,
                         AsyncCache.OnWriteCompleteCallback callback)

Writes a Cache.Entry to the cache, and calls AsyncCache.OnWriteCompleteCallback.onWriteComplete() after the operation is finished.

Parameters:

key - Cache key

entry - The entry to be written to the cache

callback - Callback that will be notified when the information has been written

clear

public abstract void clear(AsyncCache.OnWriteCompleteCallback callback)

Clears the cache. Deletes all cached files from disk. Calls AsyncCache.OnWriteCompleteCallback.onWriteComplete() after the operation is finished.

initialize

public abstract void initialize(AsyncCache.OnWriteCompleteCallback callback)

Initializes the cache and calls AsyncCache.OnWriteCompleteCallback.onWriteComplete() after the operation is finished.

invalidate

public abstract void invalidate(java.lang.String key,
                                boolean fullExpire,
                                AsyncCache.OnWriteCompleteCallback callback)

Invalidates an entry in the cache and calls AsyncCache.OnWriteCompleteCallback.onWriteComplete() after the operation is finished.

Parameters:

key - Cache key

fullExpire - True to fully expire the entry, false to soft expire

callback - Callback that's invoked once the entry has been invalidated

remove

public abstract void remove(java.lang.String key,
                            AsyncCache.OnWriteCompleteCallback callback)

Removes a Cache.Entry from the cache, and calls AsyncCache.OnWriteCompleteCallback.onWriteComplete() after the operation is finished.

Parameters:

key - Cache key

callback - Callback that's invoked once the entry has been removed