icy.image.cache

Class ImageCache

java.lang.Object

icy.image.cache.ImageCache

public class ImageCache
extends java.lang.Object

Image Cache static util class.
The cache store and return 1D array data corresponding to the internal IcyBufferedImage.getDataXY(int) image data.

Author:

Stephane

Field Summary

Fields

Modifier and Type	Field and Description
static AbstractCache	cache

Constructor Summary

Constructors

Constructor and Description
ImageCache()

Method Summary

Methods

Modifier and Type	Method and Description
static void	end() Call it when you're done with the cache (release all resources and cleanup)
static java.util.Map<IcyBufferedImage,java.lang.Object>	get(java.util.Collection<IcyBufferedImage> keys) Get all data array from cache from a given Collection of IcyBufferedImage
static java.lang.Object	get(IcyBufferedImage key) Get the corresponding data array (2D native array) from cache from a given IcyBufferedImage
static java.util.Collection<IcyBufferedImage>	getAllKeys() Get all data IcyBufferedImage in the cache
static boolean	isEnabled()
static boolean	isInCache(IcyBufferedImage image)
static boolean	isOnDiskCache(IcyBufferedImage image)
static boolean	isOnMemoryCache(IcyBufferedImage image)
static void	remove(IcyBufferedImage key) Remove an object from the cache from its key
static void	set(IcyBufferedImage key, java.lang.Object object, boolean eternal) Put the specified data array (2D native array) into cache with its associated key
static long	usedDisk() Return used disk space for cache (in bytes)
static long	usedMemory() Return used memory for cache (in bytes)

Methods inherited from class java.lang.Object

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

Field Detail

cache

public static final AbstractCache cache

Constructor Detail

ImageCache

public ImageCache()

Method Detail

isEnabled

public static boolean isEnabled()

isInCache

public static boolean isInCache(IcyBufferedImage image)

isOnMemoryCache

public static boolean isOnMemoryCache(IcyBufferedImage image)

isOnDiskCache

public static boolean isOnDiskCache(IcyBufferedImage image)

usedMemory

public static long usedMemory()

Return used memory for cache (in bytes)

usedDisk

public static long usedDisk()

Return used disk space for cache (in bytes)

getAllKeys

public static java.util.Collection<IcyBufferedImage> getAllKeys()
                                                         throws CacheException

Get all data IcyBufferedImage in the cache

Throws:

CacheException

get

public static java.lang.Object get(IcyBufferedImage key)
                            throws CacheException

Get the corresponding data array (2D native array) from cache from a given IcyBufferedImage

Throws:

CacheException

get

public static java.util.Map<IcyBufferedImage,java.lang.Object> get(java.util.Collection<IcyBufferedImage> keys)
                                                            throws CacheException

Get all data array from cache from a given Collection of IcyBufferedImage

Throws:

CacheException

set

public static void set(IcyBufferedImage key,
       java.lang.Object object,
       boolean eternal)
                throws CacheException

Put the specified data array (2D native array) into cache with its associated key

Throws:

CacheException

remove

public static void remove(IcyBufferedImage key)
                   throws CacheException

Remove an object from the cache from its key

Throws:

CacheException

end

public static void end()

Call it when you're done with the cache (release all resources and cleanup)