com.ibm.jaggr.core.layer

Interface ILayerCache

All Superinterfaces:

IGenericCache, Serializable

All Known Implementing Classes:

LayerCacheImpl

public interface ILayerCache
extends Serializable, IGenericCache

Interface for layer cache object

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Removes all layer objects in the cache
boolean	contains(String key) Returns true if the layer with the specified key is in the cache
void	dump(Writer writer, Pattern filter) Output the cache info to the specified Writer
ILayer	get(String key) Returns the layer with the specified key, or null if the layer with the specified key is not in the cache.
Set<String>	getKeys() Returns the set of keys associated with entries in the cache
ILayer	getLayer(javax.servlet.http.HttpServletRequest request) Returns a layer object for the specified request.
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

Methods inherited from interface com.ibm.jaggr.core.cache.IGenericCache

newInstance

Method Detail

getLayer

ILayer getLayer(javax.servlet.http.HttpServletRequest request)

Returns a layer object for the specified request. If a layer is already in the cache that can satisfy the request, it is returned. Otherwise, a new layer is created and added to the cache before returning it.

Parameters:

request - the request object

Returns:

the layer object

get

ILayer get(String key)

Returns the layer with the specified key, or null if the layer with the specified key is not in the cache. The cache key for the layer can be determined by calling ILayer.getKey()

Parameters:

key - the layer key

Returns:

the requested layer or null

contains

boolean contains(String key)

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

Specified by:

contains in interface IGenericCache

Parameters:

key - the layer key

Returns:

true if the specified layer is in the cache

clear

void clear()

Removes all layer objects in the cache

Specified by:

clear in interface IGenericCache

size

int size()

Returns the number of entries in the layer cache

Specified by:

size in interface IGenericCache

Returns:

the number of entries

getKeys

Set<String> getKeys()

Returns the set of keys associated with entries in the cache

Specified by:

getKeys in interface IGenericCache

Returns:

the key set

dump

void dump(Writer writer,
        Pattern filter)
          throws IOException

Output the cache info to the specified Writer

Specified by:

dump in interface IGenericCache

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.

Specified by:

setAggregator in interface IGenericCache

Parameters:

aggregator - The aggregator instance for the cache