com.mopub.volley.toolbox

Class DiskBasedCache

java.lang.Object

com.mopub.volley.toolbox.DiskBasedCache

All Implemented Interfaces:

Cache

public class DiskBasedCache
extends java.lang.Object
implements Cache

Cache implementation that caches files directly onto the hard disk in the specified directory. The default disk usage size is 5MB, but is configurable.

This cache supports the Entry#allResponseHeaders headers field.

Nested Class Summary

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

Cache.Entry

Constructor Summary

Constructors

Constructor and Description
DiskBasedCache(java.io.File rootDirectory) Constructs an instance of the DiskBasedCache at the specified directory using the default maximum cache size of 5MB.
DiskBasedCache(java.io.File rootDirectory, int maxCacheSizeInBytes) Constructs an instance of the DiskBasedCache at the specified directory.

Method Summary

Modifier and Type	Method and Description
void	clear() Clears the cache.
Cache.Entry	get(java.lang.String key) Returns the cache entry with the specified key if it exists, null otherwise.
java.io.File	getFileForKey(java.lang.String key) Returns a file object for the given cache key.
void	initialize() Initializes the DiskBasedCache by scanning for all files currently in the specified root directory.
void	invalidate(java.lang.String key, boolean fullExpire) Invalidates an entry in the cache.
void	put(java.lang.String key, Cache.Entry entry) Puts the entry with the specified key into the cache.
void	remove(java.lang.String key) Removes the specified key from the cache if it exists.

Methods inherited from class java.lang.Object

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

Constructor Detail

DiskBasedCache

public DiskBasedCache(java.io.File rootDirectory,
                      int maxCacheSizeInBytes)

Constructs an instance of the DiskBasedCache at the specified directory.

Parameters:

rootDirectory - The root directory of the cache.

maxCacheSizeInBytes - The maximum size of the cache in bytes. Note that the cache may briefly exceed this size on disk when writing a new entry that pushes it over the limit until the ensuing pruning completes.

DiskBasedCache

public DiskBasedCache(java.io.File rootDirectory)

Constructs an instance of the DiskBasedCache at the specified directory using the default maximum cache size of 5MB.

Parameters:

rootDirectory - The root directory of the cache.

Method Detail

clear

public void clear()

Clears the cache. Deletes all cached files from disk.

Specified by:

clear in interface Cache

get

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

Returns the cache entry with the specified key if it exists, null otherwise.

Specified by:

get in interface Cache

Parameters:

key - Cache key

Returns:

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

initialize

public void initialize()

Initializes the DiskBasedCache by scanning for all files currently in the specified root directory. Creates the root directory if necessary.

Specified by:

initialize in interface Cache

invalidate

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

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

put

public void put(java.lang.String key,
                Cache.Entry entry)

Puts the entry with the specified key into the cache.

Specified by:

put in interface Cache

Parameters:

key - Cache key

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

remove

public void remove(java.lang.String key)

Removes the specified key from the cache if it exists.

Specified by:

remove in interface Cache

Parameters:

key - Cache key

getFileForKey

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

Returns a file object for the given cache key.