net.sf.jomic.tools
Class ImageCache

java.lang.Object
  net.sf.jomic.tools.ImageCache

All Implemented Interfaces:

CacheInfo

Direct Known Subclasses:

ComicCache.TitleImageCache

public class ImageCache
extends Object
implements CacheInfo

Cache to store RenderedImages in memory. When the memory usage exeeds a maximum size, the least recent images are removed. Note that the cache holds at least one image, so if this is bigger than the maximum size, so is the whole cache.

Constructor Summary

ImageCache(String newName, long newMaxMemorySize)

Method Summary

void	clear() Remove all entries from cache.
RenderedImage	createBrokenImage() Create a broken image using the cache's default dimension.
void	dispose()
RenderedImage	get(File imageFile)
RenderedImage	get(File imageFile, ImageInCacheListener listener)
protected Dimension	getDefaultImageDimension()
Dimension	getDimension(File imageFile)
int	getEntryCount() Number of cache entries.
long	getMaxSize() Get number of bytes the cache may fill up before entries get thrown out.
long	getUsedSize() Get the approximate number of bytes currently used by all images in the cache.
boolean	has(File imageFile) Is the image for imageFile already stored in the cache?
protected RenderedImage	obtainImage(File imageFile)
protected Dimension	obtainImageDimension(File imageFile)

Methods inherited from class java.lang.Object

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

Constructor Detail

ImageCache

public ImageCache(String newName,
                  long newMaxMemorySize)

Method Detail

get

public RenderedImage get(File imageFile)
                  throws IOException

Throws:

IOException

get

public RenderedImage get(File imageFile,
                         ImageInCacheListener listener)
                  throws IOException

Throws:

IOException

getDimension

public Dimension getDimension(File imageFile)

getEntryCount

public int getEntryCount()

Description copied from interface: CacheInfo

Number of cache entries.

Specified by:

getEntryCount in interface CacheInfo

getMaxSize

public long getMaxSize()

Get number of bytes the cache may fill up before entries get thrown out. Note that the cache will hold at least 1 image, so if this is bigger than the maximum size, the actual size may exceed the maximum in this case.

Specified by:

getMaxSize in interface CacheInfo

getUsedSize

public long getUsedSize()

Get the approximate number of bytes currently used by all images in the cache.

Specified by:

getUsedSize in interface CacheInfo

getDefaultImageDimension

protected Dimension getDefaultImageDimension()

clear

public void clear()

Remove all entries from cache.

createBrokenImage

public RenderedImage createBrokenImage()

Create a broken image using the cache's default dimension.

dispose

public void dispose()

has

public boolean has(File imageFile)

Is the image for imageFile already stored in the cache?

obtainImage

protected RenderedImage obtainImage(File imageFile)
                             throws IOException

Throws:

IOException

obtainImageDimension

protected Dimension obtainImageDimension(File imageFile)
                                  throws IOException

Throws:

IOException