com.android.volley.cache

Class DiskLruBasedCache

java.lang.Object

com.android.volley.cache.DiskLruBasedCache

All Implemented Interfaces:

Cache

public class DiskLruBasedCache
extends java.lang.Object
implements Cache

Cache implementation that caches files directly onto the hard disk in the specified directory using DiskLruCache

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DiskLruBasedCache.ImageCacheParams A holder class that contains cache parameters.

Nested classes/interfaces inherited from interface com.android.volley.Cache

Cache.Entry

Constructor Summary

Constructors

Constructor and Description
DiskLruBasedCache(DiskLruBasedCache.ImageCacheParams cacheParams)
DiskLruBasedCache(java.io.File root)

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Empties the cache.
void	clearCache()
void	close() Closes the disk cache associated with this ImageCache object.
boolean	containsKey(java.lang.String key)
void	flush() Flushes the disk cache associated with this ImageCache object.
Cache.Entry	get(java.lang.String data) Retrieves an entry from the cache.
android.graphics.Bitmap	getBitmap(java.lang.String data)
java.io.File	getCacheFolder()
java.io.File	getFileForKey(java.lang.String key) Returns a file object for the given cache key.
static java.lang.String	hashKeyForDisk(java.lang.String key) A hashing method that changes a string (like a URL) into a hash suitable for using as a disk filename.
void	initDiskCache() Initializes the disk cache.
void	initialize() Performs any potentially long-running actions needed to initialize the cache; will be called from a worker thread.
void	invalidate(java.lang.String key, boolean fullExpire) Invalidates an entry in the cache.
void	put(java.lang.String data, Cache.Entry value) Adds or replaces an entry to the cache.
void	putBitmap(java.lang.String data, android.graphics.Bitmap value)
void	remove(java.lang.String data) Removes an entry from the cache.

Methods inherited from class java.lang.Object

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

Constructor Detail

DiskLruBasedCache

public DiskLruBasedCache(java.io.File root)

DiskLruBasedCache

public DiskLruBasedCache(DiskLruBasedCache.ImageCacheParams cacheParams)

Method Detail

putBitmap

public void putBitmap(java.lang.String data,
             android.graphics.Bitmap value)

getBitmap

public android.graphics.Bitmap getBitmap(java.lang.String data)

containsKey

public boolean containsKey(java.lang.String key)

clearCache

public void clearCache()

getCacheFolder

public java.io.File getCacheFolder()

initDiskCache

public void initDiskCache()

Initializes the disk cache. Note that this includes disk access so this should not be executed on the main/UI thread. By default an ImageCache does not initialize the disk cache when it is created, instead you should call initDiskCache() to initialize it on a background thread.

hashKeyForDisk

public static java.lang.String hashKeyForDisk(java.lang.String key)

A hashing method that changes a string (like a URL) into a hash suitable for using as a disk filename.

getFileForKey

public java.io.File getFileForKey(java.lang.String key)

Returns a file object for the given cache key.

get

public Cache.Entry get(java.lang.String data)

Description copied from interface: Cache

Retrieves an entry from the cache.

Specified by:

get in interface Cache

Parameters:

data - Cache key

Returns:

An Cache.Entry or null in the event of a cache miss

put

public void put(java.lang.String data,
       Cache.Entry value)

Description copied from interface: Cache

Adds or replaces an entry to the cache.

Specified by:

put in interface Cache

Parameters:

data - Cache key

value - Data to store and metadata for cache coherency, TTL, etc.

initialize

public void initialize()

Description copied from interface: Cache

Performs any potentially long-running actions needed to initialize the cache; will be called from a worker thread.

Specified by:

initialize in interface Cache

invalidate

public void invalidate(java.lang.String key,
              boolean fullExpire)

Description copied from interface: Cache

Invalidates an entry in the cache.

Specified by:

invalidate in interface Cache

Parameters:

key - Cache key

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

remove

public void remove(java.lang.String data)

Description copied from interface: Cache

Removes an entry from the cache.

Specified by:

remove in interface Cache

Parameters:

data - Cache key

clear

public void clear()

Description copied from interface: Cache

Empties the cache.

Specified by:

clear in interface Cache

flush

public void flush()

Flushes the disk cache associated with this ImageCache object. Note that this includes disk access so this should not be executed on the main/UI thread.

Specified by:

flush in interface Cache

close

public void close()

Closes the disk cache associated with this ImageCache object. Note that this includes disk access so this should not be executed on the main/UI thread.

Specified by:

close in interface Cache