|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.gentics.api.lib.cache.PortalCache
public abstract class PortalCache
interface for various portal caches
Field Summary | |
---|---|
protected static boolean |
allowSetCacheClass
remember if the cacheClass has already been set to prevent re-initialisation |
protected static Class |
cacheClass
|
protected static Constructor |
cacheClassConstructor
|
protected static boolean |
disableCache
Defines if cache is disabled. |
protected String |
region
|
Constructor Summary | |
---|---|
PortalCache(String region)
create an instance for the given region |
Method Summary | |
---|---|
abstract void |
clear()
clears the whole cache |
abstract void |
clearGroup(String groupName)
clears the a group in the cache |
abstract Object |
get(Object key)
retrieve an object from the cache |
static PortalCache |
getCache(String region)
retrieve a PortalCache instance |
abstract PortalCacheAttributes |
getCacheAttributes(Object key)
get the cache attributes for a cached entry. |
abstract PortalCacheAttributes |
getCacheAttributes(String groupName,
Object key)
get the cache attributes for a cached entry in a group. |
abstract Object |
getFromGroup(String groupName,
Object key)
Retrieven an object from the group in the cache |
abstract void |
put(Object key,
Object object)
put an object into the cache |
abstract void |
put(Object key,
Object object,
PortalCacheAttributes attribs)
put an object into the cache, using some attributes to define caching methods. |
abstract void |
putIntoGroup(String groupName,
Object key,
Object object)
Put an object into a group of the cache |
abstract void |
putIntoGroup(String groupName,
Object key,
Object object,
PortalCacheAttributes attribs)
put an object into the a group in the cache, using some attributes to define caching methods. |
abstract void |
remove(Object key)
remove an object from the cache |
abstract void |
removeFromGroup(String groupName,
Object key)
remove an object from a group in the cache |
static void |
setCacheClass(String cacheClass)
sets the cache class to be used |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected static Constructor cacheClassConstructor
protected String region
protected static boolean disableCache
protected static Class cacheClass
protected static boolean allowSetCacheClass
Constructor Detail |
---|
public PortalCache(String region)
region
- cache regionMethod Detail |
---|
public static PortalCache getCache(String region) throws PortalCacheException
region
- cache region
PortalCacheException
public static void setCacheClass(String cacheClass) throws PortalCacheException
cacheClass
- to be used, null for default implementation
PortalCacheException
public abstract Object get(Object key) throws PortalCacheException
key
- of the object
PortalCacheException
public abstract Object getFromGroup(String groupName, Object key) throws PortalCacheException
groupName
- group namekey
- key of the object
PortalCacheException
public abstract void put(Object key, Object object) throws PortalCacheException
key
- of the objectobject
- to put inside the cache
PortalCacheException
public abstract void putIntoGroup(String groupName, Object key, Object object) throws PortalCacheException
groupName
- name of the groupkey
- key of the objectobject
- from the cache or null
PortalCacheException
public abstract void put(Object key, Object object, PortalCacheAttributes attribs) throws PortalCacheException
key
- the key of the entry.object
- the object to put inside the cache.attribs
- the cache element attributes for the object.
PortalCacheException
public abstract void putIntoGroup(String groupName, Object key, Object object, PortalCacheAttributes attribs) throws PortalCacheException
groupName
- group namekey
- the key of the entry.object
- the object to put inside the cache.attribs
- the cache element attributes for the object.
PortalCacheException
public abstract PortalCacheAttributes getCacheAttributes(Object key) throws PortalCacheException
key
- the key of the entry.
PortalCacheException
public abstract PortalCacheAttributes getCacheAttributes(String groupName, Object key) throws PortalCacheException
groupName
- group namekey
- the key of the entry.
PortalCacheException
public abstract void remove(Object key) throws PortalCacheException
key
- of object to be removed
PortalCacheException
public abstract void removeFromGroup(String groupName, Object key) throws PortalCacheException
groupName
- group namekey
- of object to be removed
PortalCacheException
public abstract void clear() throws PortalCacheException
PortalCacheException
public abstract void clearGroup(String groupName) throws PortalCacheException
groupName
- group name
PortalCacheException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |