com.opencms.flex.util
Interface I_CmsFlexLruCacheObject

All Known Implementing Classes:

CmsFlexCacheEntry

public interface I_CmsFlexLruCacheObject

Defines the methods which an object being cached by CmsFlexLruCache must implement.

CmsFlexLruCache is organized as a double linked list, that's why objects implementing this interface need getters/setter for the next/previous nodes in the list of all cached objects.

Version:

$Revision: 1.4 $

Author:

Thomas Weckert (t.weckert@alkacon.com)

See Also:

CmsFlexLruCache

Method Summary

void	addToLruCache() Invoked after an object was added to the cache.
int	getLruCacheCosts() Returns the cache costs of this object, as for example it's byte size.
I_CmsFlexLruCacheObject	getNextLruObject() Returns the next object in the double linked list of all cached objects.
I_CmsFlexLruCacheObject	getPreviousLruObject() Returns the previous object in the double linked list of all cached objects.
void	removeFromLruCache() Invoked after the object was removed to the cache.
void	setNextLruObject(I_CmsFlexLruCacheObject theNextObject) Set the next object in the double linked list of all cached objects.
void	setPreviousLruObject(I_CmsFlexLruCacheObject thePreviousObject) Set the previous object in the double linked list of all cached objects.

Method Detail

setNextLruObject

public void setNextLruObject(I_CmsFlexLruCacheObject theNextObject)

Set the next object in the double linked list of all cached objects.

Parameters:

theNextObject - the next object

getNextLruObject

public I_CmsFlexLruCacheObject getNextLruObject()

Returns the next object in the double linked list of all cached objects.

Returns:

the next object in the double linked list of all cached objects

setPreviousLruObject

public void setPreviousLruObject(I_CmsFlexLruCacheObject thePreviousObject)

Set the previous object in the double linked list of all cached objects.

Parameters:

thePreviousObject - the previous object

getPreviousLruObject

public I_CmsFlexLruCacheObject getPreviousLruObject()

Returns the previous object in the double linked list of all cached objects.

Returns:

the previous object in the double linked list of all cached objects

addToLruCache

public void addToLruCache()

Invoked after an object was added to the cache.

removeFromLruCache

public void removeFromLruCache()

Invoked after the object was removed to the cache.

getLruCacheCosts

public int getLruCacheCosts()

Returns the cache costs of this object, as for example it's byte size.

Returns:

the cache costs of this object