Package org.apache.commons.jcs3.access.behavior

Interface IGroupCacheAccess<K,V>

All Superinterfaces:

ICacheAccessManagement

All Known Implementing Classes:

GroupCacheAccess

public interface IGroupCacheAccess<K,V>
extends ICacheAccessManagement

IGroupCacheAccess defines group specific behavior for the client access classes.

Method Summary

Modifier and Type	Method	Description
V	getFromGroup(K name, String group)	Gets the g attribute of the IGroupCacheAccess object
Set<K>	getGroupKeys(String group)	Gets the set of keys of objects currently in the group
void	invalidateGroup(String group)	Invalidates a group
void	putInGroup(K key, String group, V obj)	Puts an item in the cache associated with this group.
void	putInGroup(K key, String group, V obj, IElementAttributes attr)	Put in the cache associated with this group using these attributes.
void	removeFromGroup(K name, String group)	Remove the item from this group in this region by this name.

Methods inherited from interface org.apache.commons.jcs3.access.behavior.ICacheAccessManagement

clear, dispose, freeMemoryElements, getCacheAttributes, getDefaultElementAttributes, getStatistics, getStats, setCacheAttributes, setDefaultElementAttributes

Method Details

getFromGroup

V getFromGroup(K name,
 String group)

Gets the g attribute of the IGroupCacheAccess object

Parameters:

name -

group - the name of the group to associate this with.

Returns:

The object that is keyed by the name in the group

putInGroup

void putInGroup(K key,
 String group,
 V obj)
         throws CacheException

Puts an item in the cache associated with this group.

Parameters:

key -

group -

obj -

Throws:

CacheException

putInGroup

void putInGroup(K key,
 String group,
 V obj,
 IElementAttributes attr)
         throws CacheException

Put in the cache associated with this group using these attributes.

Parameters:

key -

group -

obj -

attr -

Throws:

CacheException

removeFromGroup

void removeFromGroup(K name,
 String group)

Remove the item from this group in this region by this name.

Parameters:

name -

group -

getGroupKeys

Set<K> getGroupKeys(String group)

Gets the set of keys of objects currently in the group

Parameters:

group -

Returns:

the set of group keys.

invalidateGroup

void invalidateGroup(String group)

Invalidates a group

Parameters:

group -