icy.image.cache

Class AbstractCache

java.lang.Object

icy.image.cache.AbstractCache

Direct Known Subclasses:

EHCache2

public abstract class AbstractCache
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
AbstractCache()

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	clear() Clear the cache
abstract void	end() Call it when you're done with the cache (release resources and cleanup)
abstract java.lang.Object	get(java.lang.Integer key) Get an object from cache from its key
abstract java.util.Collection<java.lang.Integer>	getAllKeys() Get all element keys in the cache
abstract java.lang.String	getName()
long	getProfilingTime()
abstract boolean	isEnabled() Returns true if the cache is enabled
abstract boolean	isInCache(java.lang.Integer key) Test presence of a key in the cache
abstract boolean	isOnDiskCache(java.lang.Integer key) Test presence of a key in the cache
abstract boolean	isOnMemoryCache(java.lang.Integer key) Test presence of a key in the cache
abstract void	remove(java.lang.Integer key) Remove an object from the cache from its key
void	resetProfiling()
abstract void	set(java.lang.Integer key, java.lang.Object object, boolean eternal) Put an object in cache with its associated key
void	setProfiling(boolean value)
abstract long	usedDisk() Return used disk space for cache (in bytes)
abstract 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

Constructor Detail

AbstractCache

public AbstractCache()

Method Detail

getName

public abstract java.lang.String getName()

setProfiling

public void setProfiling(boolean value)

resetProfiling

public void resetProfiling()

getProfilingTime

public long getProfilingTime()

isEnabled

public abstract boolean isEnabled()

Returns true if the cache is enabled

isInCache

public abstract boolean isInCache(java.lang.Integer key)

Test presence of a key in the cache

isOnMemoryCache

public abstract boolean isOnMemoryCache(java.lang.Integer key)

Test presence of a key in the cache

isOnDiskCache

public abstract boolean isOnDiskCache(java.lang.Integer key)

Test presence of a key in the cache

usedMemory

public abstract long usedMemory()

Return used memory for cache (in bytes)

usedDisk

public abstract long usedDisk()

Return used disk space for cache (in bytes)

getAllKeys

public abstract java.util.Collection<java.lang.Integer> getAllKeys()
                                                            throws CacheException

Get all element keys in the cache

Throws:

CacheException

get

public abstract java.lang.Object get(java.lang.Integer key)
                              throws CacheException

Get an object from cache from its key

Throws:

CacheException

set

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

Put an object in cache with its associated key

Throws:

CacheException

clear

public abstract void clear()
                    throws CacheException

Clear the cache

Throws:

CacheException

remove

public abstract void remove(java.lang.Integer key)
                     throws CacheException

Remove an object from the cache from its key

Throws:

CacheException

end

public abstract void end()

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