org.apache.fop.util

Class ImageObjectCacheImpl

java.lang.Object

org.apache.fop.util.ImageObjectCache

org.apache.fop.util.ImageObjectCacheImpl

public class ImageObjectCacheImpl
extends ImageObjectCache

This class provides a cache for image objects. The main key into the images is the original URI the image was accessed with prepended by the output format tag. This is based on XGC's ImageCache.

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.apache.commons.logging.Log	LOG logger

Constructor Summary

Constructors

Constructor and Description
ImageObjectCacheImpl() Default constructor with default settings.

Method Summary

Modifier and Type	Method and Description
void	clearCache() Clears the image cache (all ImageInfo and Image objects).
void	doHouseKeeping() Triggers some house-keeping, i.e. removes stale entries.
ImageObject	getImage(String key) Returns a cached image or null if not present.
boolean	hasImage(String key) Checks whether there is a cached image identified by the given key.
void	putImage(String key, ImageObject image) Registers an image with the cache.

Methods inherited from class java.lang.Object

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

Field Detail

LOG

protected static final org.apache.commons.logging.Log LOG

logger

Constructor Detail

ImageObjectCacheImpl

public ImageObjectCacheImpl()

Default constructor with default settings.

Method Detail

getImage

public ImageObject getImage(String key)

Returns a cached image or null if not present.

Overrides:

getImage in class ImageObjectCache

Parameters:

key - the image's cache key

Returns:

the requested image or null if the image is not in the cache

putImage

public void putImage(String key,
                     ImageObject image)

Registers an image with the cache.

Overrides:

putImage in class ImageObjectCache

Parameters:

image - the ImageObject

key - the image's cache key

hasImage

public boolean hasImage(String key)

Checks whether there is a cached image identified by the given key.

Overrides:

hasImage in class ImageObjectCache

Parameters:

key - the image's cache key

Returns:

true or false

clearCache

public void clearCache()

Clears the image cache (all ImageInfo and Image objects).

doHouseKeeping

public void doHouseKeeping()

Triggers some house-keeping, i.e. removes stale entries.