org.apache.fop.util

Class ImageObjectCache

java.lang.Object

org.apache.fop.util.ImageObjectCache

Direct Known Subclasses:

ImageObjectCacheImpl

public class ImageObjectCache
extends Object

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.

Constructor Summary

Constructors

Constructor and Description
ImageObjectCache()

Method Summary

Modifier and Type	Method and Description
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

Constructor Detail

ImageObjectCache

public ImageObjectCache()

Method Detail

getImage

public ImageObject getImage(String key)

Returns a cached image or null if not present.

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.

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.

Parameters:

key - the image's cache key

Returns:

true or false