com.nostra13.universalimageloader.cache.disc

Interface DiskCache

All Known Implementing Classes:

BaseDiskCache, LimitedAgeDiskCache, LruDiskCache, UnlimitedDiskCache

public interface DiskCache

Interface for disk cache

Since:

1.9.2

Method Summary

Methods

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

Method Detail

getDirectory

java.io.File getDirectory()

Returns root directory of disk cache

Returns:

Root directory of disk cache

get

java.io.File get(java.lang.String imageUri)

Returns file of cached image

Parameters:

imageUri - Original image URI

Returns:

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

save

boolean save(java.lang.String imageUri,
           java.io.InputStream imageStream,
           IoUtils.CopyListener listener)
             throws java.io.IOException

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

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:

java.io.IOException

save

boolean save(java.lang.String imageUri,
           android.graphics.Bitmap bitmap)
             throws java.io.IOException

Saves image bitmap in disk cache.

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:

java.io.IOException

remove

boolean remove(java.lang.String imageUri)

Removes image file associated with incoming URI

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.

close

void close()

Closes disk cache, releases resources.

clear

void clear()

Clears disk cache.