com.nostra13.universalimageloader.cache.disc.impl

Class LimitedAgeDiskCache

java.lang.Object

com.nostra13.universalimageloader.cache.disc.impl.BaseDiskCache

com.nostra13.universalimageloader.cache.disc.impl.LimitedAgeDiskCache

All Implemented Interfaces:

DiskCache

public class LimitedAgeDiskCache
extends BaseDiskCache

Cache which deletes files which were loaded more than defined time. Cache size is unlimited.

Since:

1.3.1

Author:

Sergey Tarasevich (nostra13[at]gmail[dot]com)

Field Summary

Fields inherited from class com.nostra13.universalimageloader.cache.disc.impl.BaseDiskCache

bufferSize, cacheDir, compressFormat, compressQuality, DEFAULT_BUFFER_SIZE, DEFAULT_COMPRESS_FORMAT, DEFAULT_COMPRESS_QUALITY, fileNameGenerator, reserveCacheDir

Constructor Summary

Constructors

Constructor and Description
LimitedAgeDiskCache(File cacheDir, File reserveCacheDir, FileNameGenerator fileNameGenerator, long maxAge)
LimitedAgeDiskCache(File cacheDir, File reserveCacheDir, long maxAge)
LimitedAgeDiskCache(File cacheDir, long maxAge)

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Clears disk cache.
File	get(String imageUri) Returns file of cached image
boolean	remove(String imageUri) Removes image file associated with incoming URI
boolean	save(String imageUri, android.graphics.Bitmap bitmap) Saves image bitmap in disk cache.
boolean	save(String imageUri, InputStream imageStream, IoUtils.CopyListener listener) Saves image stream in disk cache.

Methods inherited from class com.nostra13.universalimageloader.cache.disc.impl.BaseDiskCache

close, getDirectory, getFile, setBufferSize, setCompressFormat, setCompressQuality

Methods inherited from class java.lang.Object

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

Constructor Detail

LimitedAgeDiskCache

public LimitedAgeDiskCache(File cacheDir,
                   long maxAge)

Parameters:

cacheDir - Directory for file caching

maxAge - Max file age (in seconds). If file age will exceed this value then it'll be removed on next treatment (and therefore be reloaded).

LimitedAgeDiskCache

public LimitedAgeDiskCache(File cacheDir,
                   File reserveCacheDir,
                   long maxAge)

Parameters:

cacheDir - Directory for file caching

maxAge - Max file age (in seconds). If file age will exceed this value then it'll be removed on next treatment (and therefore be reloaded).

LimitedAgeDiskCache

public LimitedAgeDiskCache(File cacheDir,
                   File reserveCacheDir,
                   FileNameGenerator fileNameGenerator,
                   long maxAge)

Parameters:

cacheDir - Directory for file caching

reserveCacheDir - null-ok; Reserve directory for file caching. It's used when the primary directory isn't available.

fileNameGenerator - Name generator for cached files

maxAge - Max file age (in seconds). If file age will exceed this value then it'll be removed on next treatment (and therefore be reloaded).

Method Detail

get

public File get(String imageUri)

Description copied from interface: DiskCache

Returns file of cached image

Specified by:

get in interface DiskCache

Overrides:

get in class BaseDiskCache

Parameters:

imageUri - Original image URI

Returns:

File of cached image or null if image wasn't cached

save

public boolean save(String imageUri,
           InputStream imageStream,
           IoUtils.CopyListener listener)
             throws IOException

Description copied from interface: DiskCache

Saves image stream in disk cache. Incoming image stream shouldn't be closed in this method.

Specified by:

save in interface DiskCache

Overrides:

save in class BaseDiskCache

Parameters:

imageUri - Original image URI

imageStream - Input stream of image (shouldn't be closed in this method)

listener - Listener for saving progress, can be ignored if you don't use progress listener in ImageLoader calls

Returns:

true - if image was saved successfully; false - if image wasn't saved in disk cache.

Throws:

IOException

save

public boolean save(String imageUri,
           android.graphics.Bitmap bitmap)
             throws IOException

Description copied from interface: DiskCache

Saves image bitmap in disk cache.

Specified by:

save in interface DiskCache

Overrides:

save in class BaseDiskCache

Parameters:

imageUri - Original image URI

bitmap - Image bitmap

Returns:

true - if bitmap was saved successfully; false - if bitmap wasn't saved in disk cache.

Throws:

IOException

remove

public boolean remove(String imageUri)

Description copied from interface: DiskCache

Removes image file associated with incoming URI

Specified by:

remove in interface DiskCache

Overrides:

remove in class BaseDiskCache

Parameters:

imageUri - Image URI

Returns:

true - if image file is deleted successfully; false - if image file doesn't exist for incoming URI or image file can't be deleted.

clear

public void clear()

Description copied from interface: DiskCache

Clears disk cache.

Specified by:

clear in interface DiskCache

Overrides:

clear in class BaseDiskCache