com.nostra13.universalimageloader.cache.disc.impl

Class BaseDiskCache

java.lang.Object

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

All Implemented Interfaces:

DiskCache

Direct Known Subclasses:

LimitedAgeDiskCache, UnlimitedDiskCache

public abstract class BaseDiskCache
extends java.lang.Object
implements DiskCache

Base disk cache.

Since:

1.0.0

See Also:

FileNameGenerator

Field Summary

Fields

Modifier and Type	Field and Description
protected int	bufferSize
protected java.io.File	cacheDir
protected android.graphics.Bitmap.CompressFormat	compressFormat
protected int	compressQuality
static int	DEFAULT_BUFFER_SIZE {@value
static android.graphics.Bitmap.CompressFormat	DEFAULT_COMPRESS_FORMAT {@value
static int	DEFAULT_COMPRESS_QUALITY {@value
protected FileNameGenerator	fileNameGenerator
protected java.io.File	reserveCacheDir

Constructor Summary

Constructors

Constructor and Description
BaseDiskCache(java.io.File cacheDir)
BaseDiskCache(java.io.File cacheDir, java.io.File reserveCacheDir)
BaseDiskCache(java.io.File cacheDir, java.io.File reserveCacheDir, FileNameGenerator fileNameGenerator)

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
protected java.io.File	getFile(java.lang.String imageUri) Returns file object (not null) for incoming image URI.
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.
void	setBufferSize(int bufferSize)
void	setCompressFormat(android.graphics.Bitmap.CompressFormat compressFormat)
void	setCompressQuality(int compressQuality)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_BUFFER_SIZE

public static final int DEFAULT_BUFFER_SIZE

{@value

See Also:

Constant Field Values

DEFAULT_COMPRESS_FORMAT

public static final android.graphics.Bitmap.CompressFormat DEFAULT_COMPRESS_FORMAT

{@value

DEFAULT_COMPRESS_QUALITY

public static final int DEFAULT_COMPRESS_QUALITY

{@value

See Also:

Constant Field Values

cacheDir

protected final java.io.File cacheDir

reserveCacheDir

protected final java.io.File reserveCacheDir

fileNameGenerator

protected final FileNameGenerator fileNameGenerator

bufferSize

protected int bufferSize

compressFormat

protected android.graphics.Bitmap.CompressFormat compressFormat

compressQuality

protected int compressQuality

Constructor Detail

BaseDiskCache

public BaseDiskCache(java.io.File cacheDir)

Parameters:

cacheDir - Directory for file caching

BaseDiskCache

public BaseDiskCache(java.io.File cacheDir,
             java.io.File reserveCacheDir)

Parameters:

cacheDir - Directory for file caching

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

BaseDiskCache

public BaseDiskCache(java.io.File cacheDir,
             java.io.File reserveCacheDir,
             FileNameGenerator fileNameGenerator)

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

Method Detail

getDirectory

public java.io.File getDirectory()

Description copied from interface: DiskCache

Returns root directory of disk cache

Specified by:

getDirectory in interface DiskCache

Returns:

Root directory of disk cache

get

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

Description copied from interface: DiskCache

Returns file of cached image

Specified by:

get in interface DiskCache

Parameters:

imageUri - Original image URI

Returns:

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

save

public boolean save(java.lang.String imageUri,
           java.io.InputStream imageStream,
           IoUtils.CopyListener listener)
             throws java.io.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

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

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

Description copied from interface: DiskCache

Saves image bitmap in disk cache.

Specified by:

save in interface DiskCache

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

public boolean remove(java.lang.String imageUri)

Description copied from interface: DiskCache

Removes image file associated with incoming URI

Specified by:

remove in interface DiskCache

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

public void close()

Description copied from interface: DiskCache

Closes disk cache, releases resources.

Specified by:

close in interface DiskCache

clear

public void clear()

Description copied from interface: DiskCache

Clears disk cache.

Specified by:

clear in interface DiskCache

getFile

protected java.io.File getFile(java.lang.String imageUri)

Returns file object (not null) for incoming image URI. File object can reference to non-existing file.

setBufferSize

public void setBufferSize(int bufferSize)

setCompressFormat

public void setCompressFormat(android.graphics.Bitmap.CompressFormat compressFormat)

setCompressQuality

public void setCompressQuality(int compressQuality)