uk.co.senab.bitmapcache

Class BitmapLruCache.Builder

java.lang.Object

uk.co.senab.bitmapcache.BitmapLruCache.Builder

Enclosing class:

BitmapLruCache

public static final class BitmapLruCache.Builder
extends Object

Builder class for {link BitmapLruCache. An example call:

 BitmapLruCache.Builder builder = new BitmapLruCache.Builder();
 builder.setMemoryCacheEnabled(true).setMemoryCacheMaxSizeUsingHeapSize(this);
 builder.setDiskCacheEnabled(true).setDiskCacheLocation(...);

 BitmapLruCache cache = builder.build();
 

Author:

Chris Banes

Constructor Summary

Constructors

Constructor and Description
BitmapLruCache.Builder() Deprecated. You should now use Builder(Context). This is so that we can reliably set up correctly.
BitmapLruCache.Builder(android.content.Context context)

Method Summary

Methods

Modifier and Type	Method and Description
BitmapLruCache	build()
BitmapLruCache.Builder	setDiskCacheEnabled(boolean enabled) Set whether the Disk Cache should be enabled.
BitmapLruCache.Builder	setDiskCacheLocation(File location) Set the Disk Cache location.
BitmapLruCache.Builder	setDiskCacheMaxSize(long maxSize) Set the maximum number of bytes the Disk Cache should use to store values.
BitmapLruCache.Builder	setMemoryCacheEnabled(boolean enabled) Set whether the Memory Cache should be enabled.
BitmapLruCache.Builder	setMemoryCacheMaxSize(int size) Set the maximum number of bytes the Memory Cache should use to store values.
BitmapLruCache.Builder	setMemoryCacheMaxSizeUsingHeapSize() Sets the Memory Cache maximum size to be the default value of % of heap size.
BitmapLruCache.Builder	setMemoryCacheMaxSizeUsingHeapSize(float percentageOfHeap) Sets the Memory Cache maximum size to be the given percentage of heap size.
BitmapLruCache.Builder	setRecyclePolicy(BitmapLruCache.RecyclePolicy recyclePolicy) Sets the recycle policy.

Methods inherited from class java.lang.Object

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

Constructor Detail

BitmapLruCache.Builder

public BitmapLruCache.Builder()

Deprecated. You should now use Builder(Context). This is so that we can reliably set up correctly.

BitmapLruCache.Builder

public BitmapLruCache.Builder(android.content.Context context)

Method Detail

build

public BitmapLruCache build()

Returns:

A new BitmapLruCache created with the arguments supplied to this builder.

setDiskCacheEnabled

public BitmapLruCache.Builder setDiskCacheEnabled(boolean enabled)

Set whether the Disk Cache should be enabled. Defaults to false.

Returns:

This Builder object to allow for chaining of calls to set methods.

setDiskCacheLocation

public BitmapLruCache.Builder setDiskCacheLocation(File location)

Set the Disk Cache location. This location should be read-writeable.

Returns:

This Builder object to allow for chaining of calls to set methods.

setDiskCacheMaxSize

public BitmapLruCache.Builder setDiskCacheMaxSize(long maxSize)

Set the maximum number of bytes the Disk Cache should use to store values. Defaults to MB.

Returns:

This Builder object to allow for chaining of calls to set methods.

setMemoryCacheEnabled

public BitmapLruCache.Builder setMemoryCacheEnabled(boolean enabled)

Set whether the Memory Cache should be enabled. Defaults to true.

Returns:

This Builder object to allow for chaining of calls to set methods.

setMemoryCacheMaxSize

public BitmapLruCache.Builder setMemoryCacheMaxSize(int size)

Set the maximum number of bytes the Memory Cache should use to store values. Defaults to MB.

Returns:

This Builder object to allow for chaining of calls to set methods.

setMemoryCacheMaxSizeUsingHeapSize

public BitmapLruCache.Builder setMemoryCacheMaxSizeUsingHeapSize()

Sets the Memory Cache maximum size to be the default value of % of heap size.

Returns:

This Builder object to allow for chaining of calls to set methods.

setMemoryCacheMaxSizeUsingHeapSize

public BitmapLruCache.Builder setMemoryCacheMaxSizeUsingHeapSize(float percentageOfHeap)

Sets the Memory Cache maximum size to be the given percentage of heap size. This is capped at % of the app heap size.

Parameters:

percentageOfHeap - - percentage of heap size. Valid values are 0.0 <= x <= .

Returns:

This Builder object to allow for chaining of calls to set methods.

setRecyclePolicy

public BitmapLruCache.Builder setRecyclePolicy(BitmapLruCache.RecyclePolicy recyclePolicy)

Sets the recycle policy. This controls if Bitmap.recycle() is called.

Parameters:

recyclePolicy - - New recycle policy, can not be null.

Returns:

This Builder object to allow for chaining of calls to set methods.