Package | Description |
---|---|
org.apache.jcs |
Contains the class JCS which provides a simple interface for clients to use
JCS.
|
org.apache.jcs.access |
Contains classes for accessing the cache.
|
org.apache.jcs.access.behavior | |
org.apache.jcs.access.exception | |
org.apache.jcs.engine.control |
The primary cache classes and the hub.
|
Modifier and Type | Method and Description |
---|---|
static JCS |
JCS.getInstance(java.lang.String region)
Get a JCS which accesses the provided region.
|
static JCS |
JCS.getInstance(java.lang.String region,
ICompositeCacheAttributes icca)
Get a JCS which accesses the provided region.
|
Modifier and Type | Method and Description |
---|---|
void |
CacheAccess.clear()
Removes all of the elements from a region.
|
static CacheAccess |
CacheAccess.defineRegion(java.lang.String name)
Define a new cache region with the given name.
|
static CacheAccess |
CacheAccess.defineRegion(java.lang.String name,
ICompositeCacheAttributes cattr)
Define a new cache region with the specified name and attributes.
|
static CacheAccess |
CacheAccess.defineRegion(java.lang.String name,
ICompositeCacheAttributes cattr,
IElementAttributes attr)
Define a new cache region with the specified name and attributes and return a CacheAccess to
it.
|
void |
CacheAccess.destroy()
Deprecated.
|
void |
CacheAccess.destroy(java.lang.Object name)
Deprecated.
use remove
|
int |
CacheAccess.freeMemoryElements(int numberToFree)
This instructs the memory cache to remove the numberToFree according to its eviction
policy.
|
static CacheAccess |
CacheAccess.getAccess(java.lang.String region)
Get a CacheAccess instance for the given region.
|
static CacheAccess |
CacheAccess.getAccess(java.lang.String region,
ICompositeCacheAttributes icca)
Get a CacheAccess instance for the given region with the given attributes.
|
IElementAttributes |
CacheAccess.getDefaultElementAttributes()
Retrieves A COPY OF the default element attributes used by this region.
|
IElementAttributes |
CacheAccess.getElementAttributes()
Deprecated.
As of release 1.3
|
IElementAttributes |
CacheAccess.getElementAttributes(java.lang.Object name)
GetElementAttributes will return an attribute object describing the current attributes
associated with the object name.
|
static GroupCacheAccess |
GroupCacheAccess.getGroupAccess(java.lang.String region)
Gets the groupAccess attribute of the GroupCacheAccess class.
|
static GroupCacheAccess |
GroupCacheAccess.getGroupAccess(java.lang.String region,
ICompositeCacheAttributes icca)
Gets the groupAccess attribute of the GroupCacheAccess class.
|
void |
CacheAccess.put(java.lang.Object name,
java.lang.Object obj)
Place a new object in the cache, associated with key name.
|
void |
CacheAccess.put(java.lang.Object key,
java.lang.Object val,
IElementAttributes attr)
Constructs a cache element with these attributes, and puts it into the cache.
|
void |
GroupCacheAccess.putInGroup(java.lang.Object name,
java.lang.String groupName,
java.lang.Object value)
Allows the user to put an object into a group within a particular cache
region.
|
void |
GroupCacheAccess.putInGroup(java.lang.Object name,
java.lang.String groupName,
java.lang.Object value,
IElementAttributes attr)
Allows the user to put an object into a group within a particular cache
region.
|
void |
CacheAccess.putSafe(java.lang.Object key,
java.lang.Object value)
Place a new object in the cache, associated with key name.
|
void |
CacheAccess.remove()
Deprecated.
use clear()
|
void |
CacheAccess.remove(java.lang.Object name)
Removes a single item by name.
|
void |
CacheAccess.resetElementAttributes(IElementAttributes attr)
Deprecated.
As of release 1.3
|
void |
CacheAccess.resetElementAttributes(java.lang.Object name,
IElementAttributes attr)
Reset attributes for a particular element in the cache.
|
void |
CacheAccess.setDefaultElementAttributes(IElementAttributes attr)
This method is does not reset the attributes for items already in the cache.
|
Modifier and Type | Method and Description |
---|---|
void |
ICacheAccess.destroy()
Deprecated.
|
void |
ICacheAccess.destroy(java.lang.Object name)
Deprecated.
|
int |
ICacheAccess.freeMemoryElements(int numberToFree)
This instructs the memory cache to remove the numberToFree
according to its eviction policy.
|
IElementAttributes |
ICacheAccess.getElementAttributes()
GetElementAttributes will return an attribute object describing the
current attributes associated with the object name.
|
IElementAttributes |
ICacheAccess.getElementAttributes(java.lang.Object name)
Gets the elementAttributes attribute of the ICacheAccess object
|
void |
ICacheAccess.put(java.lang.Object name,
java.lang.Object obj)
Puts and/or overides an element with the name in that region.
|
void |
ICacheAccess.put(java.lang.Object name,
java.lang.Object obj,
IElementAttributes attr)
Description of the Method
|
void |
IGroupCacheAccess.putInGroup(java.lang.Object key,
java.lang.String group,
java.lang.Object obj)
Puts an item int eh cache associated with this group.
|
void |
IGroupCacheAccess.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 |
ICacheAccess.putSafe(java.lang.Object name,
java.lang.Object obj)
Puts in cache if an item does not exist with the name in that region.
|
void |
ICacheAccess.remove()
Old remove all method.
|
void |
ICacheAccess.remove(java.lang.Object name)
Remove an object for this key if one exists, else do nothing.
|
void |
ICacheAccess.resetElementAttributes(IElementAttributes attributes)
ResetAttributes allows for some of the attributes of a region to be reset
in particular expiration time attriubtes, time to live, default time to
live and idle time, and event handlers.
|
void |
ICacheAccess.resetElementAttributes(java.lang.Object name,
IElementAttributes attributes)
Reset the attributes on the object matching this key name.
|
Modifier and Type | Class and Description |
---|---|
class |
InvalidArgumentException
InvalidArgumentException is thrown if an argument is passed to the cache that is invalid.
|
class |
InvalidGroupException
InvalidGroupException
|
class |
InvalidHandleException
InvalidHandleException is not used.
|
class |
NotARetrievableObjectException
This would be thrown if the object could not be retrieved from a method that throws exceptions
rather than null.
|
class |
NullObjectException
Description of the Class
|
class |
ObjectExistsException
The putSafe method on the JCS convenience class throws this exception if the object is already
present in the cache.
|
class |
ObjectNotFoundException
ObjectNotFoundException
|
Modifier and Type | Method and Description |
---|---|
IElementAttributes |
CompositeCache.getElementAttributes(java.io.Serializable key)
Gets the elementAttributes attribute of the Cache object.
|
Copyright © 2002-2013 Apache Software Foundation. All Rights Reserved.