com.isaacrf.epicbitmaprenderer.core

Class EpicBitmapCache

java.lang.Object

com.isaacrf.epicbitmaprenderer.core.EpicBitmapCache

public class EpicBitmapCache
extends java.lang.Object

An epic Bitmap cache to store data on both memory and disk cache. This class auto manages caches concurrency, size and exposes methods for handling.

Constructor Summary

Constructors

Constructor and Description
EpicBitmapCache() Basic constructor, builds the memory cache automatically.

Method Summary

Modifier and Type	Method and Description
void	clear() Deletes memory and disk cache contents.
android.graphics.Bitmap	getBitmapFromCache(java.lang.String key) Tries to retrieve a Bitmap by its key from Memory Cache, and if not found, from Disk Cache.
android.graphics.Bitmap	getBitmapFromDiskCache(java.lang.String key) Gets Bitmap from Disk Cache by its key.
android.graphics.Bitmap	getBitmapFromMemCache(java.lang.String key) Gets Bitmap from Memory Cache by its key.
static java.io.File	getDiskCacheDir(android.content.Context context, java.lang.String uniqueName) Creates a unique subdirectory of the designated app cache directory.
void	initDiskCache(android.content.Context context) Initializes memory cache.
void	put(java.lang.String key, android.graphics.Bitmap bitmap) Adds or updates a Bitmap to Memory and Disk cache identified by a key.
void	put(java.lang.String key, android.graphics.Bitmap bitmap, android.graphics.Bitmap.CompressFormat inDiskCompressFormat, int inDiskCompressQuality) Adds or updates a Bitmap to Memory and Disk cache compressed in format and quality specified, identified by a key.
void	put(java.lang.String key, android.graphics.Bitmap bitmap, java.lang.String outMimeType, int inDiskCompressQuality) Adds or updates a Bitmap to Memory and Disk cache compressed in format and quality specified, identified by a key.
void	remove(java.lang.String key) Removes an entry from memory and disk cache.

Methods inherited from class java.lang.Object

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

Constructor Detail

EpicBitmapCache

public EpicBitmapCache()

Basic constructor, builds the memory cache automatically.

Method Detail

initDiskCache

public void initDiskCache(android.content.Context context)

Initializes memory cache. This method uses context to find app's own cache directory.

Parameters:

context - Context from where lib is being called. This is used to get application's cache dir for disk cache.

put

public void put(java.lang.String key,
                android.graphics.Bitmap bitmap,
                android.graphics.Bitmap.CompressFormat inDiskCompressFormat,
                int inDiskCompressQuality)

Adds or updates a Bitmap to Memory and Disk cache compressed in format and quality specified, identified by a key.

Parameters:

key - ID of the Bitmap to retrieve it later.

bitmap - Bitmap to be stored.

inDiskCompressFormat - Format to compress the image (JPEG, PNG, etc.) to store on disk cache.

inDiskCompressQuality - Compress quality percentage of the image, from 0 to 100, to store on disk cache.

put

public void put(java.lang.String key,
                android.graphics.Bitmap bitmap,
                java.lang.String outMimeType,
                int inDiskCompressQuality)
         throws java.lang.IllegalArgumentException

Adds or updates a Bitmap to Memory and Disk cache compressed in format and quality specified, identified by a key.

Parameters:

key - ID of the Bitmap to retrieve it later.

bitmap - Bitmap to be stored.

outMimeType - Image's mime type (usually in form 'image/format', e.g. 'image/png'), to automatically obtain the compress format to store on disk cache.

inDiskCompressQuality - Compress quality percentage of the image, from 0 to 100, to store on disk cache.

Throws:

java.lang.IllegalArgumentException - In case Mime Type specified is not image.

put

public void put(java.lang.String key,
                android.graphics.Bitmap bitmap)

Adds or updates a Bitmap to Memory and Disk cache identified by a key.

NOTE: This method uses JPEG format 100% quality by default when compressing image to store it on disk cache. To manually specify format and quality of compression in disk cache, use put(String, Bitmap, Bitmap.CompressFormat, int) instead.

Parameters:

key - ID of the Bitmap to retrieve it later

bitmap - Bitmap to be stored

remove

public void remove(java.lang.String key)
            throws java.io.IOException

Removes an entry from memory and disk cache.

Parameters:

key - Identifier of value to be removed from cache.

Throws:

java.io.IOException - In case entry could not be removed from disk cache due to an IO Error.

getBitmapFromMemCache

public android.graphics.Bitmap getBitmapFromMemCache(java.lang.String key)

Gets Bitmap from Memory Cache by its key.

Parameters:

key - ID of the Bitmap to be retrieved.

Returns:

Bitmap object if found, null otherwise.

getBitmapFromDiskCache

public android.graphics.Bitmap getBitmapFromDiskCache(java.lang.String key)

Gets Bitmap from Disk Cache by its key.

Parameters:

key - ID of the Bitmap to be retrieved.

Returns:

Bitmap object if found, null otherwise.

getBitmapFromCache

public android.graphics.Bitmap getBitmapFromCache(java.lang.String key)

Tries to retrieve a Bitmap by its key from Memory Cache, and if not found, from Disk Cache.

Parameters:

key - ID of the Bitmap to be retrieved.

Returns:

Bitmap object if found, null otherwise.

clear

public void clear()
           throws java.io.IOException

Deletes memory and disk cache contents.

Throws:

java.io.IOException - In case disk cache could not be cleared due to an IO error.

getDiskCacheDir

public static java.io.File getDiskCacheDir(android.content.Context context,
                                           java.lang.String uniqueName)

Creates a unique subdirectory of the designated app cache directory. Tries to use external but if not mounted, falls back on internal storage.

Parameters:

context - Context from where EpicBitmapCache is being used.

uniqueName - Unique name for cache directory.

Returns:

File pointing to cache directory