org.apache.jcs.access.behavior

Interface IGroupCacheAccess

All Superinterfaces:

ICacheAccess

All Known Implementing Classes:

GroupCacheAccess, JCS

public interface IGroupCacheAccess
extends ICacheAccess

IGroupCacheAccess defines group specific behavior for the client access classes.

Method Summary

Methods

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

Methods inherited from interface org.apache.jcs.access.behavior.ICacheAccess

destroy, destroy, freeMemoryElements, get, getCacheAttributes, getCacheElement, getCacheElements, getElementAttributes, getElementAttributes, getMatching, getMatchingCacheElements, put, put, putSafe, remove, remove, resetElementAttributes, resetElementAttributes, setCacheAttributes

Method Detail

getFromGroup

java.lang.Object getFromGroup(java.lang.Object name,
                            java.lang.String group)

Gets the g attribute of the IGroupCacheAccess object

Parameters:

name -

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

Returns:

The teh object that is keyed by the name in the group

putInGroup

void putInGroup(java.lang.Object key,
              java.lang.String group,
              java.lang.Object obj)
                throws CacheException

Puts an item int eh cache associated with this group.

Parameters:

key -

group -

obj -

Throws:

CacheException

putInGroup

void putInGroup(java.lang.Object key,
              java.lang.String group,
              java.lang.Object obj,
              IElementAttributes attr)
                throws CacheException

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

Parameters:

key -

group -

obj -

attr -

Throws:

CacheException

remove

void remove(java.lang.Object name,
          java.lang.String group)

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

Parameters:

name -

group -

getGroupKeys

java.util.Set getGroupKeys(java.lang.String group)

Gets the set of keys of objects currently in the group

Parameters:

group -

Returns:

the set of group keys.

invalidateGroup

void invalidateGroup(java.lang.String group)

Invalidates a group

Parameters:

group -