cn.trinea.android.common.service.impl

Class ImageMemoryCache

java.lang.Object

cn.trinea.android.common.service.impl.SimpleCache<K,V>

cn.trinea.android.common.service.impl.PreloadDataCache<java.lang.String,Bitmap>

cn.trinea.android.common.service.impl.ImageMemoryCache

All Implemented Interfaces:

Cache<java.lang.String,Bitmap>, java.io.Serializable

Direct Known Subclasses:

ImageCache

public class ImageMemoryCache
extends PreloadDataCache<java.lang.String,Bitmap>

Image Memory Cache

It applies to images those uesd frequently, like users avatar of twitter or sina weibo. Cache of big image you can consider of ImageSDCardCache.

Setting and Usage
• Use one of constructors in sections II to init cache
• setOnImageCallbackListener(OnImageCallbackListener) set callback interface when getting image
• get(String, List, View) get image asynchronous and preload other images asynchronous according to urlList
• get(String, View) get image asynchronous
• setHttpReadTimeOut(int) set http read image time out, if less than 0, not set. default is not set
• PreloadDataCache.setContext(Context) and PreloadDataCache.setAllowedNetworkTypes(int) restrict the types of networks over which this data can get.
• setOpenWaitingQueue(boolean) set whether open waiting queue, default is true. If true, save all view waiting for image loaded, else only save the newest one
• PreloadDataCache.setOnGetDataListener(OnGetDataListener) set how to get image, this cache will get image and preload images by it
• SimpleCache.setCacheFullRemoveType(CacheFullRemoveType) set remove type when cache is full
• other see PreloadDataCache and SimpleCache

Constructor
• ImageMemoryCache()
• ImageMemoryCache(int)
• ImageMemoryCache(int, int)

Attentions
• You should add android.permission.ACCESS_NETWORK_STATE in manifest if you get image from network.

Author:

Trinea 2012-4-5

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ImageMemoryCache.OnImageCallbackListener callback interface when getting image

Nested classes/interfaces inherited from class cn.trinea.android.common.service.impl.PreloadDataCache

PreloadDataCache.OnGetDataListener<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_MAX_SIZE recommend default max cache size according to dalvik max memory

Fields inherited from class cn.trinea.android.common.service.impl.PreloadDataCache

DEFAULT_BACKWARD_CACHE_NUMBER, DEFAULT_FORWARD_CACHE_NUMBER, DEFAULT_THREAD_POOL_SIZE, NETWORK_MOBILE, NETWORK_WIFI

Constructor Summary

Constructors

Constructor and Description
ImageMemoryCache() Get data listener is getDefaultOnGetImageListener() callback interface when getting image is null, can set by setOnImageCallbackListener(OnImageCallbackListener) Maximum size of the cache is DEFAULT_MAX_SIZE Elements of the cache will not invalid Remove type is RemoveTypeUsedCountSmall when cache is full
ImageMemoryCache(int maxSize) Get data listener is getDefaultOnGetImageListener() callback interface when getting image is null, can set by setOnImageCallbackListener(OnImageCallbackListener) Elements of the cache will not invalid Remove type is RemoveTypeUsedCountSmall when cache is full
ImageMemoryCache(int maxSize, int threadPoolSize) Get data listener is getDefaultOnGetImageListener() callback interface when getting image is null, can set by setOnImageCallbackListener(OnImageCallbackListener) Elements of the cache will not invalid Remove type is RemoveTypeUsedCountSmall when cache is full

Method Summary

Methods

Modifier and Type	Method and Description
boolean	get(java.lang.String imageUrl, java.util.List<java.lang.String> urlList, View view) get image asynchronous and preload other images asynchronous according to urlList
boolean	get(java.lang.String imageUrl, View view) get image asynchronous. when get image success, it will pass to ImageMemoryCache.OnImageCallbackListener.onGetSuccess(String, Bitmap, View, boolean)
PreloadDataCache.OnGetDataListener<java.lang.String,Bitmap>	getDefaultOnGetImageListener() default get image listener
int	getHttpReadTimeOut() get http read image time out, if less than 0, not set. default is not set
ImageMemoryCache.OnImageCallbackListener	getOnImageCallbackListener() get callback interface when getting image
java.util.Map<java.lang.String,java.lang.String>	getRequestProperties() get http request properties
boolean	isOpenWaitingQueue() get whether open waiting queue, default is true.
void	setHttpReadTimeOut(int readTimeOutMillis) set http read image time out, if less than 0, not set. default is not set, in mills
void	setOnImageCallbackListener(ImageMemoryCache.OnImageCallbackListener onImageCallbackListener) set callback interface when getting image
void	setOpenWaitingQueue(boolean isOpenWaitingQueue) set whether open waiting queue, default is true.
void	setRequestProperties(java.util.Map<java.lang.String,java.lang.String> requestProperties) set http request properties If image is from the different server, setRequestProperty("Connection", "false") is recommended.
void	setRequestProperty(java.lang.String field, java.lang.String newValue) Sets the value of the http request header field
java.util.List<java.lang.Runnable>	shutdownNow()

Methods inherited from class cn.trinea.android.common.service.impl.PreloadDataCache

checkIsNetworkTypeAllowed, get, getAllowedNetworkTypes, getBackwardCacheNumber, getContext, getForwardCacheNumber, getOnGetDataListener, isCheckNetwork, isExistGettingDataThread, loadCache, setAllowedNetworkTypes, setBackwardCacheNumber, setCheckNetwork, setContext, setForwardCacheNumber, setOnGetDataListener

Methods inherited from class cn.trinea.android.common.service.impl.SimpleCache

clear, containsKey, entrySet, getCacheFullRemoveType, getHitCount, getHitRate, getMaxSize, getMissCount, getSize, getValidTime, keySet, put, put, putAll, remove, saveCache, setCacheFullRemoveType, setValidTime, values

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MAX_SIZE

public static final int DEFAULT_MAX_SIZE

recommend default max cache size according to dalvik max memory

Constructor Detail

ImageMemoryCache

public ImageMemoryCache()

• Get data listener is getDefaultOnGetImageListener()
• callback interface when getting image is null, can set by setOnImageCallbackListener(OnImageCallbackListener)
• Maximum size of the cache is DEFAULT_MAX_SIZE
• Elements of the cache will not invalid
• Remove type is RemoveTypeUsedCountSmall when cache is full

See Also:

PreloadDataCache.PreloadDataCache()

ImageMemoryCache

public ImageMemoryCache(int maxSize)

• Get data listener is getDefaultOnGetImageListener()
• callback interface when getting image is null, can set by setOnImageCallbackListener(OnImageCallbackListener)
• Elements of the cache will not invalid
• Remove type is RemoveTypeUsedCountSmall when cache is full

Parameters:

maxSize - maximum size of the cache

See Also:

PreloadDataCache.PreloadDataCache(int)

ImageMemoryCache

public ImageMemoryCache(int maxSize,
                int threadPoolSize)

• Get data listener is getDefaultOnGetImageListener()
• callback interface when getting image is null, can set by setOnImageCallbackListener(OnImageCallbackListener)
• Elements of the cache will not invalid
• Remove type is RemoveTypeUsedCountSmall when cache is full

Parameters:

maxSize - maximum size of the cache

threadPoolSize - getting data thread pool size

See Also:

PreloadDataCache.PreloadDataCache(int, int)

Method Detail

get

public boolean get(java.lang.String imageUrl,
          View view)

get image asynchronous. when get image success, it will pass to ImageMemoryCache.OnImageCallbackListener.onGetSuccess(String, Bitmap, View, boolean)

Parameters:

imageUrl -

view -

Returns:

whether image already in cache or not

get

public boolean get(java.lang.String imageUrl,
          java.util.List<java.lang.String> urlList,
          View view)

get image asynchronous and preload other images asynchronous according to urlList

Parameters:

imageUrl -

urlList - url list, if is null, not preload, else preload forward by PreloadDataCache.preloadDataForward(Object, List, int), preload backward by PreloadDataCache.preloadDataBackward(Object, List, int)

view -

Returns:

whether image already in cache or not

getOnImageCallbackListener

public ImageMemoryCache.OnImageCallbackListener getOnImageCallbackListener()

get callback interface when getting image

Returns:

the onImageCallbackListener

setOnImageCallbackListener

public void setOnImageCallbackListener(ImageMemoryCache.OnImageCallbackListener onImageCallbackListener)

set callback interface when getting image

Parameters:

onImageCallbackListener -

getHttpReadTimeOut

public int getHttpReadTimeOut()

get http read image time out, if less than 0, not set. default is not set

Returns:

the httpReadTimeOut

setHttpReadTimeOut

public void setHttpReadTimeOut(int readTimeOutMillis)

set http read image time out, if less than 0, not set. default is not set, in mills

Parameters:

readTimeOutMillis -

isOpenWaitingQueue

public boolean isOpenWaitingQueue()

get whether open waiting queue, default is true. If true, save all view waiting for image loaded, else only save the newest one

Returns:

setOpenWaitingQueue

public void setOpenWaitingQueue(boolean isOpenWaitingQueue)

set whether open waiting queue, default is true. If true, save all view waiting for image loaded, else only save the newest one

Parameters:

isOpenWaitingQueue -

setRequestProperties

public void setRequestProperties(java.util.Map<java.lang.String,java.lang.String> requestProperties)

set http request properties

• If image is from the different server, setRequestProperty("Connection", "false") is recommended. If image is from the same server, true is recommended, and this is the default value

Parameters:

requestProperties -

getRequestProperties

public java.util.Map<java.lang.String,java.lang.String> getRequestProperties()

get http request properties

Returns:

setRequestProperty

public void setRequestProperty(java.lang.String field,
                      java.lang.String newValue)

Sets the value of the http request header field

Parameters:

field - the request header field to be set

newValue - the new value of the specified property

See Also:

#setRequestProperties(Map)}

shutdownNow

public java.util.List<java.lang.Runnable> shutdownNow()

Overrides:

shutdownNow in class PreloadDataCache<java.lang.String,Bitmap>

See Also:

ExecutorService.shutdownNow()

getDefaultOnGetImageListener

public PreloadDataCache.OnGetDataListener<java.lang.String,Bitmap> getDefaultOnGetImageListener()

default get image listener

Returns: