com.ibm.jaggr.core.cache

Interface IGenericCache

All Known Subinterfaces:

IGzipCache, ILayerCache, IModuleCache, IResourceConverterCache

All Known Implementing Classes:

GenericCacheImpl, GzipCacheImpl, LayerCacheImpl, ModuleCacheImpl, ResourceConverterCacheImpl

public interface IGenericCache

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Remove all entries in the cache
boolean	contains(String key) Returns true if the entry with the specified key is in the cache
void	dump(Writer writer, Pattern filter) Output the cache info to the specified Writer
Set<String>	getKeys() Returns the set of keys associated with entries in the cache
IGenericCache	newInstance() Returns a new, empty, instance of this cache object.
void	setAggregator(IAggregator aggregator) Called for newly created (or de-serialized) caches to set the aggregator instance for this cache.
int	size() Returns the number of entries in the layer cache

Method Detail

contains

boolean contains(String key)

Returns true if the entry with the specified key is in the cache

Parameters:

key - the entry key

Returns:

true if the specified entry is in the cache

clear

void clear()

Remove all entries in the cache

size

int size()

Returns the number of entries in the layer cache

Returns:

the number of entries

getKeys

Set<String> getKeys()

Returns the set of keys associated with entries in the cache

Returns:

the key set

dump

void dump(Writer writer,
        Pattern filter)
          throws IOException

Output the cache info to the specified Writer

Parameters:

writer - the target Writer

filter - Optional filter argument

Throws:

IOException

setAggregator

void setAggregator(IAggregator aggregator)

Called for newly created (or de-serialized) caches to set the aggregator instance for this cache. Note that the aggregator may not be fully initialized at the time that this method is called and some aggregator methods (like IAggregator.getConfig() may return null if called from within this method.

Parameters:

aggregator - The aggregator instance for the cache

newInstance

IGenericCache newInstance()

Returns a new, empty, instance of this cache object. Used by the cache manager when clearing the aggregator cache.

Returns:

a new instance of this cache object